Skip to content
Docs
Select language:English

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

PATCH
/api/v1/place-templates/{id}
curl --request PATCH \
  --url https://example.com/api/v1/place-templates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "layout": { "kind": "grid", "across": 1, "up": 1 }, "kindKey": "example", "compartmentKindKey": "example", "compartmentName": "example", "codePattern": "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
layout
One of:
object
kind
required
string
Allowed values: grid
across
required
integer
>= -9007199254740991 <= 9007199254740991
up
required
integer
>= -9007199254740991 <= 9007199254740991
kindKey
string
/^[a-z][a-z0-9_]{0,39}$/
compartmentKindKey
string
/^[a-z][a-z0-9_]{0,39}$/
compartmentName
string
>= 1 characters <= 120 characters
codePattern
Any of:
string
>= 1 characters <= 100 characters
locationIds
Array<string>
>= 1 items <= 100 items

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
layout
required
Any of:
object
kind
required
string
Allowed values: grid
across
required
number
up
required
number
kindKey
required
string
compartmentKindKey
required
string
compartmentName
required
string
codePattern
required
string | null
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
Example
{
  "layout": {
    "kind": "grid"
  }
}