Skip to content
Docs
Select language:English

/api/v1/templates/{id} (PATCH)

PATCH
/api/v1/templates/{id}
curl --request PATCH \
  --url https://example.com/api/v1/templates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "payload": { "name": "example", "brandId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "model": "example", "colour": "example", "quantity": "example", "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "aliases": { "additionalProperty": [ "example" ] }, "notes": "example", "custom": { "additionalProperty": "example" } }, "locationIds": [ "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)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 80 characters
typeId
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)$/
payload
object
name
string
>= 1 characters <= 200 characters
brandId
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)$/
model
string
>= 1 characters <= 120 characters
colour
string
>= 1 characters <= 60 characters
quantity
string
/^\d{1,9}(\.\d{1,3})?$/
tagIds
Array<string>
<= 50 items
aliases
object
key
additional properties
Array<string>
<= 20 items
notes
string
>= 1 characters <= 5000 characters
custom
object
key
additional properties
locationIds
Array<string>
>= 1 items <= 100 items
Examplegenerated
{
  "name": "example",
  "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "payload": {
    "name": "example",
    "brandId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "model": "example",
    "colour": "example",
    "quantity": "example",
    "tagIds": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "aliases": {
      "additionalProperty": [
        "example"
      ]
    },
    "notes": "example",
    "custom": {
      "additionalProperty": "example"
    }
  },
  "locationIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

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)$/
name
required
string
typeId
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)$/
typeIcon
required
string | null
payload
required
object
key
additional properties
locations
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)$/
name
required
string
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "typeIcon": "example",
  "payload": {
    "additionalProperty": "example"
  },
  "locations": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example"
    }
  ],
  "rowVersion": 1
}