Skip to navigation

Create data type

View as Markdown

Creates a data type and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this data type refers to must already exist.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
friendly_namestringRequired3-64 characters

User-friendly display name for the data type (3 to 64 characters).

descriptionstringRequired3-256 characters

Description of what the data type represents (3 to 256 characters).

schemaobjectRequired
JSON schema for one instance of the data type. Required.
resolution_strategyobjectRequired
Default resolution strategy used to resolve values of this data type. Required.
versionobjectRequired
Document version. On update, send back the num from your last read.
system_usage_configobjectOptional
Controls which fields the assistant sees and uses for citations and identification.

Response

The created data type
idstringOptionalRead-only
Unique identifier of the data type, assigned by the server. Cannot be changed.
namestringOptionalRead-onlyformat: "^u_[A-Z][A-Za-z0-9]+$"5-32 characters

Type name derived from friendly_name on create, in the format u_PascalCase (for example, Purchase Order becomes u_PurchaseOrder). Read-only.

friendly_namestringOptional3-64 characters

User-friendly display name for the data type (3 to 64 characters).

descriptionstringOptional3-256 characters

Description of what the data type represents (3 to 256 characters).

schemaobjectOptional
JSON schema for one instance of the data type. Required.
resolution_strategyobjectOptional
Default resolution strategy used to resolve values of this data type. Required.
system_usage_configobjectOptional
Controls which fields the assistant sees and uses for citations and identification.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.
type_idstringOptionalRead-only
Value other resources store to reference this data type, such as a slot's type.custom. Assigned by the server and different in each tenant.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error