Skip to main content
API docs by Redocly

Datalogic Connect (0.16.2)

Download OpenAPI specification:Download

Organization Configurations

Manage feature flags and configurations for organizations

Get all configurations for organization

Retrieve all feature flags and configurations for the specified organization. Missing configurations will be automatically created with default values.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

Organization ID

query Parameters
enabled_only
boolean or null

Filter only enabled configurations

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "configurations": [
    ],
  • "total": 1
}

Get configuration by key

Retrieve a specific configuration for the organization by config key. If the configuration doesn't exist, it will be created with default values.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

Organization ID

configKey
required
string (ConfigurationKey)
Enum: "LOSS_PREVENTION_ENABLED" "LICENSE_ENFORCEMENT_ENABLED"
Example: LOSS_PREVENTION_ENABLED

Configuration key

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "organization_id": 123,
  • "config_key": "LOSS_PREVENTION_ENABLED",
  • "config_value": {
    },
  • "enabled": true,
  • "created_at": "2023-10-15T10:30:00",
  • "updated_at": "2023-10-15T14:20:00"
}

Check if feature is enabled

Check if a specific feature is enabled for the organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

Organization ID

configKey
required
string (ConfigurationKey)
Enum: "LOSS_PREVENTION_ENABLED" "LICENSE_ENFORCEMENT_ENABLED"
Example: LOSS_PREVENTION_ENABLED

Configuration key

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
"\n {\n \"config_key\": \"LOSS_PREVENTION_ENABLED\",\n \"enabled\": true,\n \"organization_id\": 123\n }\n \""

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
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" "TICKET_SWITCHING" "PRODUCE_RECOGNITION"
owner
string or null
categoryIds
Array of integers or null <int64> [ items <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

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "pageNumber": 0,
  • "offset": 0,
  • "size": 0,
  • "empty": true,
  • "numberOfElements": 0,
  • "totalSize": 0,
  • "totalPages": 0
}

Rollback to a specific file version

This API allow you to rollback the file to a specific file version if you are allowed to see.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
fileVersion
required
integer <int32>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "categoryId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get file types

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "totalFiles": 0,
  • "deviceTypes": [
    ]
}

Upload a file

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
query Parameters
api-version
string

API version

Request Body schema: multipart/form-data
required
name
required
string
description
required
string
categoryId
integer <int64>
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "categoryId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Upload new version

This API can be used to upload a new version of a file to Azure.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
query Parameters
api-version
string

API version

Request Body schema: multipart/form-data
required
name
string or null
description
string or null
categoryId
integer or null <int64>
file
string or null <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
query Parameters
api-version
string

API version

Request Body schema: application/json
required
name
string or null
description
string or null
categoryId
integer or null <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "categoryId": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
id
required
string
organizationId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

Get all versions of a file

This API allows you to retrieve all versions of a file if you have access to it.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific file version

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
fileVersion
required
integer <int32>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "categoryId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a specific file version

This API allow you to delete a specific file version if you have the permission.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
id
required
string
fileVersion
required
integer <int32>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "version": 0,
  • "description": "string",
  • "filepath": "string",
  • "dataType": "SCAN2DEPLOY",
  • "size": 0,
  • "owner": {
    },
  • "categoryId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=id,desc

The field and sort order

ids
Array of strings or null <uuid> [ items <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> [ items <uuid > ]
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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

locationName

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

categoryName

  • 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 with timezone)
  • Operators: BETWEEN, NOT_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: Array of booleans
  • Operators: EQUALS, NOT_EQUALS

status

  • Type: Array of strings
  • Operators: IN, NOT_IN
  • Valid values: WAITING_FOR_APPROVAL, REGISTERED, BLOCKED, PROVISIONED
Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

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

Content type
application/json
Example
{
  • "name": "IoT Devices in Location A",
  • "description": "All IoT devices in location A",
  • "locationId": "54519926-4bf6-b691-86af-5e7173cde7e6",
  • "categoryId": 192,
  • "query": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "query": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "categoryId": 0,
  • "owner": {
    }
}

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

locationName

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

categoryName

  • 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 with timezone)
  • Operators: BETWEEN, NOT_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: Array of booleans
  • Operators: EQUALS, NOT_EQUALS

status

  • Type: Array of strings
  • Operators: IN, NOT_IN
  • Valid values: WAITING_FOR_APPROVAL, REGISTERED, BLOCKED, PROVISIONED
Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=id,desc

The field and sort order

id
string or null
name
string or null
api-version
string

API version

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

Content type
application/json
{
  • "locationId": "54519926-4bf6-b691-86af-5e7173cde7e6",
  • "categoryId": 192,
  • "query": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceGroupId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "query": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "categoryId": 0,
  • "owner": {
    }
}

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

