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

1

Response Samples

1{
2 "version": 1,
3 "dispositionId": "AD_BUILT_IN_CLOSE",
4 "promptForQueue": false,
5 "promptForActivationTime": false,
6 "promptForDocument": false,
7 "documentFields": {},
8 "promptForScenarioFired": false,
9 "promptForRest": false,
10 "restFields": {},
11 "modifiedOverride": false,
12 "promptForNoteFlag": true,
13 "promptForReasonFlag": true,
14 "dispositionReasonReferenceTableName": "DispResn18916327"
15}

Path Parameters

NameTypeRequiredDescription
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.

NameTypeRequiredDescription
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

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

The request was invalid.

Schema
404Not Found

No resource exists at the requested path.

Schema
500Internal Server Error

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

Schema