Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

SearchRelatedItems

Searches for related items that are associated with a case.

Note

If no filters are provided, this returns all related items associated with a case.

Request Syntax


POST /domains/domainId/cases/caseId/related-items-search HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

caseId

A unique identifier of the case.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

domainId

The unique identifier of the Cases domain.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

Request Body

The request accepts the following data in JSON format.

filters

The list of types of related items and their parameters to use for filtering.

Type: Array of RelatedItemTypeFilter objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

maxResults

The maximum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 9000.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "associationTime": "string",
         "content": { ... },
         "performedBy": { ... },
         "relatedItemId": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The token for the next set of results. This is null if there are no more results to return.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 9000.

relatedItems

A list of items related to a case.

Type: Array of SearchRelatedItemsResponseItem objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ResourceNotFoundException

We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

resourceId: Unique identifier of the resource affected.
resourceType: Type of the resource affected.

HTTP Status Code: 404

ThrottlingException

The rate has been exceeded for this API. Please try again after a few minutes.

HTTP Status Code: 429

ValidationException

The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400

Examples

Request and Response example

This example illustrates one usage of SearchRelatedItems.


{
  "maxResults": 25,
  "filters": [
  {
    "contact": {
      "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]"
      }
    }
  ]
}


{
  "nextToken": null,
  "relatedItems": [
    {
    "associationTime": "2022-06-06T18:59:09.865709Z",
    "content": {
      "contact": {
      "channel": "CHAT",
      "connectedToSystemTime": "2022-06-08T18:57:50.558897Z",
      "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]"
      }
    },
  "relatedItemId": "[relatedItem_id]",
  "tags": {},
  "type": "Contact"
   }
  ]
}