Jump to

• Request
• Response

Get all location - location type - device associations

get

/connectedWorker/clientapi/v2/projects/{projectId}/locations/{locationId}/typeDevices

This operation retrieves all location - location type - device association for specific location.

Request

Path Parameters

• locationId: integer(int64)
  Location identifier
• projectId: integer(int64)
  Project identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

Location - location type - device associations were successfully retrieved

Body ()

Root Schema : LocationSensorDevices

Type: object

Show Source

• items: array items
• links(optional): array links

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LocationSensorDevice"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object LocationSensorDevice

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LocationSensorDevice"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : LocationSensorDevice

Type: object

Show Source

• deviceId: string
  Id of the device that provides the sensor data. Device must support device model and attribute defined for location type and sensor attribute

  Example: 21E15228-0C54-47E6-AC7F-41A0A8F8D10E
• links(optional): array links
• locationId: integer(int64)
  The unique id of the location in the project

  Example: 52
• locationType: string
  Minimum Length: 0

  Maximum Length: 255

  Pattern: ^\w+$

  Name of the location type. Accepted are alphanumeric characters and underscore, max length is 255 characters

  Example: firstFloor
• projectId: integer(int64)
  The unique id of the project

  Example: 51
• sensorAttribute: string
  Minimum Length: 0

  Maximum Length: 255

  Pattern: ^\w+$

  Name of the sensor attribute. Accepted are alphanumeric characters and underscore, max length is 255 characters

  Example: windowTemperature

{
    "type":"object",
    "required":[
        "deviceId",
        "locationId",
        "locationType",
        "projectId",
        "sensorAttribute"
    ],
    "properties":{
        "locationType":{
            "type":"string",
            "example":"firstFloor",
            "description":"Name of the location type. Accepted are alphanumeric characters and underscore, max length is 255 characters",
            "minLength":0,
            "maxLength":255,
            "pattern":"^\\w+$"
        },
        "sensorAttribute":{
            "type":"string",
            "example":"windowTemperature",
            "description":"Name of the sensor attribute. Accepted are alphanumeric characters and underscore, max length is 255 characters",
            "minLength":0,
            "maxLength":255,
            "pattern":"^\\w+$"
        },
        "deviceId":{
            "type":"string",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E",
            "description":"Id of the device that provides the sensor data. Device must support device model and attribute defined for location type and sensor attribute"
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "example":51,
            "description":"The unique id of the project"
        },
        "locationId":{
            "type":"integer",
            "format":"int64",
            "example":52,
            "description":"The unique id of the location in the project"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Back to Top