Datalogic Connect (0.11.1)

Download OpenAPI specification:Download

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": { },
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
}
}

Get Organization Counters

Get counters for an organization

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

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

The organization id

Responses

Response samples

200
401
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"commandCount": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}

Licenses

Licenses is a service that makes it easy to manage your licenses

Get all licenses

This API can be used to retrieve all licenses for the specified 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=created,desc The field and sort order
ids	Array of strings or null <uuid> Optional list of license UUIDs to filter.
name	string or null Optional license name to filter.

Responses

Response samples

200
401

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"name": "string",
"licenseKey": "string",
"expiry": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"maxMachines": 0,
"lastValidated": "2019-08-24T14:15:22Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"requireCheckIn": true,
"lastCheckIn": "2019-08-24T14:15:22Z",
"nextCheckIn": "2019-08-24T14:15:22Z",
"metadata": { },
"organization": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"enrollment": { },
"tokens": {"data": [{"key": "string",
"value": "string"
}
],
"iotSasToken": "string"
},
"iotOrgId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"licenseProductType": {"licenseProductType": "string",
"deviceCategory": {"id": 0,
"name": "string",
"enabled": true,
"deviceTemplate": {"id": 0,
"name": "string",
"deviceCommands": [{"id": 0,
"name": "string",
"licenseTag": "BASIC"
}
],
"deviceCommandsFromTemplateTree": [{"id": 0,
"name": "string",
"licenseTag": "BASIC"
}
]
},
"image": "string",
"deviceType": "iotEdge"
}
}
}
],
"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 a license

This API can be used to retrieve a specific license by its key.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
licenseKey required	string The key of the license.

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"name": "string",
"licenseKey": "string",
"expiry": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"maxMachines": 0,
"lastValidated": "2019-08-24T14:15:22Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"requireCheckIn": true,
"lastCheckIn": "2019-08-24T14:15:22Z",
"nextCheckIn": "2019-08-24T14:15:22Z",
"metadata": { },
"organization": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"enrollment": { },
"tokens": {"data": [{"key": "string",
"value": "string"
}
],
"iotSasToken": "string"
},
"iotOrgId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"licenseProductType": {"licenseProductType": "string",
"deviceCategory": {"id": 0,
"name": "string",
"enabled": true,
"deviceTemplate": {"id": 0,
"name": "string",
"deviceCommands": [{"id": 0,
"name": "string",
"licenseTag": "BASIC"
}
],
"deviceCommandsFromTemplateTree": [{"id": 0,
"name": "string",
"licenseTag": "BASIC"
}
]
},
"image": "string",
"deviceType": "iotEdge"
}
}
}

Assign a license to a device

This API can be used to assign a license to a device.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
licenseKey required	string The key of the license.
deviceId required	string The ID of the device.

Responses

Response samples

200
400
404

Content type

application/json

{ }

Deactivate a license from a device

This API can be used to deactivate a license from a device.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
licenseKey required	string The key of the license.
deviceId required	string The ID of the device.

Responses

Response samples

200
400
404

Content type

application/json

{ }

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 .. 50 ] 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 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",
"licenseTag": "BASIC"
}
]
}
]

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",
"licenseTag": "BASIC"
}
]
}

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>
name	string or null

Responses

Response samples

200
401
404

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"deviceIds": ["string"
],
"deviceGroup": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"commandIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"data": {"command": {"id": 0,
"name": "string"
},
"payload": "string",
"files": ["string"
]
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "PENDING",
"progress": {"total": 0,
"created": 0,
"completed": 0,
"failed": 0,
"pending": 0,
"inProgress": 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

any

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

The organization id

Request Body schema: application/json
required

name required	string
description required	string
deviceGroupId required	string <uuid>
required	object (ActionRequest.ActionDataCommandRequest)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"deviceGroupId": "47103c21-a78d-4990-a233-7f9ad2536254",
"data": {"command": 0,
"payload": "string",
"files": ["string"
]
}
}

Response samples

