Profiles

Get service profiles

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Query parameters
spidstring · min: 4 · max: 4Optional

Service Profile ID (SPID)

Example: 000APattern: \b[0-9A-F]{4}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/profile/service/{hid}

Get object profile templates

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Query parameters
pidstring · min: 4 · max: 4Optional

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/profile/object/template/{hid}

Get object profiles

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/profile/object/{hid}

Create an object profile

post
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Body
uiLayoutstringOptional
Responses
post
/api/engine/v3/profile/object/{hid}

Update an object profile

patch
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Body
uiLayoutstringOptional
Responses
200

Default Response

application/json
patch
/api/engine/v3/profile/object/{hid}

Get object profile

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/profile/object/{hid}/{pid}

Delete an object profile

delete
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b
Responses
200

Default Response

application/json
delete
/api/engine/v3/profile/object/{hid}/{pid}

Get used object profiles

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/profile/object/used/{hid}

Last updated

Was this helpful?