Surrogate crosswalks for entity types
Learn more about how to retrieve, update, and delete surrogate crosswalks for an entity type using the Configuration API.
Use the Configuration to retrieve, update, and delete the surrogateCrosswalks sub-resource for an entity type. By default, GET responses include inherited configuration. To exclude inherited configuration, set the inheritance query parameter to false.
HTTP methods and endpoints
Use one of the following HTTP methods and endpoint paths to submit the request:
GET retrieves the surrogateCrosswalks definition for the specified entity type.
GET {TenantURL}/configuration/entityTypes/{entityTypeName}/surrogateCrosswalks?inheritance=true|falsePUT updates the surrogateCrosswalks definition for the specified entity type.
PUT {TenantURL}/configuration/entityTypes/{entityTypeName}/surrogateCrosswalksDELETE deletes the surrogateCrosswalks definition for the specified entity type.
DELETE {TenantURL}/configuration/entityTypes/{entityTypeName}/surrogateCrosswalksThe following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL of your tenant. |
| entityTypeName | Yes | The name of the entity type whose surrogateCrosswalks sub-resource you want to retrieve, update, or delete. |
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, for PUT | application/json |
Query parameters
The following table describes the query parameters.
| Name | Required | Description |
|---|---|---|
| inheritance | No, for GET | Determines whether inherited configuration from base types is included in the response. Accepted values are true and false. Default: true. |
Example requests
The following example retrieves the surrogateCrosswalks sub-resource for the Individual entity type and includes inherited configuration.
GET {TenantURL}/configuration/entityTypes/Individual/surrogateCrosswalks?inheritance=true
Authorization: <access_token>The following example updates the surrogateCrosswalks sub-resource for the Individual entity type.
PUT {TenantURL}/configuration/entityTypes/Individual/surrogateCrosswalks
Authorization: <access_token>
Content-Type: application/json
<updated surrogateCrosswalks definition>The following example deletes the surrogateCrosswalks sub-resource for the Individual entity type.
DELETE {TenantURL}/configuration/entityTypes/Individual/surrogateCrosswalks
Authorization: <access_token>Example responses
The following examples show the response pattern for successful and error outcomes.
Successful GET response
HTTP/1.1 200 OK
Content-Type: application/json
<surrogateCrosswalks definition>Successful PUT response
HTTP/1.1 200 OK
Content-Type: application/json
<updated surrogateCrosswalks definition>Successful DELETE response
HTTP/1.1 204 No ContentError response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<TYPE_IS_NOT_FOUND or VALIDATION_ERROR>