200
401
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"deviceIds": ["string"
],
"deviceGroup": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"commandIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"data": {"command": {"id": 0,
"name": "string"
},
"payload": "string",
"files": ["string"
]
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "PENDING",
"progress": {"total": 0,
"created": 0,
"completed": 0,
"failed": 0,
"pending": 0,
"inProgress": 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

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"deviceGroup": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"data": {"command": {"id": 0,
"name": "string"
},
"payload": "string",
"files": ["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,
"created": 0,
"completed": 0,
"failed": 0,
"pending": 0,
"inProgress": 0
},
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}

Get device Action commands

Get all commands related to 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>

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

Responses

Response samples

200
401
404

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"command": "string",
"request": { },
"response": { },
"status": "CREATED",
"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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "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
}

Device Groups

Device Groups is a service that makes it easy to manage your groups of devices.

Get all device groups

This API can be used to retrieve all device groups.

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
ids	Array of strings or null <uuid> Optional filter by device group ID.
name	string or null Optional filter by device group name.
description	string or null
locationIds	Array of strings or null <uuid>

Responses

Response samples

200
401

Content type

application/json

{"content": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"query": [{"field": "DEVICE_ID",
"operator": "EQUALS",
"value": null
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"categoryId": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "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
}

Create device group

This API can be used to create a new device group.

Required fields

locationId
categoryId

Available Fields and Operators in `query` parameter

deviceId

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

deviceName

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

parentName

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

locationId

Type: Array of UUIDs
Operators: IN, NOT_IN

categoryId

Type: Array of integers
Operators: IN, NOT_IN

deviceType

Type: Array of strings
Operators: IN, NOT_IN
Valid values: iotEdge, iotDevice, host

creationDate

Type: Array of dates [from, to] (ISO 8601 format)
Operators: BETWEEN
Note: You can specify only one date (from or to) by setting the other to null. If only one date is provided, it will be considered as the "from" date.

connection

Type: Boolean
Operators: EQUALS

status

Type: Array of strings
Operators: IN, NOT_IN
Valid values: WAITING_FOR_APPROVAL, REGISTERED, BLOCKED, PROVISIONED

Authorizations:

bearerAuth

path Parameters

organizationId

required

any

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

The organization id

Request Body schema: application/json
required

The request body containing name, description, and query filters.

name	string or null
description	string or null
required	Array of objects (DeviceGroupFilter)
locationId required	string <uuid>
categoryId required	integer <int64>

Responses

Request samples

Payload

Content type

application/json

Example

Simple device group with location and type filters

{"name": "IoT Devices in Location A",
"description": "All IoT devices in location A",
"locationId": "54519926-4bf6-b691-86af-5e7173cde7e6",
"categoryId": 192,
"query": [{"field": "locationId",
"operator": "IN",
"value": ["54519926-4bf6-b691-86af-5e7173cde7e6"
]
},
{"field": "deviceType",
"operator": "IN",
"value": ["iotDevice"
]
}
]
}

Response samples

200
400
401
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"query": [{"field": "DEVICE_ID",
"operator": "EQUALS",
"value": null
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"categoryId": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
}
}

Preview devices matching filters

This API can be used to preview which devices would be part of a device group based on filters.

Required fields

locationId
categoryId

Available Fields and Operators in `query` parameter

deviceId

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

deviceName

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

parentName

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

locationId

Type: Array of UUIDs
Operators: IN, NOT_IN

categoryId

Type: Array of integers
Operators: IN, NOT_IN

deviceType

Type: Array of strings
Operators: IN, NOT_IN
Valid values: iotEdge, iotDevice, host

creationDate

Type: Array of dates [from, to] (ISO 8601 format)
Operators: BETWEEN
Note: You can specify only one date (from or to) by setting the other to null. If only one date is provided, it will be considered as the "from" date.

connection

Type: Boolean
Operators: EQUALS

status

Type: Array of strings
Operators: IN, NOT_IN
Valid values: WAITING_FOR_APPROVAL, REGISTERED, BLOCKED, PROVISIONED

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
id	string or null
name	string or null

Request Body schema: application/json
required

The list of filters to apply.

locationId	string or null <uuid>
categoryId	integer or null <int64>
required	Array of objects (DeviceGroupFilter)

Responses

Request samples

Payload

Content type

application/json

{"locationId": "54519926-4bf6-b691-86af-5e7173cde7e6",
"categoryId": 192,
"query": [{"field": "locationId",
"operator": "IN",
"value": ["id1",
"id2",
"id3"
]
},
{"field": "categoryId",
"operator": "NOT_IN",
"value": [85,
189,
190
]
},
{"field": "creationDate",
"operator": "BETWEEN",
"value": ["2023-01-01",
"2023-12-31"
]
},
{"field": "deviceId",
"operator": "CONTAINS",
"value": ["id1",
"id2",
"id3"
]
},
{"field": "deviceName",
"operator": "EQUALS",
"value": ["device1",
"device2"
]
},
{"field": "deviceType",
"operator": "NOT_IN",
"value": ["type1",
"type2"
]
},
{"field": "connection",
"operator": "EQUALS",
"value": false
},
{"field": "status",
"operator": "IN",
"value": ["status1",
"status2"
]
},
{"field": "parentName",
"operator": "NOT_EQUALS",
"value": ["parent1",
"parent2"
]
}
]
}

Response samples

200
400

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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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 device group by ID

Returns a specific device group by its ID.

Authorizations:

bearerAuth

path Parameters

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

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"query": [{"field": "DEVICE_ID",
"operator": "EQUALS",
"value": null
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"categoryId": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
}
}

Update device group

This API can be used to update an existing device group.

Available Fields and Operators in `query` parameter

deviceId

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

deviceName

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

parentName

Type: Array of strings
Operators: EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS

locationId

Type: Array of UUIDs
Operators: IN, NOT_IN

categoryId

Type: Array of integers
Operators: IN, NOT_IN

deviceType

Type: Array of strings
Operators: IN, NOT_IN
Valid values: iotEdge, iotDevice, host

creationDate

Type: Array of dates [from, to] (ISO 8601 format)
Operators: BETWEEN
Note: You can specify only one date (from or to) by setting the other to null. If only one date is provided, it will be considered as the "from" date.

connection

Type: Boolean
Operators: EQUALS

status

Type: Array of strings
Operators: IN, NOT_IN
Valid values: WAITING_FOR_APPROVAL, REGISTERED, BLOCKED, PROVISIONED

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceGroupId required	string <uuid> The ID of the device group to update.

Request Body schema: application/json
required

The request body with the fields to update.

name	string or null
description	string or null
required	Array of objects (DeviceGroupFilter)
locationId	string or null <uuid>
categoryId	integer or null <int64>

Responses

Request samples

Payload

Content type

application/json

{"name": "Group A",
"description": "Device group for location X",
"locationId": "54519926-4bf6-b691-86af-5e7173cde7e6",
"categoryId": 192,
"query": [{"field": "locationId",
"operator": "IN",
"value": ["id1",
"id2",
"id3"
]
},
{"field": "categoryId",
"operator": "NOT_IN",
"value": [85,
189,
190
]
},
{"field": "creationDate",
"operator": "BETWEEN",
"value": ["2023-01-01",
"2023-12-31"
]
},
{"field": "deviceId",
"operator": "CONTAINS",
"value": ["id1",
"id2",
"id3"
]
},
{"field": "deviceName",
"operator": "EQUALS",
"value": ["device1",
"device2"
]
},
{"field": "deviceType",
"operator": "NOT_IN",
"value": ["type1",
"type2"
]
},
{"field": "connection",
"operator": "EQUALS",
"value": false
},
{"field": "status",
"operator": "IN",
"value": ["status1",
"status2"
]
},
{"field": "parentName",
"operator": "NOT_EQUALS",
"value": ["parent1",
"parent2"
]
}
]
}

Response samples

200
400
401
404
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"query": [{"field": "DEVICE_ID",
"operator": "EQUALS",
"value": null
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"categoryId": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
}
}

Delete device group

This API can be used to delete a device group by ID.

Authorizations:

bearerAuth

path Parameters

organizationId required	any Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198 The organization id
deviceGroupId required	string <uuid> The ID of the device group to delete.

Responses

Response samples

200
404

Content type

application/json

{ }

Get device group detail

Returns the list of devices that belong to the group based on the stored query.

Authorizations:

bearerAuth

path Parameters

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

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
404

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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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
}

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",
"name": "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>
name	string or null [ 4 .. 50 ] characters
mail	string or null <email>
	object or null

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "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

name required	string [ 4 .. 50 ] characters
mail required	string <email>
required	object (RoleRequest)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "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",
"name": "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

{ }

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
licenseProductType	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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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
licenseKey	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",
"licenseKey": "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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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 ^[a-zA-Z0-9.:\-_]+$
name required	string [ 1 .. 50 ] characters
locationId required	string <uuid>
deviceCategoryId required	integer <int64>
enabled required	boolean
parentId	string or null
licenseKey	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",
"licenseKey": "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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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"
},
"lastKnownConfig": {"id": "string",
"name": "string"
},
"license": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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: "CREATED" "PENDING" "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": "CREATED",
"commandStatusCode": "string",
"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"
},
"action": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string"
},
"attachments": [{"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 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": "CREATED",
"commandStatusCode": "string",
"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"
},
"action": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string"
},
"attachments": [{"id": "string",
"name": "string"
}
]
}

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
files	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

