Skip to main content
API docs by Redocly

Datalogic Connect (1.4.0)

Download OpenAPI specification:Download

Notifications

Real-time notification streaming via SSE

Stream notifications via SSE

Opens a Server-Sent Events stream for real-time notifications.

Every frame carries event: set to the payload's type and id: set to its eventId. Whatever the type, the payload is the same envelope: the identity of the event, the entity it is about in data, and the state that entity was in before the change in previousData.

data is the model the REST API documents for that resource -- ActionDetails for an action, CommandResponse for a command -- so an event can be rendered with the same code as the corresponding GET.

previousData is null when there is no state change to describe: the first event of a workflow, and the progress updates of a running action, where only the counters in data.progress move.

The flat fields beside them are the pre-envelope contract. They are still sent, unchanged, and each one is marked deprecated with the field inside data that replaces it.

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

The organization id

query Parameters
workflowIds
string

Comma-separated Temporal workflow IDs to subscribe to for file-processing status updates.

api-version
string

API version

Responses

Response samples

Content type
text/event-stream
Example
{
  "eventId": "0bc62390-36d9-42f6-a811-2a6c93029992",
  "type": "ACTION_STATUS_CHANGED",
  "timestamp": 1785308278.4756238,
  "previousData": {
    "id": "f0a05649-2bf8-4459-b510-20bd89acd0a1",
    "name": "applyS2dProfile",
    "status": "IN_PROGRESS",
    "progress": {
      "total": 3,
      "created": 0,
      "completed": 2,
      "failed": 0,
      "pending": 0,
      "inProgress": 1
    }
  },
  "data": {
    "id": "f0a05649-2bf8-4459-b510-20bd89acd0a1",
    "name": "applyS2dProfile",
    "status": "FAILED",
    "progress": {
      "total": 3,
      "created": 0,
      "completed": 2,
      "failed": 1,
      "pending": 0,
      "inProgress": 0
    }
  },
  "actionId": "f0a05649-2bf8-4459-b510-20bd89acd0a1",
  "actionName": "applyS2dProfile",
  "previousStatus": "IN_PROGRESS",
  "newStatus": "FAILED",
  "ownerId": "014440ab-15cd-43ef-8451-a2fe7e197b1c",
  "organizationId": "7f1f7d36-2bcd-407e-b92a-47dc60a0f005",
  "locationId": "882a1c05-9895-4ed4-beb6-30707bc96004"
}

Organization Settings

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 \""

Device Approval Rules

Manage device auto-approval rules

List every approval rule visible to the caller

Tree of visible rules, rooted at the organization root: the caller's ancestor chain plus their own subtree, never sibling branches. Each node carries canManage; each rule carries canManage and, when disabled, fallsBackTo.

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
[
  • {
    }
]

Create an approval rule

locationId is part of the body; the caller must be able to manage it.

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
locationId
required
string <uuid>
deviceCategoryId
required
integer <int64>
required
Array of objects (ApprovalRuleLicenseSpec)
enabled
required
boolean
name
required
string [ 4 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "licenses": [
    ],
  • "enabled": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "deviceCategoryName": "string",
  • "licenses": [
    ],
  • "enabled": true,
  • "canManage": true,
  • "fallsBackTo": {
    },
  • "owner": {
    },
  • "lastModifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Resolve the winning approval rule for a location

Resolves the single rule that would actually govern a device at this location, per category. Without deviceCategoryId, resolves over every category in the organization and returns the distinct set of winners. Losing candidates are never returned.

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

The organization id

locationId
required
string <uuid>
query Parameters
deviceCategoryId
integer or null <int64>

Optional device category; without it, resolves over every category in the organization

api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a single approval rule

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

The organization id

ruleId
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",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "deviceCategoryName": "string",
  • "licenses": [
    ],
  • "enabled": true,
  • "canManage": true,
  • "fallsBackTo": {
    },
  • "owner": {
    },
  • "lastModifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an approval rule, optionally moving it

Partial update: every field is optional, a field left out keeps its current value. Changing locationId moves the rule; the caller must be able to manage both the source and the destination location.

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

The organization id

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

API version

Request Body schema: application/json
required
locationId
string or null <uuid>
deviceCategoryId
integer or null <int64>
Array of objects or null (ApprovalRuleLicenseSpec)
enabled
boolean or null
name
string or null [ 4 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "licenses": [
    ],
  • "enabled": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "deviceCategoryName": "string",
  • "licenses": [
    ],
  • "enabled": true,
  • "canManage": true,
  • "fallsBackTo": {
    },
  • "owner": {
    },
  • "lastModifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete an approval rule

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

The organization id

ruleId
required
string <uuid>
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": [
    ],
  • "details": {
    }
}

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"
}

