Create alert action

post/alerts/{alertId}/alertActions/{actionType}

Creates an alert action to perform on an alert. The valid action types are CHECKOUT, CHECKIN, ASSIGNMENT and REACTIVATE. Any other action type results in a 'Bad Request' HTTP status.

Request Samples

1

Response Samples

1{
2  "alertId": "exampleAlertId",
3  "actionType": "CHECKOUT",
4  "user": "exampleUser"
5}

Path Parameters

NameTypeRequiredDescription
actionType
string
true

Specifies the type of action to perform.

Allowed values:
CHECKOUTCHECKINASSIGNMENTREACTIVATE
alertId
string
true

Specifies the identifier of the alert.

<= 36 characters

Query Parameters

NameTypeRequiredDescription
leaveCheckedOutToUserForReactivate
boolean
false

Specifies whether to leave the alert checked out, if a user has it checked out.

Default:
false

Request Body

An action request representation.

NameTypeRequiredDescription
version
integer
false
alertId
string
false
<= 36 characters
actionType
string
false
Allowed values:
CHECKOUTCHECKINASSIGNMENTREACTIVATE
user
string
false
<= 255 characters

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

The request was invalid.

Schema