Example

Command with String payload

{"payload": "Any string payload"
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"command": "string",
"request": { },
"response": { },
"status": "CREATED",
"commandStatusCode": "string",
"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"
},
"action": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string"
},
"attachments": [{"id": "string",
"name": "string"
}
]
}

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",
"deviceType": "iotEdge"
}
]

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",
"deviceType": "iotEdge"
}

Storage

Storage is a service that makes it easy to manage files on Azure storage

Get files

This API allow you to retrieve all the filtered files if 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
name	string or null
id	Array of strings or null
description	string or null
filePath	string or null
dataType	Array of strings or null (DeviceConfigType) Enum: "SCAN2DEPLOY" "ALADDIN" "JSON" "UNKNOWN"
owner	string or null
categoryIds	Array of integers or null <int64>
sizeStart	integer or null <int64>
sizeEnd	integer or null <int64>
createdAtStart	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
createdAtEnd	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
updatedAtStart	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
updatedAtEnd	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd

Responses

Response samples

200
400

Content type

application/json

{"content": [{"id": "string",
"name": "string",
"description": "string",
"filepath": "string",
"dataType": "SCAN2DEPLOY",
"size": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"categoryId": 0,
"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
}

Get file types

This API allow you to retrieve a file types if you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId

required

string <uuid>

Responses

Response samples

200
404

Content type

application/json

{"totalFiles": 0,
"deviceTypes": ["SCAN2DEPLOY"
]
}

Upload a file

This API can be used to upload a file on Azure.

Authorizations:

bearerAuth

path Parameters

organizationId

required

string <uuid>

Request Body schema: multipart/form-data
required

id	string or null
name	string or null
description	string or null
categoryId	integer or null <int64>
file required	string <binary>

Responses

Response samples

200
413
500

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"filepath": "string",
"dataType": "SCAN2DEPLOY",
"size": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"categoryId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get file

This API allow you to retrieve a file if you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId required	string <uuid>
id required	string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"filepath": "string",
"dataType": "SCAN2DEPLOY",
"size": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"categoryId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update file

This API allow you to update a file if you are allowed.

Authorizations:

bearerAuth

path Parameters

organizationId required	string <uuid>
id required	string

Request Body schema: application/json
required

name	string or null
description	string or null
categoryId	integer or null <int64>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"categoryId": 0
}

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"filepath": "string",
"dataType": "SCAN2DEPLOY",
"size": 0,
"owner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mail": "string"
},
"categoryId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete file

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