Import users from a CSV file

Validates the whole file, then starts the onboarding in the background. Semicolon-separated CSV with header: name, email, role, locationId, locationName — locationId wins over locationName. A rejected file creates nobody and sends no mail; the response carries the workflow id for following the outcome.

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: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "accepted": true,
  • "userCount": 0,
  • "workflowId": "string",
  • "users": [
    ]
}

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

Import a location hierarchy from a CSV file

Creates a whole location hierarchy below the requested target location. The file is a semicolon-separated CSV with a header line declaring the columns 'name' and 'parent'. An empty 'parent' attaches the row directly to the target location; otherwise it must name another row of the file, or an existing location at or below the target. The whole file is validated before anything is created: any rejection leaves the organisation untouched.

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

The organization id

query Parameters
targetLocationId
required
string <uuid>
Example: targetLocationId=54519926-4bf6-b691-86af-5e7173cde7e6

The location the imported hierarchy is created under

api-version
string

API version

Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "created": 0,
  • "locations": [
    ]
}

Get location tree with device status

Returns the full location hierarchy as a tree structure, enriched with online/offline device counts for each location

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
[
  • {
    }
]

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

SureMDM

Integration with 42Gears SureMDM for Remote Control and Location Tracking iframe URLs

Get Location Tracking iframe URL

Returns an authenticated iframe URL for embedding the SureMDM Location Tracking mapfor a specific device.

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

The organization id

deviceId
required
string
Example: DrewH

The device id

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "iframeUrl": "string"
}

Get Location Tracking configuration

Returns the Location Tracking configuration for the device,

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

The organization id

deviceId
required
string
Example: DrewH

The device id

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "isTimeEnabled": true,
  • "periodicity": 1,
  • "durationType": "hours",
  • "isDistanceEnabled": true,
  • "locationDistance": 5,
  • "displacementType": "miles",
  • "indoorLocation": 0,
  • "periodicityIndoor": 1,
  • "indoorDurationType": "hours"
}

Activate or deactivate Location Tracking

Activates or deactivates the SureMDM Location Tracking job for a specific device. When enabled is true, the body must include periodicity, durationType, locationDistance and displacementType.

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

The organization id

deviceId
required
string
Example: DrewH

The device id

query Parameters
api-version
string

API version

Request Body schema: application/json
required
enabled
required
boolean
isTimeEnabled
boolean or null
Default: true
periodicity
integer or null <int32> [ 1 .. 20000 ]
Default: 1
durationType
string or null
Default: "hours"
Enum: "hours" "minutes"
isDistanceEnabled
boolean or null
Default: true
locationDistance
integer or null <int32> [ 1 .. 20000 ]
Default: 5
displacementType
string or null
Default: "kilometers"
Enum: "miles" "kilometers" "meters"
indoorLocation
integer or null <int32>
Default: 0
periodicityIndoor
integer or null <int32> [ 1 .. 20000 ]
Default: 1
indoorDurationType
string or null
Default: "hours"
Enum: "hours" "minutes"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "isTimeEnabled": true,
  • "periodicity": 1,
  • "durationType": "hours",
  • "isDistanceEnabled": true,
  • "locationDistance": 5,
  • "displacementType": "miles",
  • "indoorLocation": 0,
  • "periodicityIndoor": 1,
  • "indoorDurationType": "hours"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "isTimeEnabled": true,
  • "periodicity": 1,
  • "durationType": "hours",
  • "isDistanceEnabled": true,
  • "locationDistance": 5,
  • "displacementType": "miles",
  • "indoorLocation": 0,
  • "periodicityIndoor": 1,
  • "indoorDurationType": "hours"
}