locationName

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

categoryName

  • 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 with timezone)
  • Operators: BETWEEN, NOT_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: Array of booleans
  • Operators: EQUALS, NOT_EQUALS

status

  • Type: Array of strings
  • Operators: IN, NOT_IN
  • Valid values: WAITING_FOR_APPROVAL, REGISTERED, BLOCKED, PROVISIONED
Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceGroupId
required
string <uuid>

The ID of the device group to update.

query Parameters
api-version
string

API version

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

Content type
application/json
{
  • "name": "Advanced Filter Group",
  • "description": "Devices with complex filtering",
  • "locationId": "54519926-4bf6-b691-86af-5e7173cde7e6",
  • "categoryId": 192,
  • "query": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "query": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "categoryId": 0,
  • "owner": {
    }
}

Delete device group

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceGroupId
required
string <uuid>

The ID of the device group to delete.

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

Get device group detail

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceGroupId
required
string <uuid>
query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=id,desc

The field and sort order

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "pageNumber": 0,
  • "offset": 0,
  • "size": 0,
  • "empty": true,
  • "numberOfElements": 0,
  • "totalSize": 0,
  • "totalPages": 0
}

Misc

Misc APIs

get the user information, including the organization and roles

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

Authorizations:
bearerAuthapiTokenAuth
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mail": "string",
  • "profile": { },
  • "preferences": { },
  • "organizations": [
    ]
}

update the user information

This endpoint update the user information.

Authorizations:
bearerAuthapiTokenAuth
query Parameters
api-version
string

API version

Request Body schema: application/json
required
name
string or null [ 4 .. 50 ] characters
object or null
object or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profile": { },
  • "preferences": { }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mail": "string",
  • "profile": { },
  • "preferences": { },
  • "organizations": [
    ]
}

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=id,desc

The field and sort order

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

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

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

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 50 ] characters
parentId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

locationId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

locationId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=id,desc

The field and sort order

name
string or null
mail
string or null
locationId
Array of strings or null <uuid> [ items <uuid > ]
roles
Array of strings or null
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

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

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mail": "user@example.com",
  • "role": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mail": "string",
  • "profile": { },
  • "preferences": { },
  • "roles": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create user

This API allows you to create a user

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

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

Content type
application/json
{
  • "name": "string",
  • "mail": "user@example.com",
  • "role": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mail": "string",
  • "profile": { },
  • "preferences": { },
  • "roles": [
    ],
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

id
required
string <uuid>
Example: 7fd28f13-7dab-4a1d-9266-cbc82cafa4eb
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mail": "string",
  • "profile": { },
  • "preferences": { },
  • "roles": [
    ],
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

userId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=createdAt,desc

The field and sort order

id
string or null
deviceIdContains
Array of strings or null
devicesIds
Array of strings or null
name
string or null
locationId
Array of strings or null <uuid> [ items <uuid > ]
deviceType
string or null
Enum: "iotEdge" "iotDevice" "host" "produceServer"
deviceCategoryId
Array of integers or null <int64> [ items <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
Array of strings or null (LicenseProductTypeEnum)
Enum: "HHS_ESSENTIAL" "HHS_PROFESSIONAL" "HHS_PREMIUM" "MOB_ESSENTIAL" "MOB_PROFESSIONAL" "MOB_PREMIUM" "FRS_ESSENTIAL" "FRS_PROFESSIONAL" "FRS_PREMIUM" "PILOT_HHS" "PILOT_MOB" "PILOT_FRS"
licenseStatus
Array of strings or null (LicenseStatusEnum)
Enum: "LICENSED" "NOT_LICENSED" "EXPIRED" "N_A"
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

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
licenseId
string or null
object or null
manifestId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "enabled": true,
  • "parentId": "string",
  • "licenseId": "string",
  • "manifestVariables": {
    },
  • "manifestId": "d9e221c5-ff18-4314-8e4b-8ff5f968a62f"
}

Response samples

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": {
    },
  • "parent": {
    },
  • "lastKnownConfig": {
    },
  • "license": {
    },
  • "manifestInfo": {
    }
}

Add device

This API can be used to update one device.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

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
licenseId
string or null <uuid>
object or null

Manifest user variables

manifestId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "enabled": true,
  • "parentId": "string",
  • "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  • "manifestVariables": {
    },
  • "manifestId": "d9e221c5-ff18-4314-8e4b-8ff5f968a62f"
}

Response samples

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": {
    },
  • "parent": {
    },
  • "lastKnownConfig": {
    },
  • "license": {
    },
  • "manifestInfo": {
    }
}

