Returns all attribute definitions for a robot

Returns all attribute definitions for a robot. They are normally the same as the attribute definitions for the account it belongs to, except the case when configuration overrides have been defined for the robot.

GET /robots/{robotId}/attributeDefinitions

Returns all attribute definitions for a robot

cURL

curl --request GET \
  --url https://api.inorbit.ai/robots/{robotId}/attributeDefinitions \
  --header 'x-auth-inorbit-app-key: <api-key>'

200

[
  {
    "id": "<string>",
    "label": "<string>",
    "mapping": {
      "source": "<string>",
      "key": "<string>",
      "topic": "<string>",
      "namespace": "<string>"
    }
  }
]

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

robotId · string · required

The robot's id

Response

200

application/json

A list with all attributes definitions

id · string · required

Attribute id

label · string · required

User-defined label

mapping · object

Defines the mapping from a robot data source

Show child attributes