Get Remote Control iframe URL

Returns an authenticated iframe URL for embedding the SureMDM Remote Control session for a specific device.

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

The organization id

deviceId
required
string
Example: DrewH

The device id

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "iframeUrl": "string"
}

Configurations

Configurations is a service that makes it easy to manage configuration's 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" "TICKET_SWITCHING" "PRODUCE_RECOGNITION" "LOSS_PREVENTION_CONFIG"
owner
string or null
categoryIds
Array of integers or null <int64> [ items <int64 > ]
sizeFrom
integer or null <int64>
sizeTo
integer or null <int64>
createdAtFrom
string or null <date-time>

Filter files created at or after this instant (ISO-8601)

createdAtTo
string or null <date-time>

Filter files created at or before this instant (ISO-8601)

updatedAtFrom
string or null <date-time>

Filter files updated at or after this instant (ISO-8601)

updatedAtTo
string or null <date-time>

Filter files updated at or before this instant (ISO-8601)

status
Array of strings or null (FileRecord.StorageStatus)
Enum: "PROCESSING" "FAILED" "COMPLETED"
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
}

Notify configuration file upload

Notifies the backend of the result of a SAS-based upload.

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
blobName
required
string
name
required
string
description
string or null
categoryId
integer or null <int64>

Responses

Request samples

Content type
application/json
{
  • "blobName": "string",
  • "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",
  • "status": "PROCESSING"
}

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",
  • "status": "PROCESSING"
}

Get supported file types for upload

Returns the list of file extensions currently allowed for upload via SAS URL.

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

API version

Responses

Response samples

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

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": [
    ]
}

Generate SAS URL for direct upload 

    Generates a SAS URL to upload a configuration file directly to Azure Blob Storage.
    No FileRecord is created here: it will be created later either by POST /configurations
    or by the BlobCreated Event Grid event.
    
    ### Blob custom metadata
    When performing the PUT to the SAS URL, the client may set these `x-ms-meta-*` headers.
    They are read by the backend on the Event Grid path.
    
    - `name` — display name (base64-encoded UTF-8)
    - `description` — free text (base64-encoded UTF-8)
    - `categoryid` — long (plain ASCII)
    - `userid` — UUID of the uploader (plain ASCII). If omitted, the FileRecord is created
      with `owner = null` and can be upgraded by a later POST /configurations.
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
fileName
required
string non-empty

The original file name, including extension.

fileSize
integer <int64> > 0

File size in bytes. Must be <= configured max (default 3 GB).

Responses

Request samples

Content type
application/json
{
  • "fileName": "products.zip",
  • "fileSize": 104857600
}

Response samples

Content type
application/json
{}

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",
  • "status": "PROCESSING"
}

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",
  • "status": "PROCESSING"
}

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

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",
  • "status": "PROCESSING"
}

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

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. Optionally filter either by explicit manifest type (repeatable, returns the union of the requested types) or by deviceType, which the backend resolves to the manifest types that kind of device accepts. The two parameters are mutually exclusive; supplying both is a 400.

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
query Parameters
type
Array of strings or null (EdgeManifestType)
Enum: "edge" "docker" "magellan_connect" "produce_recognition" "produce_recognition_edge" "roger_base" "roger_terra"

Manifest types to return. Repeatable: ?type=edge&type=produce_recognition_edge returns the union. Mutually exclusive with deviceType.

deviceType
string or null
Enum: "iotEdge" "iotDevice" "host" "produceServer"

Return only the manifest types accepted by this kind of device. Mutually exclusive with type.

api-version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateManifests

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

API version

Request Body schema: application/json
required
required
Array of objects (ManifestUpdateEntry)
Array
manifestId
required
string <uuid>
object or null

Responses

Request samples

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

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,
  • "userVariables": {
    },
  • "type": "edge"
}

Get manifest user variables

Retrieve the user variables required to complete a manifest, with expected type and optionality. Optionally specify a 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
[
  • {
    }
]

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,
  • "userVariables": {
    },
  • "type": "edge"
}

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

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
Array of objects or null (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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

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": [
    ]
}

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
Enum: "WAITING_FOR_APPROVAL" "UNDER_APPROVAL" "REGISTERED" "BLOCKED" "PROVISIONED"
parentIds
Array of strings or null

