Create an alert disposition request

post/alertDispositions/{dispositionId}/request/{domainId}

Creates an alert disposition request, where all alerts are in the same given domain.

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 alert disposition. <= 36 characters
domainId	string	true	Specifies the identifier for the domain. <= 36 characters

Request Body

A disposition request representation.

Name	Type	Required	Description
version	integer	false
alerts	array [alertRep]	false	A full alert representation.
dispositionId	string	false	<= 36 characters
batchId	string	false	<= 36 characters
promptForQueue	boolean	false
queues	array [queueRep]	false	A queue representation.
queueId	string	false	<= 36 characters
defaultSuppressTime	string	false
promptForActivationTime	boolean	false
activationTime	string	false
promptForDocument	boolean	false
documentTypeName	string	false	<= 100 characters
documentTypeLabel	string	false	<= 100 characters
documentTemplateName	string	false	<= 255 characters
documentLabelsIds	object	false
newDocument	boolean	false
documentId	string	false	<= 1000 characters
documentFields	object	false
promptForRelationship	boolean	false
relationshipsLabelsName	object	false
relationshipNames	array [string]	false
promptForScenarioFired	boolean	false
scenarioFiredEvents	array [extendedScenarioFiredEventRep]	false	An extended scenario-fired event representation.
scenarioFiredEventDispositions	array [scenarioFiredEventDispositionRep]	false	A scenario-fired event disposition representation.
promptForSFEReasonFlag	boolean	false
promptForRest	boolean	false
restTemplateName	string	false	<= 100 characters
restFields	object	false
modifiedOverride	boolean	false
user	string	false	<= 255 characters
promptForNoteFlag	boolean	false
dispositionNote	string	false	<= 16000 characters
promptForReasonFlag	boolean	false
dispositionReasonCode	string	false	<= 20 characters
dispositionReasonReferenceTableName	string	false	<= 50 characters
workspacesAndInsightsToCopy	array [number]	false

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	The request was invalid.	Schema
404	Not Found	No resource exists at the requested path.	Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.	Schema