Remote Management backend (0.3.0)

Download OpenAPI specification:Download

Locations

Locations is a service that makes it easy to manage your locations

Get all locations

This API can be used to get all locations that you can view.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=id,desc The field and sort order

Responses

Response samples

200
400
401

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Save location

This API can be used to update an location.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

id required	string <uuid>
name	string or null [ 4 .. 40 ] characters
parentId	string or null <uuid>

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Create location

This API can be used to create a new location.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

name required	string [ 1 .. 50 ] characters
parentId required	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Get location

This API can be used to get an location that you can view.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
locationId required	string <uuid>

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Delete locations

This API can be used to remove an location and its sub-locations if there are no registered devices.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
locationId required	string <uuid>

Responses

Response samples

200
400
401
404

Content type

application/json

{ }

Device Actions

Device Actions API

Get device Actions

Get device Actions for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=createdAt,desc The field and sort order
locationId	Array of strings or null <uuid>
id	string or null <uuid>
displayName	string or null

Responses

Response samples

200
401
404

Content type

application/json

{"content": [{"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
"displayName": "string",
"description": "string",
"deviceIds": ["string"
],
"commandIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"data": {"command": "string",
"payload": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "PENDING",
"progress": {"total": 0,
"completed": 0,
"failed": 0,
"pending": 0
},
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Create device Action

Create a device Action for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

string

Request Body schema: application/json
required

displayName required	string
description required	string
deviceIds required	Array of strings
locationId required	string <uuid>
required	object (ActionRequest.ActionDataCommandRequest)

Responses

Request samples

Payload

Content type

application/json

{"displayName": "string",
"description": "string",
"deviceIds": ["string"
],
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"data": {"command": 0,
"payload": "string"
}
}

Response samples

200
401
404

Content type

application/json

{"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
"displayName": "string",
"description": "string",
"deviceIds": ["string"
],
"commandIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"data": {"command": "string",
"payload": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "PENDING",
"progress": {"total": 0,
"completed": 0,
"failed": 0,
"pending": 0
},
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
}

Get device Action

Get a device Action for an organization

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
actionId required	string <uuid>

Responses

Response samples

200
401
404

Content type

application/json

{"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
"displayName": "string",
"description": "string",
"deviceIds": ["string"
],
"commandIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"data": {"command": "string",
"payload": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "PENDING",
"progress": {"total": 0,
"completed": 0,
"failed": 0,
"pending": 0
},
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
}

Get device Action details

Get a device Action details for an organization

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
actionId required	string <uuid>

Responses

Response samples

200
401
404

Content type

application/json

{"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
"displayName": "string",
"description": "string",
"commands": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"command": "string",
"request": { },
"response": { },
"status": "PENDING",
"statusMessage": "string",
"device": {"id": "string",
"name": "string",
"enabled": true,
"provisioned": true,
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"properties": { },
"telemetries": { },
"status": "WAITING_FOR_APPROVAL",
"connection": {"connected": true,
"timestamp": "2019-08-24T14:15:22Z"
},
"parent": {"id": "string",
"name": "string"
}
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
],
"data": {"command": "string",
"payload": "string"
},
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "PENDING",
"progress": {"total": 0,
"completed": 0,
"failed": 0,
"pending": 0
},
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}

Devices

Devices is a service that makes it easy to manage your devices

Get devices

This API allow you to retrieve all the devices you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=createdAt,desc The field and sort order
id	string or null
name	string or null
locationId	Array of strings or null <uuid>
deviceType	string or null Enum: "iotEdge" "iotDevice" "host"
deviceCategoryId	Array of integers or null <int64>
connection	boolean or null
status	Array of strings or null (DeviceStatus) Enum: "WAITING_FOR_APPROVAL" "REGISTERED" "BLOCKED" "PROVISIONED"
parentIds	Array of strings or null
parentName	string or null

Responses

Response samples

200
400
401

Content type

application/json

{"content": [{"id": "string",
"name": "string",
"enabled": true,
"provisioned": true,
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"properties": { },
"telemetries": { },
"status": "WAITING_FOR_APPROVAL",
"connection": {"connected": true,
"timestamp": "2019-08-24T14:15:22Z"
},
"parent": {"id": "string",
"name": "string"
}
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Update device

This API can be used to add one device.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

id required	string <= 50 characters
name	string or null <= 50 characters
locationId	string or null <uuid>
deviceCategoryId	integer or null <int64>
enabled	boolean or null
parentId	string or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceCategoryId": 0,
"enabled": true,
"parentId": "string"
}

Response samples

200
400
401

Content type

application/json

{"id": "string",
"name": "string",
"enabled": true,
"provisioned": true,
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"properties": { },
"telemetries": { },
"status": "WAITING_FOR_APPROVAL",
"connection": {"connected": true,
"timestamp": "2019-08-24T14:15:22Z"
},
"parent": {"id": "string",
"name": "string"
}
}

Add device

This API can be used to update one device.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

id required	string [ 1 .. 50 ] characters
name required	string [ 1 .. 50 ] characters
locationId required	string <uuid>
deviceType required	string (DeviceType) Enum: "iotEdge" "iotDevice" "host"
deviceCategoryId required	integer <int64>
enabled required	boolean
parentId	string or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"enabled": true,
"parentId": "string"
}

Response samples

200
400
401

Content type

application/json

{"id": "string",
"name": "string",
"enabled": true,
"provisioned": true,
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"properties": { },
"telemetries": { },
"status": "WAITING_FOR_APPROVAL",
"connection": {"connected": true,
"timestamp": "2019-08-24T14:15:22Z"
},
"parent": {"id": "string",
"name": "string"
}
}

Delete devices

This API allow you to delete devices if you have the permission.

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200

Content type

application/json

{"failedDevices": {"property1": "string",
"property2": "string"
}
}

Get device

This API allow you to retrieve a devices you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"name": "string",
"enabled": true,
"provisioned": true,
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"properties": { },
"telemetries": { },
"status": "WAITING_FOR_APPROVAL",
"connection": {"connected": true,
"timestamp": "2019-08-24T14:15:22Z"
},
"parent": {"id": "string",
"name": "string"
}
}

Delete device

This API allow you to delete one device if you have the permission.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

Responses

Response samples

200
400
401
404

Content type

application/json

{ }

Get device's children

This API allow you to retrieve all the device's children you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=createdAt,desc The field and sort order
id	string or null
name	string or null
locationId	Array of strings or null <uuid>
deviceType	string or null Enum: "iotEdge" "iotDevice" "host"
deviceCategoryId	Array of integers or null <int64>
connection	boolean or null
status	Array of strings or null (DeviceStatus) Enum: "WAITING_FOR_APPROVAL" "REGISTERED" "BLOCKED" "PROVISIONED"

Responses

Response samples

200
400
401

Content type

application/json

{"content": [{"id": "string",
"name": "string",
"enabled": true,
"provisioned": true,
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"deviceType": "iotEdge",
"deviceCategoryId": 0,
"properties": { },
"telemetries": { },
"status": "WAITING_FOR_APPROVAL",
"connection": {"connected": true,
"timestamp": "2019-08-24T14:15:22Z"
},
"parent": {"id": "string",
"name": "string"
}
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Get commands

This API allow you to retrieve all the commands you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=createdAt,desc The field and sort order
status	string or null Enum: "PENDING" "STARTED" "IN_PROGRESS" "COMPLETED" "FAILED"
commandName	string or null

Responses

Response samples

200
400
401

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"command": "string",
"request": { },
"response": { },
"status": "PENDING",
"statusMessage": "string",
"deviceId": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0"
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Get command

This API allow you to retrieve one command you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string
commandId required	string <uuid>

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"command": "string",
"request": { },
"response": { },
"status": "PENDING",
"statusMessage": "string",
"deviceId": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0"
}

Execute command

This API allow you to execute one command on one device (some fields can be null).

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string
commandName required	string

Request Body schema: application/json
required

payload

any or null

Responses

Request samples

Payload

Content type

application/json

{"payload": null
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"command": "string",
"request": { },
"response": { },
"status": "PENDING",
"statusMessage": "string",
"deviceId": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0"
}

Credentials

This API allows you to get all the credentials of a device.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

Responses

Response samples

200
400
401
404

Content type

application/json

{"scope": "string",
"primaryKey": "string",
"secondaryKey": "string"
}

Properties

This API allows you to get all the properties of a device.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

Responses

Response samples

200
400
401
404

Content type

application/json

{ }

Telemetry names

This API allows you to get all the telemetry names of a device.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceId required	string

Responses

Response samples

200
400
401
404

Content type

application/json

{ }

Device Categories

Device Categories API

Get device Categories

Get device Categories for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"deviceTemplateId": 0,
"parentId": 0,
"image": "string"
}
]

Get total and online devices by category

Get total and online devices by category for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"parentId": 0,
"templateId": 0,
"totalDevices": 0,
"connectedDevices": 0,
"image": "string"
}
]

Get device category

Get a device category for an organization

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
categoryId required	integer <int64> The category identifier

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"deviceTemplateId": 0,
"parentId": 0,
"image": "string"
}