Filter by parentId. Repeat the param for multiple values. Use the value "null" to also match devices without a parent (parentId IS NULL), e.g. parentIds=null&parentIds=DEV1.

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" "API_HHS" "API_FRS" "API_MOB" "API_PILOT_HHS" "API_PILOT_FRS" "API_PILOT_MOB" "SV_PRODUCE_RECOGNITION" "SV_PRODUCE_REC_MIS_SCAN_LABEL_SWITCHING" "SV_PRODUCE_REC_MIS_SCAN" "SV_PRODUCE_REC_LABEL_SWITCHING" "SV_BOTTOM_BASKET_ENTRY" "SV_BOTTOM_BASKET_PREMIUM" "SV_LABEL_SWITCHING" "SV_MIS_SCAN_LABEL_SWITCHING" "SV_MIS_SCAN" "SV_PILOT_BOTTOM_BASKET_PREMIUM" "SV_PILOT_MIS_SCAN_LABEL_SWITCHING" "SV_PILOT_PRODUCE_REC" "MOB_ADD_ON"
licenseStatus
Array of strings or null (LicenseStatusEnum)
Enum: "LICENSED" "NOT_LICENSED" "EXPIRED" "N_A"
firmwareVersion
string or null
extend
string or null
Value: "SMART_VISION_DIAGNOSTIC"
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
Array of objects or null (LicenseAttachment)
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",
  • "licenseIds": [
    ],
  • "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": {
    },
  • "licenses": [
    ],
  • "manifestInfos": [
    ],
  • "firmwareVersion": "string",
  • "metadata": {
    },
  • "childrenCount": 0,
  • "smartVisionStatus": "HEALTHY",
  • "smartVisionStatusDetails": {
    }
}

Add device

This API can be used to add one device, optionally assigning licenses and deploying manifests.

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
Array of objects or null (LicenseAttachment)
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",
  • "licenseIds": [
    ],
  • "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": {
    },
  • "licenses": [
    ],
  • "manifestInfos": [
    ],
  • "firmwareVersion": "string",
  • "metadata": {
    },
  • "childrenCount": 0,
  • "smartVisionStatus": "HEALTHY",
  • "smartVisionStatusDetails": {
    }
}

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": {
    }
}

Bulk approve devices

This API can be used to bulk approve devices.

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
locationId
required
string <uuid>
deviceCategoryId
required
integer <int64>
Array of objects or null (LicenseAttachment)

Responses

Request samples

Content type
application/json
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "deviceCategoryId": 0,
  • "licenses": [
    ]
}

Response samples

Content type
application/json
{
  • "totalDevicesToApprove": 0
}

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
extend
string or null
Value: "SMART_VISION_DIAGNOSTIC"
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": {
    },
  • "licenses": [
    ],
  • "manifestInfos": [
    ],
  • "firmwareVersion": "string",
  • "metadata": {
    },
  • "childrenCount": 0,
  • "smartVisionStatus": "HEALTHY",
  • "smartVisionStatusDetails": {
    }
}

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
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

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
Enum: "WAITING_FOR_APPROVAL" "UNDER_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
object 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
object 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"
}

Edge enrollment QR payload

Builds the JSON payload the frontend renders as an enrollment QR code. Available only for iotEdge devices.

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

Request Body schema: application/json
required
edgeIp
required
string non-empty
locationId
string or null <uuid>
enrollmentToken
string or null

Responses

Request samples

Content type
application/json
{
  • "edgeIp": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "enrollmentToken": "string"
}

Response samples

Content type
application/json
{
  • "port": 0,
  • "token": {
    },
  • "addresses": [
    ],
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54"
}

Install script

Downloads an archive holding the IoT Edge installation script pre-filled with the device's scopeId, deviceId and primaryKey, its SHA-256 checksum and a README. Available only for iotEdge devices. os=ubuntu (default) returns a .tar.gz with the bash installer for Ubuntu 22.04/24.04; os=windows returns a .zip with the PowerShell installer for IoT Edge for Linux on Windows (EFLOW).

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

