Get an alert disposition request

get/alertDispositions/{dispositionId}/request

Returns an alert disposition request for a given disposition.

Request Samples

Response Samples

1{
2  "version": 1,
3  "alerts": [
4    {
5      "alertId": "3b723e69-75ef-44df-a7dc-74b583bdfccd",
6      "modifiedTimeStamp": "2024-04-25T08:20:55.968Z"
7    },
8    {
9      "alertId": "19bd856c-4611-475b-8314-8d38faeccc9e",
10      "modifiedTimeStamp": "2024-04-25T08:21:12.345Z"
11    }
12  ],
13  "dispositionId": "AD_BUILT_IN_CLOSE",
14  "promptForQueue": false,
15  "promptForActivationTime": false,
16  "promptForDocument": false,
17  "documentFields": {},
18  "promptForScenarioFired": false,
19  "promptForRest": false,
20  "restFields": {},
21  "modifiedOverride": false,
22  "promptForNoteFlag": true,
23  "dispositionNote": "Example disposition note",
24  "promptForReasonFlag": true,
25  "dispositionReasonCode": "REPLACE_WITH_CODE",
26  "dispositionReasonReferenceTableName": "DispResn18916327"
27}

Path Parameters

dispositionId
string
true

Specifies the identifier of the disposition.

<= 36 characters

Query Parameters

alertId
string
false

Specifies the identifier of the alert.

<= 36 characters
alertIdMultiple
array [string]
false

Specifies a list of alert identifiers for which to retrieve the disposition request.

domainId
string
false

Specifies the identifier of the domain.

<= 36 characters

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema
404Not Found

No disposition exists at the requested path.

Schema
500Internal Server Error

The request could not be fulfilled because of an unexpected server error.

Schema