Users

Users is a service that makes it easy to manage your users

get all users

This API allows you to get all users

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=id,desc The field and sort order
username	string or null
mail	string or null
locationId	Array of strings or null <uuid>
roles	Array of strings or null

Responses

Response samples

200
400
401

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"mail": "string",
"profile": { },
"preferences": { },
"roles": [{"role": "admin",
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Update user

This API allows you to update users. If the mail or the id is already present in the system, the user will be updated

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

The user to update

id	string or null <uuid>
username	string or null [ 4 .. 40 ] characters
mail	string or null <email>
	object or null
	object or null
	object or null

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"mail": "user@example.com",
"profile": { },
"preferences": { },
"role": {"role": "admin",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
}
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"mail": "string",
"profile": { },
"preferences": { },
"roles": [{"role": "admin",
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Create user

This API allows you to create a user

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Request Body schema: application/json
required

The user to create

username required	string [ 4 .. 40 ] characters
mail required	string <email>
required	object (RoleRequest)
required	object
required	object

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"mail": "user@example.com",
"role": {"role": "admin",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
},
"profile": { },
"preferences": { }
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"mail": "string",
"profile": { },
"preferences": { },
"roles": [{"role": "admin",
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get user by id

This API allow you to find the users, the API tries to find a match for the string passed by checking the name or mailing address on the system.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
id required	string <uuid> Example: 7fd28f13-7dab-4a1d-9266-cbc82cafa4eb

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"mail": "string",
"profile": { },
"preferences": { },
"roles": [{"role": "admin",
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete user

This API allow you to delete one user if you have the permission.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: ee125af1-7446-4cf1-9e3a-d75c16a74ba6 The organization id
userId required	string <uuid>

Responses

Response samples

200
400
401
404

Content type

application/json

{ }

Device Templates

Device Templates API

Get device Templates

Get device Templates for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"deviceCommands": [{"id": 0,
"name": "string"
}
]
}
]

Get device template

Get a device template for an organization

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
templateId required	integer <int64>

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"deviceCommands": [{"id": 0,
"name": "string"
}
]
}

Organizations

Organizations is a service that makes it easy to manage your organizations

getOrganization

Authorizations:

bearerAuth

path Parameters

organizationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"enrollment": { }
}

Rma

Rma API

Get Rma Schema

Get Rma Schema for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters

page	any Example: page=0 The page number
size	any Example: size=10 The page size
sort	any Example: sort=createdAt,desc The field and sort order
number	string or null
creationDate	string or null
customerName	string or null
workCenter	string or null
workCenterCode	string or null
purchaseOrderNumber	string or null
receivedDate	string or null
estimatedRepairDate	string or null
repairDate	string or null
store	string or null
notificationStatus	string or null
serialNumber	string or null
problemCode	string or null

Responses

Response samples

200
401
404

Content type

application/json

{"content": [{"number": "string",
"creationDate": "string",
"customerName": "string",
"workCenter": "string",
"workCenterCode": "string",
"purchaseOrderNumber": "string",
"receivedDate": "string",
"estimatedRepairDate": "string",
"repairDate": "string",
"notificationNumber": "string",
"problemDescription": "string",
"additionalNote": "string",
"store": "string",
"notificationStatus": "string",
"shipment": {"shippingDate": "string",
"addressOfShipToParty": "string",
"shippingType": "string",
"shipToParty": "string"
},
"items": [{"serialNumber": "string",
"problemCode": "string",
"problemCode2": "string",
"problemCodeDescription": "string",
"materialNumber": "string",
"materialDescription": "string",
"customerMaterialDescription": "string"
}
]
}
],
"pageable": {"number": 0,
"size": 0,
"mode": "CURSOR_NEXT",
"sort": {"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"orderBy": [{"ignoreCase": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
},
"pageNumber": 0,
"offset": 0,
"size": 0,
"empty": true,
"numberOfElements": 0,
"totalSize": 0,
"totalPages": 0
}

Remote Management backend (0.3.0)

Locations

Get all locations

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Save location

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create location

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get location

Authorizations:

path Parameters

Responses

Response samples

Delete locations

Authorizations:

path Parameters

Responses

Response samples

Device Actions

Get device Actions

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create device Action

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get device Action

Authorizations:

path Parameters

Responses

Response samples

Get device Action details

Authorizations:

path Parameters

Responses

Response samples

Devices

Get devices

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update device

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add device

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete devices

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required