Skip to main content

Set Review State

Change the state of a review result.

GET https://instance.securid.com/aveksa/command.submit?cmd=setReviewState

Request

Parameters

setReviewState
format

properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.

json - Useful format for parsing into javascript or other languages. See www.json.org for details.

The id of the review result.
The state to set for the review. Valid values :
  • onhold
  • active
  • completed

Headers

Bearer token
Acceptapplication/json
Content-Typeapplication/json

Response

Parameters

typeExecuted command name
nameThe name of the review.
statussuccess or failure.
messageOptional message to return along with the status.

Examples

Request

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=setReviewState&id=1&state=active" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Response

{
"data": {
"type": "setReviewState",
"status": "success",
"name": "UAR-3"
}
}
Feedback