The organization id

deviceId
required
string
query Parameters
os
string (InstallScriptOs)
Enum: "UBUNTU" "WINDOWS"

Target operating system of the installer: ubuntu (default) or windows

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": [
    ],
  • "details": {
    }
}

getActiveModules

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

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
{
  • "property1": { },
  • "property2": { }
}

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
{
  • "property1": { },
  • "property2": { }
}

Scheduled Actions

APIs for managing scheduled device actions

List scheduled actions

Returns a paginated list of scheduled actions with optional filters

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

displayName
string or null

Filter by display name (partial match, case-insensitive)

scheduleType
string or null
Enum: "IMMEDIATELY" "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY"

Filter by schedule type

status
string or null
Enum: "SCHEDULED" "UNSCHEDULED" "RUNNING" "COMPLETED"

Filter by status

enabled
boolean or null

Filter by enabled/disabled state

deviceGroupId
string or null <uuid>

Filter by device group ID

ownerId
string or null <uuid>

Filter by owner user ID

startDateFrom
string or null <date-time>

Filter schedules starting at or after this date

startDateTo
string or null <date-time>

Filter schedules starting at or before this date

endDateFrom
string or null <date-time>

Filter schedules ending at or after this date

endDateTo
string or null <date-time>

Filter schedules ending at or before this date

nextExecutionFrom
string or null <date-time>

Filter scheduled actions whose next execution is at or after this date

nextExecutionTo
string or null <date-time>

Filter scheduled actions whose next execution is at or before this date

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

Filter by location ID (one or more)

draft
boolean or null

Filter by draft state

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 a scheduled action

Creates a new scheduled action for the 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

Request Body schema: application/json
required
displayName
required
string <= 255 characters
description
string or null <= 255 characters
required
object (ActionRequest.ActionDataCommandRequest)
deviceGroupId
required
string <uuid>
scheduleType
string or null
Enum: "IMMEDIATELY" "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY"
startDate
string or null <date-time>
endDate
string or null <date-time>
enabled
boolean or null
draft
required
boolean

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "data": {
    },
  • "deviceGroupId": "47103c21-a78d-4990-a233-7f9ad2536254",
  • "scheduleType": "IMMEDIATELY",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "draft": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "errors": [
    ],
  • "details": {
    }
}

Get scheduled action by ID

Returns a single scheduled action

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

The organization id

id
required
string <uuid>

The scheduled action ID

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "displayName": "string",
  • "description": "string",
  • "data": {
    },
  • "deviceGroup": {
    },
  • "location": {
    },
  • "owner": {
    },
  • "scheduleType": "IMMEDIATELY",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "lastExecution": "2019-08-24T14:15:22Z",
  • "nextExecution": "2019-08-24T14:15:22Z",
  • "executionCount": 0,
  • "enabled": true,
  • "draft": true,
  • "status": "SCHEDULED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update a scheduled action

Update a scheduled action for the organization

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

The organization id

id
required
string <uuid>

The scheduled action ID

query Parameters
api-version
string

API version

Request Body schema: application/json
required
displayName
string or null <= 255 characters
description
string or null <= 255 characters
object or null
deviceGroupId
string or null <uuid>
scheduleType
string or null
Enum: "IMMEDIATELY" "ONE_TIME" "DAILY" "WEEKLY" "MONTHLY"
startDate
string or null <date-time>
endDate
string or null <date-time>
enabled
boolean or null
draft
boolean or null

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "data": {
    },
  • "deviceGroupId": "47103c21-a78d-4990-a233-7f9ad2536254",
  • "scheduleType": "IMMEDIATELY",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "draft": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "displayName": "string",
  • "description": "string",
  • "data": {
    },
  • "deviceGroup": {
    },
  • "location": {
    },
  • "owner": {
    },
  • "scheduleType": "IMMEDIATELY",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "lastExecution": "2019-08-24T14:15:22Z",
  • "nextExecution": "2019-08-24T14:15:22Z",
  • "executionCount": 0,
  • "enabled": true,
  • "draft": true,
  • "status": "SCHEDULED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a scheduled action

