Jump to

• Request
• Response

Get a specific sensor attribute within location type.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/locationTypes/{typeId}/sensorAttributes/{sensorAttributeId}

This operation retrieves a specific sensor attribute within location type.

Request

Path Parameters

• orgId: string
  Organization identifier
• sensorAttributeId: string
  Param that identifies sensor attribute in location 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

Specific sensor attribute in location type was successfully retrieved.

Body ()

Root Schema : SensorAttribute

Type: object

Show Source

• dataType: string
  Allowed Values: [ "BOOLEAN", "DATETIME", "INTEGER", "NUMBER", "STRING", "URI" ]

  Data type for the sensor attribute

  Example: STRING
• description(optional): string
  Detailed description of sensor attribute
• displayName(optional): string
  User readable name for sensor attribute
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• name: 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
• sensorAttribute(optional): string
  Read Only: true

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

  Example: windowTemperature
• typeId: string
  Id of the type

  Example: 123
• unit(optional): string
  Unit of measurements for sensor attribute

{
    "required":[
        "dataType",
        "name",
        "typeId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "typeId":{
            "type":"string",
            "description":"Id of the type",
            "example":"123"
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "pattern":"^\\w+$",
            "type":"string",
            "description":"Name of the sensor attribute. Accepted are alphanumeric characters and underscore, max length is 255 characters",
            "example":"windowTemperature"
        },
        "sensorAttribute":{
            "type":"string",
            "description":"Name of the sensor attribute. Accepted are alphanumeric characters and underscore, max length is 255 characters",
            "readOnly":true,
            "example":"windowTemperature",
            "deprecated":true
        },
        "dataType":{
            "type":"string",
            "description":"Data type for the sensor attribute",
            "example":"STRING",
            "enum":[
                "BOOLEAN",
                "DATETIME",
                "INTEGER",
                "NUMBER",
                "STRING",
                "URI"
            ]
        },
        "description":{
            "type":"string",
            "description":"Detailed description of sensor attribute"
        },
        "unit":{
            "type":"string",
            "description":"Unit of measurements for sensor attribute"
        },
        "displayName":{
            "type":"string",
            "description":"User readable name for sensor attribute"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

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