Survivorship groups for relation types
Learn more about how to retrieve and create survivorship groups for a relation type using the Configuration API.
Use the Configuration to retrieve survivorship groups for a relation type, retrieve a specific survivorship group, and create a new survivorship group. 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 all survivorship groups for the specified relation type.
GET {TenantURL}/configuration/relationTypes/{relationshipTypeName}/survivorshipGroups?inheritance=true|falsePOST creates a new survivorship group definition for the specified relation type.
POST {TenantURL}/configuration/relationTypes/{relationshipTypeName}/survivorshipGroups/{groupUri}PUT updates the specified survivorship group definition for the relation type.
PUT {TenantURL}/configuration/relationTypes/{relationshipTypeName}/survivorshipGroups/{groupUri}The following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL of your tenant. |
| relationshipTypeName | Yes | The name of the relation type whose survivorshipGroups sub-resource you want to retrieve or update. |
| groupUri | Yes, for group-specific GET and POST | The URI of the survivorship group to retrieve or 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, for POST and 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 all survivorshipGroups for the HasAddress relation type and includes inherited configuration.
GET {TenantURL}/configuration/relationTypes/HasAddress/survivorshipGroups?inheritance=true
Authorization: <access_token>The following example creates the PrimaryAddressGroup survivorship group for the HasAddress relation type.
POST {TenantURL}/configuration/relationTypes/HasAddress/survivorshipGroups/PrimaryAddressGroup
Authorization: <access_token>
Content-Type: application/json
<new survivorship group definition>The following example updates the PrimaryAddressGroup survivorship group for the HasAddress relation type.
PUT {TenantURL}/configuration/relationTypes/HasAddress/survivorshipGroups/PrimaryAddressGroup
Authorization: <access_token>
Content-Type: application/json
<updated survivorship group definition>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
<survivorship group definition or list of survivorship groups>Successful POST response
HTTP/1.1 201 Created
Content-Type: application/json
<created survivorship group definition>Successful PUT response
HTTP/1.1 202 Accepted
Content-Type: application/json
<updated survivorship group definition>Other error response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<TYPE_IS_NOT_FOUND or BAD_REQUEST>