Get list of device classes

GET/projects/{projectId}/deviceClasses

Base URL: https://api.tinkermode.com

Get all device classes defined for a project.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user, service account, or project API key.

Path parameters

NameTypeRequiredConstraintsDescription
projectIdintegerYesThe unique ID for a specified project.

Responses

200 List of device classes are returned.

Content type: application/json

Definition of a class of devices made by a project.

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
creationTimestringNoread-only (server-generated); format: date-timeTimestamp of class creation.
descriptionstringYesA short description of the device class.
idstringYesread-only (server-generated); pattern: ^[a-z0-9][a-z0-9_\-]+[a-z0-9]$Device Class ID. Must be unique within the project. Must be 3 or more lowercase alphanumeric characters; dashes ('-') and underscores ('_') may be used after the first character but must be followed by 1+ lowercase alphanumeric characters.

401 Authorization is required to access this resource.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.