List thing-type definitions

GEThttp://spectra.dev.aerovy.com/v2/definitions/thing-types

Returns a paginated list of thing-type definition indices for the calling organization. Requires an API key with the read action.

Loading code example

Loading code example

Authorizations

apiKeystringheaderrequired

API key passed in the header.

continuationTokenstring

Opaque token from a prior page; omit for the first page.

pageLimitinteger | string<int32>

Page size (1–100). Omit to use the service default.

Pattern: ^-?(?:0|[1-9]\d*)$

statusstringdefault: active

Filter by lifecycle status: `active` (default), `deleted`, or `all`.

Default: "active"

application/json

A page of thing-type definition indices.

itemsarray<object>

items.thingTypeIdstring

Stable identifier for the thing type (the index id).

items.displayNamestring

Human-readable name for the thing type.

items.descriptionstring

Description of the thing type.

items.defaultImageUrlnull | string

Optional URL of a default image for devices of this type.

items.defaultIconUrlnull | string

Optional URL of a default icon for devices of this type.

items.latestThingTypeDefIdnull | string

Identifier of the latest definition version this index points to.

items.latestVersionNumberinteger | string<int32>

Version number of the latest definition.

Pattern: ^-?(?:0|[1-9]\d*)$

items.versionsarray<object>

The full version history for this thing type.

items.isDeletedboolean

Whether this thing type has been soft-deleted.

items.createdAtstring<date-time>

Timestamp (UTC) when the thing type was created.

items.updatedAtnull | string<date-time>

Timestamp (UTC) when the thing type was last updated.

items.createdBystring

Identifier of the actor that created the thing type.

items.updatedBynull | string

Identifier of the actor that last updated the thing type.

continuationTokennull | string

hasMoreboolean