Jump to

• Request
• Response

Get an employee sensor device association.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes/{typeId}/sensorAttributes/{sensorAttributeId}/devices/{deviceId}

This operation retrieves an association between employee type, sensor attribute and device. Only users having role IoTCWSupervisor or higher can call this API.

Request

Path Parameters

• deviceId: string
  Param that identifies device
• orgId: string
  Organization identifier
• sensorAttributeId: string
  Param that identifies sensor attribute in employee wearable type
• typeId: string
  Param that identifies type

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Employee sensor device association was successfully retrieved.

Body ()

Root Schema : EmployeeSensorDevice

Type: object

Show Source

• deviceId: string
  Id of the device. The device must be activated and must support device model associated with the type and attribute

  Example: 21E15228-0C54-47E6-AC7F-41A0A8F8D10E
• deviceModelUrn: string
  Minimum Length: 0

  Maximum Length: 1000

  Device model identifier

  Example: urn:my:company:device:model
• id(optional): string
  Id of the device. The device must be activated and must support device model associated with the type and attributeDeprecated. Use deviceId property.

  Example: 21E15228-0C54-47E6-AC7F-41A0A8F8D10E
• links(optional): array links
• messageField: string
  Minimum Length: 0

  Maximum Length: 500

  Message attribute identifier

  Example: myAttributeName
• messageUrn: string
  Minimum Length: 0

  Maximum Length: 1000

  Device message identifier. The message must have parent identified by value in deviceModelUrn. If not provided, it os automatically composed from value from 'deviceModelUrn' plus ':attributes'

  Example: urn:my:company:device:model:message
• sensorAttributeId: string
  Id of the sensor attribute

  Example: 51
• typeId: string
  Id of the type

  Example: 50

{
    "required":[
        "deviceId",
        "deviceModelUrn",
        "messageField",
        "messageUrn",
        "sensorAttributeId",
        "typeId"
    ],
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "description":"Id of the device. The device must be activated and must support device model associated with the type and attribute",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E"
        },
        "typeId":{
            "type":"string",
            "description":"Id of the type",
            "example":"50"
        },
        "sensorAttributeId":{
            "type":"string",
            "description":"Id of the sensor attribute",
            "example":"51"
        },
        "deviceModelUrn":{
            "maxLength":1000,
            "minLength":0,
            "type":"string",
            "description":"Device model identifier",
            "example":"urn:my:company:device:model"
        },
        "messageUrn":{
            "maxLength":1000,
            "minLength":0,
            "type":"string",
            "description":"Device message identifier. The message must have parent identified by value in deviceModelUrn. If not provided, it os automatically composed from value from 'deviceModelUrn' plus ':attributes'",
            "example":"urn:my:company:device:model:message"
        },
        "messageField":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Message attribute identifier",
            "example":"myAttributeName"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"Id of the device. The device must be activated and must support device model associated with the type and attributeDeprecated. Use deviceId property.",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top