Authorizations:

bearerAuth

path Parameters

id required	string
organizationId required	string <uuid>

Responses

Response samples

200
403
404
500

Content type

application/json

{ }

Get download link for file

This API allow you to retrieve a download link for file if you are allowed to see.

Authorizations:

bearerAuth

path Parameters

organizationId required	string <uuid>
id required	string

query Parameters

expirationMinutes

required

integer <int64>

Responses

Response samples

200
404

Content type

application/json

{"link": "string",
"expire": "2019-08-24T14:15:22Z"
}

Misc

Misc APIs

get the user information, including the organization and roles

This endpoint retrieves the user information, including the organization and roles.

Authorizations:

bearerAuth

Responses

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"mail": "string",
"profile": { },
"preferences": { },
"organizations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"roles": [{"role": "admin",
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}
]
}
]
}

update the user information

This endpoint update the user information.

Authorizations:

bearerAuth

Request Body schema: application/json
required

name	string or null [ 4 .. 50 ] characters
	object or null
	object or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"profile": { },
"preferences": { }
}

Response samples

200
400
401

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"mail": "string",
"profile": { },
"preferences": { },
"organizations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"roles": [{"role": "admin",
"location": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}
}
]
}
]
}

longOperation

Authorizations:

bearerAuth

path Parameters

