Skip to content
Docs
Select language:English

/api/v1/types/{id} (GET)

GET
/api/v1/types/{id}
curl --request GET \
  --url https://example.com/api/v1/types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
parentId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
builtinKey
required
string | null
name
required
string | null
icon
required
string
colour
required
string | null
capabilities
required
Array<string>
Allowed values: container metered warranty serialized consumable expires
resolvedCapabilities
required
Array<string>
Allowed values: container metered warranty serialized consumable expires
isFieldGroup
required
boolean
fieldGroups
required
Array<string>
copiedFromId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
inUse
required
integer
>= -9007199254740991 <= 9007199254740991
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
archivedAt
required
string | null
fields
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
key
required
string
label
required
string | null
labelKey
required
string | null
kind
required
string
Allowed values: text number date select multi_select boolean url money person vendor file
unit
required
string | null
options
required
Any of:
Array<string>
repeatable
required
boolean
required
required
boolean
secret
required
boolean
sort
required
integer
>= -9007199254740991 <= 9007199254740991
archivedAt
required
string | null
source
required
object
typeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
via
required
string
Allowed values: own inherited group
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
defaultMeter
required
Any of:
object
kind
required
string
unit
required
string
defaultWarrantyMonths
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "capabilities": [
    "container"
  ],
  "resolvedCapabilities": [
    "container"
  ],
  "fields": [
    {
      "kind": "text",
      "source": {
        "via": "own"
      }
    }
  ]
}