Deletes a scheduled action for the organization

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

The organization id

id
required
string <uuid>

The scheduled action ID

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": [
    ],
  • "details": {
    }
}

Retrieve Actions triggered by a scheduled action API

Retrieves all Actions associated with a scheduled action

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

The organization id

id
required
string <uuid>

The scheduled action 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

actionStatus
string or null
Enum: "PENDING" "IN_PROGRESS" "COMPLETED" "FAILED" "PARTIAL"

Filter by action status

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

Filter by location ID (one or more)

deviceGroupId
string or null <uuid>

Filter by device group ID

startDateFrom
string or null <date-time>

Filter actions with startTime at or after this date

startDateTo
string or null <date-time>

Filter actions with startTime at or before this date

endDateFrom
string or null <date-time>

Filter actions with endTime at or after this date

endDateTo
string or null <date-time>

Filter actions with endTime at or before this date

displayName
string or null

Filter by display name (partial match, case-insensitive)

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
}

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 Actions

Device Actions API

Get device Actions

Get device Actions 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=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
hasScheduledAction
boolean or null

Filter by whether the action has an associated scheduled action

startDateFrom
string or null <date-time>

Filter actions with startTime at or after this date

startDateTo
string or null <date-time>

Filter actions with startTime at or before this date

groupId
string or null <uuid>

Filter by device group ID

categoryId
Array of integers or null <int64> [ items <int64 > ]

Filter by device category ID (includes all child categories)

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": {
    },
  • "owner": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "tokensConsumed": 0,
  • "progress": {
    },
  • "location": {
    },
  • "scheduledAction": {
    }
}

Get device Action

Get a device Action for an organization

Authorizations:
bearerAuthapiTokenAuth
path Parameters
organizationId
required
string <uuid>
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",
  • "deviceIds": [
    ],
  • "deviceGroup": {
    },
  • "commandIds": [
    ],
  • "data": {
    },
  • "owner": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "tokensConsumed": 0,
  • "progress": {
    },
  • "location": {
    },
  • "scheduledAction": {
    }
}

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
}

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"
}

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
[
  • {
    }
]

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
creationDateFrom
string or null\d{4}-\d{2}-\d{2}

yyyy-MM-dd

creationDateTo
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
receivedDateFrom
string or null\d{4}-\d{2}-\d{2}

yyyy-MM-dd

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

yyyy-MM-dd

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

yyyy-MM-dd

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

yyyy-MM-dd

store
string or null
shippingDateFrom
string or null\d{4}-\d{2}-\d{2}

yyyy-MM-dd

shippingDateTo
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": [
    ],
  • "details": {
    }
}

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": [
    ],
  • "details": {
    }
}

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"

API Tokens

Manage per-user API tokens

List API tokens

Returns the authenticated user's tokens (metadata only), paginated.

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

The organization id

query Parameters
page
integer or null <int32>
size
integer or null <int32>
Example: size=10
sort
string or null
Example: sort=createdAt,desc
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 API token

Creates a new API token for the authenticated user. The plaintext secret is returned ONCE.

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
name
required
string [ 1 .. 200 ] characters
expiresAt
string or null <date-time>
object or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "role": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "secret": "string",
  • "role": {
    }
}

Get API token

Returns metadata for a token owned by the caller.

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

The organization id

id
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",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUsedAt": "2019-08-24T14:15:22Z",
  • "role": {
    },
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Revoke API token

Revokes a token owned by the caller.

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

The organization id

id
required
string <uuid>
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": [
    ],
  • "details": {
    }
}

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": [
    ]
}

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_HHS" "API_FRS" "API_MOB" "API_PILOT_HHS" "API_PILOT_FRS" "API_PILOT_MOB" "SV_PRODUCE_RECOGNITION" "SV_PRODUCE_REC_MIS_SCAN_LABEL_SWITCHING" "SV_PRODUCE_REC_MIS_SCAN" "SV_PRODUCE_REC_LABEL_SWITCHING" "SV_BOTTOM_BASKET_ENTRY" "SV_BOTTOM_BASKET_PREMIUM" "SV_LABEL_SWITCHING" "SV_MIS_SCAN_LABEL_SWITCHING" "SV_MIS_SCAN" "SV_PILOT_BOTTOM_BASKET_PREMIUM" "SV_PILOT_MIS_SCAN_LABEL_SWITCHING" "SV_PILOT_PRODUCE_REC" "MOB_ADD_ON"
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
}

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.

