Skip to navigation

Custom Attributes (Entities)

View as Markdown

platform.entities

Custom user attributes.

  • Endpoint: /platform/entities | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/platform/entitiesGet custom attribute entities
PATCH/platform/entitiesUpdate custom attribute entities

Fields

FieldTypeRequiredNotes
registrationsarray<DataModelRegistration>Custom attributes registered for each data model.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"registrations": [
{
"data_model": "USER",
"attributes": [
{
"name": "example-name",
"data_sensitivity": {
"customer_data": "CUSTOMER_DATA_UTTERANCE"
},
"item_ref": "<string>"
}
],
"item_ref": "<string>"
}
]
}