/api/v1/place-templates

GET

const url = 'https://example.com/api/v1/place-templates?locationId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/place-templates?locationId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Parameters

Query Parameters

locationId

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

200

Default Response

application/json

object

items

required

Array<object>

object

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
object

object

kind

required

string

Allowed values: grid

across

required

number

required

number

kindKey

required

string

compartmentKindKey

required

string

compartmentName

required

string

codePattern

required

string | null

Example

{
  "items": [
    {
      "layout": {
        "kind": "grid"
      }
    }
  ]
}