notExpired
boolean or null
Default: false
type
string or null
Enum: "ROGER" "CONNECT" "CONNECT_ADD_ON"
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 assignable licenses for a device category

Returns the list of assignable and non-expired licenses for a given device category, including compatibility information between licenses.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>
deviceCategoryId
required
integer <int64>
query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "deviceCategoryId": 0,
  • "approvable": true,
  • "licensable": true,
  • "assignableLicenses": [
    ]
}

Assign licenses to a device Deprecated

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

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

The organization id

deviceId
required
string

The ID of the device.

query Parameters
api-version
string

API version

Request Body schema: application/json
required

The licenses to be assigned.

required
Array of objects (LicenseAttachment)
Array
licenseId
required
string <uuid>
object or null

Responses

Request samples

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

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": {
    },
  • "licenses": [
    ],
  • "manifestInfos": [
    ],
  • "firmwareVersion": "string",
  • "metadata": {
    },
  • "childrenCount": 0,
  • "smartVisionStatus": "HEALTHY",
  • "smartVisionStatusDetails": {
    }
}

Deactivate licenses from a device Deprecated

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

deviceId
required
string

The ID of the device.

query Parameters
api-version
string

API version

Request Body schema: application/json
required

The licenses to be deactivated.

licenses
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

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": {
    },
  • "licenses": [
    ],
  • "manifestInfos": [
    ],
  • "firmwareVersion": "string",
  • "metadata": {
    },
  • "childrenCount": 0,
  • "smartVisionStatus": "HEALTHY",
  • "smartVisionStatusDetails": {
    }
}

Check if a feature is enabled for a device

This API checks if a specific feature is enabled for a given device, even when the device has no assigned license

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

The organization id

deviceId
required
string
Example: device-001

The device id

feature
required
string (LicenseFeatureEnum)
Enum: "BASIC_COMMANDS" "PROFESSIONAL_COMMANDS" "MOB_LOCALIZATION" "MOB_REMOTE_CONTROL"
Example: MOB_LOCALIZATION

The feature to check

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "deviceId": "device-001",
  • "licenseId": [
    ],
  • "feature": "mob_localization",
  • "enabled": true
}

Get user variables to fill for a set of licenses

Given a list of license ids, returns for each license only the manifests that still need user variables filled in before it can be deployed, each carrying those variables — the same manifestInfos shape a device carries, with variables populated and userVariables/tags null since nothing is applied to a device yet. A license can resolve to more than one such manifest (the one mapped from its product type, its edge companion where one exists, and roger_terra), so the value is a list; a resolved manifest with nothing to fill in is left out of it. Licenses without an edge manifest are omitted entirely. Keyed by license id so it can be filled and passed back to assign/update flows.

Authorizations:
bearerAuth
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
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

getFeatureEnabled

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

API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

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",
  • "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": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "licenseProductType": "HHS_ESSENTIAL",
  • "licenseCategory": "ROGER",
  • "deviceCategoryId": 0,
  • "maxTokens": 0,
  • "usedSeats": 0,
  • "tokensConsumed": 0
}

Check if a feature is enabled for a license

This API checks if a specific feature is enabled for a given license

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

The organization id

licenseId
required
string <uuid>
Example: c2b176f7-3bf6-484b-9118-cd6e5c8e0198

The license id

feature
required
string (LicenseFeatureEnum)
Enum: "BASIC_COMMANDS" "PROFESSIONAL_COMMANDS" "MOB_LOCALIZATION" "MOB_REMOTE_CONTROL"
Example: MOB_LOCALIZATION

The feature to check

query Parameters
api-version
string

API version

Responses

Response samples

Content type
application/json
{
  • "licenseId": "c2b176f7-3bf6-484b-9118-cd6e5c8e0198",
  • "feature": "mob_localization",
  • "enabled": true
}