Case Links ​

Create ​

The section below describes how to call the Create Case Link endpoint.

How to use ​

To call the endpoint you will need to perform a HTTP POST request to the URL:

Request ​

The following properties pertain to creation of a case link.

Example Request ​

{
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string"
}

Example Response ​

The case link object will be returned if succesfully created.

{
  "id": "string",
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string",
  "active": true,
  "creationDate": "2024-01-24T00:00:00.000Z",
  "lastUpdatedDate": "2024-01-24T00:00:00.000Z"
}

Get Case Links ​

The section below describes how to call the Get Case Links endpoint.

How to use ​

To call the endpoint you will need to perform a HTTP GET request to the URL:

Pagination Options ​

There are two pagination options that can be provided in the query string.

• PageNumber
  
• PageSize
  

The page size is the number of results we wish to return per page. The page size has a range of 1-1000. The page number is the zero-based index of the page we wish to return.

Example Response ​

The case link object will be returned if succesfully created.

{
  "caseLinksResults": [
    {
      "id": "string",
      "companyId": 0,
      "caseId": "string",
      "linkedCaseId": "string",
      "linkTypeId": "string",
      "notes": "string",
      "active": true,
      "creationDate": "2024-01-24T14:49:05.718Z",
      "lastUpdatedDate": "2024-01-24T14:49:05.718Z"
    }
  ],
  "totalCount": 0,
  "pageCount": 0
}

Get Case Link ​

The section below describes how to call the Get Case Links endpoint.

How to use ​

To call the endpoint you will need to perform a HTTP GET request to the URL:

Example Get Case Link Response ​

{
  "id": "string",
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string",
  "active": true,
  "creationDate": "2024-01-24T14:59:42.346Z",
  "lastUpdatedDate": "2024-01-24T14:59:42.346Z"
}

Update Case Link ​

The section below describes how to call the PUT Case Link endpoint. This endpoint allows for updates to a case link.

How to use ​

To call the endpoint you will need to perform a HTTP PUT request to the URL:

On a successful update, the updated case link will be returned.

Example Request ​

{
  "id": "string",
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string",
  "active": true
}

Example Response ​

{
  "id": "string",
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string",
  "active": true,
  "creationDate": "2024-01-24T15:01:21.888Z",
  "lastUpdatedDate": "2024-01-24T15:01:21.888Z"
}

Update Case Link State ​

The section below describes how to call the PATCH Case Link state endpoint. This endpoint allows for updates to the state of a case link.

How to use ​

To call the endpoint you will need to perform a HTTP PATCH request to the URL:

On a successful update, the updated case link will be returned.

Example Request ​

{
  "id": "string",
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string",
  "active": true
}

Example Response ​

{
  "id": "string",
  "caseId": "string",
  "linkedCaseId": "string",
  "linkTypeId": "string",
  "notes": "string",
  "active": true,
  "creationDate": "2024-01-24T15:01:21.888Z",
  "lastUpdatedDate": "2024-01-24T15:01:21.888Z"
}

Link Types ​

This section describes how to interact with the link types for case links.

Get Link Types ​

The section below describes how to call the Get Case Link Types endpoint.

How to use ​

To call the endpoint you will need to perform a HTTP GET request to the URL:

LinkTypeIds ​

This endpoint can also take a list of link type ids as a parameter, which allows for retrieval of only specified link types.

Example Get Case Link Types Response ​

{
  "linkTypes": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "sourceCaseRole": "string",
      "linkedCaseRole": "string",
      "validSourceCaseTypes": [
        "Person"
      ],
      "validLinkedCaseTypes": [
        "Person"
      ],
      "creationDate": "2024-01-24T15:09:15.989Z",
      "lastUpdatedDate": "2024-01-24T15:09:15.989Z"
    }
  ]
}