Delete devices

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "failedDevices": {
    }
}

Get device

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

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": {
    },
  • "parent": {
    },
  • "lastKnownConfig": {
    },
  • "license": {
    },
  • "manifestInfo": {
    }
}

Delete device

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=createdAt,desc

The field and sort order

id
string or null
name
string or null
locationId
Array of strings or null <uuid> [ items <uuid > ]
deviceType
string or null
Enum: "iotEdge" "iotDevice" "host" "produceServer"
deviceCategoryId
Array of integers or null <int64> [ items <int64 > ]
connection
boolean or null
status
Array of strings or null (DeviceStatus)
Enum: "WAITING_FOR_APPROVAL" "REGISTERED" "BLOCKED" "PROVISIONED"
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=createdAt,desc

The field and sort order

status
string or null
Enum: "CREATED" "PENDING" "IN_PROGRESS" "COMPLETED" "FAILED"
commandName
string or null
ownerId
string or null <uuid>
actionId
string or null <uuid>
startTimeFrom
string or null\d{4}-\d{2}-\d{2}

Filter commands with startTime >= this value (yyyy-MM-dd)

startTimeTo
string or null\d{4}-\d{2}-\d{2}

Filter commands with startTime <= this value (yyyy-MM-dd)

endTimeFrom
string or null\d{4}-\d{2}-\d{2}

Filter commands with endTime >= this value (yyyy-MM-dd)

endTimeTo
string or null\d{4}-\d{2}-\d{2}

Filter commands with endTime <= this value (yyyy-MM-dd)

createdAtFrom
string or null\d{4}-\d{2}-\d{2}

Filter commands created at or after this value (yyyy-MM-dd)

createdAtTo
string or null\d{4}-\d{2}-\d{2}

Filter commands created at or before this value (yyyy-MM-dd)

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "pageNumber": 0,
  • "offset": 0,
  • "size": 0,
  • "empty": true,
  • "numberOfElements": 0,
  • "totalSize": 0,
  • "totalPages": 0
}

Get executable commands

This api allows you to retrieve all the commands executable on a device based on its license

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get command

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
commandId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "command": "string",
  • "request": { },
  • "response": { },
  • "status": "CREATED",
  • "commandStatusCode": "string",
  • "tokensConsumed": 0,
  • "statusMessage": "string",
  • "deviceId": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "action": {
    },
  • "attachments": [
    ]
}

Execute command

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
commandName
required
string
query Parameters
api-version
string

API version

Request Body schema: application/json
required
payload
any or null
files
Array of strings or null
object or null

Responses

Request samples

Content type
application/json
Example
{
  • "payload": "Any string payload"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "command": "string",
  • "request": { },
  • "response": { },
  • "status": "CREATED",
  • "commandStatusCode": "string",
  • "tokensConsumed": 0,
  • "statusMessage": "string",
  • "deviceId": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "action": {
    },
  • "attachments": [
    ]
}

Execute command on a edge device

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
module
required
string
commandName
required
string
query Parameters
api-version
string

API version

Request Body schema: application/json
required
payload
any or null
files
Array of strings or null
object or null

Responses

Request samples

Content type
application/json
Example
{
  • "payload": "Any string payload"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "command": "string",
  • "request": { },
  • "response": { },
  • "status": "CREATED",
  • "commandStatusCode": "string",
  • "tokensConsumed": 0,
  • "statusMessage": "string",
  • "deviceId": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "action": {
    },
  • "attachments": [
    ]
}

Credentials

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "scope": "string",
  • "primaryKey": "string",
  • "secondaryKey": "string"
}

Properties

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

Telemetry names

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

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

deviceId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

Manifests

Manifests is a service that makes it easy to manage your Manifests

Get all manifest summaries

Retrieve summary information for all manifests within an organization. Only the latest version of each manifest is returned.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get manifest summary by ID

Retrieve summary information for a specific manifest by its ID. Only the latest version is returned.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
manifestId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "id_version": "cd94bee2-2426-4bfd-9a09-c77d49701fca",
  • "name": "string",
  • "version": 0
}

Get manifest user variables

Retrieve the list of tags (variables) required to complete a manifest. Optionally, specify a version to get variables for a specific version.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
manifestId
required
string <uuid>
query Parameters
version
integer or null <int32>
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get manifest summary by ID and version

Retrieve summary information for a specific manifest by its ID and version.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
manifestId
required
string <uuid>
version
required
integer <int32>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "id_version": "cd94bee2-2426-4bfd-9a09-c77d49701fca",
  • "name": "string",
  • "version": 0
}

