Add an object definition
Learn more about how to create a configuration definition for a specific object type using the Configuration API.
Use the Configuration to create a new configuration definition for a supported object type. This operation requires a JSON payload that contains the new definition.
HTTP method and endpoint
Use the following HTTP method and endpoint paths to submit the request:
POST {TenantURL}/configuration/{objectType}/{typeName}The following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL of your tenant. |
| objectType | Yes, for the general object type endpoint | The configuration object type to create. Supported values for this endpoint are entityTypes, groupTypes, relationTypes, graphTypes, interactionTypes, changeRequestTypes, and categoryTypes.Note: Only one changeRequestType can be configured at a time. |
| typeName | Yes | The name of the type definition to create. |
Request headers
Include the following headers in the request.
| Name | Required | Description |
|---|---|---|
| Authorization | Yes | Access token used to authenticate the tenant request. |
| Content-Type | Yes | application/json |
Example request
The following example creates an Individual entity type definition.
POST {TenantURL}/configuration/entityTypes/Individual
Authorization: <access_token>
Content-Type: application/json
<new configuration definition for the Individual entity type>Example response
The following examples show the response pattern for successful and error outcomes.
Successful response
HTTP/1.1 201 Created
Content-Type: application/json
<created configuration definition>Error response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<BAD_REQUEST>