v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Case Management

List case links

Returns all links associated with a case. Links define relationships (for example, BLOCKS) between cases. Requires entity_type and entity_id query parameters.

get/api/v2/cases/link

Query parameters

entity_typestring required

Example:CASE

The entity type to look up links for. Use CASE to find links for a specific case.

entity_idstring required

Example:bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f

The UUID of the entity to look up links for.

relationshipstring

Example:BLOCKS

Optional filter to only return links of a specific relationship type (for example, BLOCKS or CAUSES).

Response

Example response

{
  "data": [
    {
      "attributes": {
        "child_entity_id": "4417921d-0866-4a38-822c-6f2a0f65f77d",
        "child_entity_type": "CASE",
        "parent_entity_id": "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
        "parent_entity_type": "CASE",
        "relationship": "BLOCKS"
      },
      "id": "804cd682-55f6-4541-ab00-b608b282ea7d",
      "type": "link"
    }
  ]
}