Device Templates

Device Templates API

Get device Templates

Get device Templates for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get device template

Get a device template for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

templateId
required
integer <int64>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "deviceCommands": [
    ]
}

Rma

Rma API

Get Rma Schema

Get Rma Schema for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
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
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

rmaNumber
required
string
query Parameters
api-version
string

API version

Responses

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

rmaNumber
required
string
query Parameters
api-version
string

API version

Responses

Response samples

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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

serialnumber
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
"string"

Get Rma Form

Get Rma Form for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

rmanumber
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

Get Rma Form

Get Rma Form for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

rmanumber
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
"string"

Organizations

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

getOrganization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "enrollment": {
    },
  • "user": {
    }
}

Get Organization Counters

Get counters for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tokenCount": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Device Categories

Device Categories API

Get device Categories

Get device Categories for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
categoriesId
Array of integers or null <int64> [ items <int64 > ]
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total and online devices by category

Get total and online devices by category for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get device category

Get a device category for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

categoryId
required
integer <int64>

The category identifier

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "deviceTemplateId": 0,
  • "parentId": 0,
  • "image": "string",
  • "deviceType": "iotEdge"
}

Device Actions

Device Actions API

Get device Actions

Get device Actions for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=createdAt,desc

The field and sort order

locationId
Array of strings or null <uuid> [ items <uuid > ]
id
string or null <uuid>
name
string or null
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
api-version
string

API version

Request Body schema: application/json
required
name
required
string
description
required
string
deviceGroupId
required
string <uuid>
required
object (ActionRequest.ActionDataCommandRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "deviceGroupId": "47103c21-a78d-4990-a233-7f9ad2536254",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "deviceIds": [
    ],
  • "deviceGroup": {
    },
  • "commandIds": [
    ],
  • "data": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "progress": {
    },
  • "owner": {
    },
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
}

Get device Action

Get a device Action for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

actionId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "deviceGroup": {
    },
  • "data": {
    },
  • "owner": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "tokensConsumed": 0,
  • "progress": {
    },
  • "location": {
    }
}

Get device Action commands

Get all commands related to a device Action for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

actionId
required
string <uuid>
query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=createdAt,desc

The field and sort order

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "pageNumber": 0,
  • "offset": 0,
  • "size": 0,
  • "empty": true,
  • "numberOfElements": 0,
  • "totalSize": 0,
  • "totalPages": 0
}

Command Response Attachments

Manage attachments related to command responses

List command response attachments

Retrieve a paginated list of command response attachments for the specified organization.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=id,desc

The field and sort order

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "pageNumber": 0,
  • "offset": 0,
  • "size": 0,
  • "empty": true,
  • "numberOfElements": 0,
  • "totalSize": 0,
  • "totalPages": 0
}

Get command response attachments metadata

Retrieve metadata for the attachments associated with a specific command.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

commandId
required
string <uuid>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=created,desc

The field and sort order

ids
Array of strings or null <uuid> [ items <uuid > ]

Optional list of license UUIDs to filter.

name
string or null

Optional license name to filter.

categoryId
integer or null <int64>

Optional category id of devices which licenses can be assigned to.

api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "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 id.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

licenseId
required
string <uuid>

The id of the license.

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "name": "string",
  • "licenseKey": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE",
  • "maxSeats": 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": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "licenseProductType": {
    },
  • "maxTokens": 0,
  • "usedSeats": 0,
  • "tokensConsumed": 0
}

Assign a license to a device

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

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

licenseId
required
string <uuid>

The key of the license.

deviceId
required
string

The ID of the device.

query Parameters
api-version
string

API version

Responses

Response samples

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
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The organization id

licenseId
required
string <uuid>

The id of the license.

deviceId
required
string

The ID of the device.

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{ }

Licenses Information

Licenses Information API

Get licenses information

Public API for retrieving licenses information

query Parameters
page
integer or null <int32>

The page number

size
integer or null <int32>
Example: size=10

The page size

sort
string or null
Example: sort=licenseProductType,desc

The field and sort order

productType
string or null
Enum: "HHS_ESSENTIAL" "HHS_PROFESSIONAL" "HHS_PREMIUM" "MOB_ESSENTIAL" "MOB_PROFESSIONAL" "MOB_PREMIUM" "FRS_ESSENTIAL" "FRS_PROFESSIONAL" "FRS_PREMIUM" "PILOT_HHS" "PILOT_MOB" "PILOT_FRS"
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "pageNumber": 0,
  • "offset": 0,
  • "size": 0,
  • "empty": true,
  • "numberOfElements": 0,
  • "totalSize": 0,
  • "totalPages": 0
}