duration

required

integer <int64>

Duration in ms

Responses

Response samples

200

Content type

application/json

"string"

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=creationDate,desc The field and sort order
number	string or null
creationDateStart	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
creationDateEnd	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
customerName	string or null
workCenter	string or null
workCenterCode	string or null
purchaseOrderNumber	string or null
receivedDateStart	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
receivedDateEnd	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
estimatedRepairDateStart	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
estimatedRepairDateEnd	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
store	string or null
shippingDateStart	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
shippingDateEnd	string or null\d{4}-\d{2}-\d{2} yyyy-MM-dd
shippingType	string or null
serialNumber	string or null
problemCode	string or null
materialNumber	string or null

Responses

Response samples

200
401
404

Content type

application/json

{"content": [{"number": "string",
"creationDate": "2019-08-24T14:15:22Z",
"customerName": "string",
"purchaseOrderNumber": "string",
"store": "string",
"shipment": {"addressOfShipToParty": "string",
"shippingType": "string",
"shipToParty": "string"
},
"formReportAvailable": true,
"shippingLabelAvailable": true,
"items": [{"serialNumber": "string",
"problemCode": "string",
"problemCode2": "string",
"problemCodeDescription": "string",
"materialNumber": "string",
"materialDescription": "string",
"customerMaterialDescription": "string",
"workCenter": "string",
"workCenterCode": "string",
"status": "I",
"trackingNumber": "string",
"shipDate": "2019-08-24T14:15:22Z",
"receivedDate": "2019-08-24T14:15:22Z",
"estimatedRepairDate": "2019-08-24T14:15:22Z",
"problemDescription": "string",
"additionalNote": "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
}

Download Form Report

Download the Form Report PDF file for the specified RMA number

Authorizations:

bearerAuth

path Parameters

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

Responses

Response samples

404
500

Content type

application/json

{"name": "string",
"message": "string",
"requestId": "string",
"time": "2019-08-24T14:15:22Z",
"errors": [{ }
]
}

Download Shipping Label

Download the Shipping Label PDF file for the specified RMA number

Authorizations:

bearerAuth

path Parameters

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

Responses

Response samples

404
500

Content type

application/json

{"name": "string",
"message": "string",
"requestId": "string",
"time": "2019-08-24T14:15:22Z",
"errors": [{ }
]
}

Get Rma Product

Get Rma Product for an organization

Authorizations:

bearerAuth

path Parameters

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

Responses

Response samples

200
401
404

Content type

application/json

"string"

Get Rma Form

Get Rma Form for an organization

Authorizations:

bearerAuth

path Parameters

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

Responses

Response samples

200
401
404

Content type

application/json

"string"

Get Rma Form

Get Rma Form for an organization

Authorizations:

bearerAuth

path Parameters

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

Responses

Response samples

200
401
404

Content type

application/json

"string"

Datalogic Connect (0.11.1)

Organizations

getOrganization

Authorizations:

path Parameters

Responses

Response samples

Get Organization Counters

Authorizations:

path Parameters

Responses

Response samples

Licenses

Get all licenses

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get a license

Authorizations:

path Parameters

Responses

Response samples

Assign a license to a device

Authorizations:

path Parameters

Responses

Response samples

Deactivate a license from a device

Authorizations:

path Parameters

Responses

Response samples

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 Templates

Get device Templates

Authorizations:

path Parameters

Responses

Response samples

Get device template

Authorizations:

path Parameters

Responses

Response samples

Device Actions

Get device Actions

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Available Fields and Operators in `query` parameter

Request Body schema: application/json
required

Available Fields and Operators in `query` parameter

Request Body schema: application/json
required