GET

Get approval by ID

Returns an approval for a given approval ID.

Request

Path parameters

issueIdOrKey

string

Required
approvalId

string

Required

Responses

Returns the requested approval.

application/json

ApprovalDTO
GET/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 { "id": "<string>", "name": "<string>", "finalDecision": "approved", "canAnswerApproval": true, "approvers": [ { "approver": { "name": "<string>", "key": "<string>", "emailAddress": "<string>", "displayName": "<string>", "active": true, "timeZone": "<string>", "_links": {} }, "approverDecision": "approved" } ], "createdDate": { "iso8601": "<string>", "jira": "<string>", "friendly": "<string>", "epochMillis": 2154 }, "completedDate": { "iso8601": "<string>", "jira": "<string>", "friendly": "<string>", "epochMillis": 2154 }, "_links": { "self": "<string>" }, "condition": { "type": "<string>", "value": "<string>" } }
POST

Answer approval

Answer a pending approval.

Request

Path parameters

issueIdOrKey

string

Required
approvalId

string

Required

Request bodyapplication/json

The decision to make on the approval.

decision

string

comment

string

commentPublic

boolean

Responses

Returns the updated approval.

application/json

ApprovalDTO
POST/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'http://{baseurl}/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "decision": "approve", "comment": "<string>", "commentPublic": true }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 { "id": "<string>", "name": "<string>", "finalDecision": "approved", "canAnswerApproval": true, "approvers": [ { "approver": { "name": "<string>", "key": "<string>", "emailAddress": "<string>", "displayName": "<string>", "active": true, "timeZone": "<string>", "_links": {} }, "approverDecision": "approved" } ], "createdDate": { "iso8601": "<string>", "jira": "<string>", "friendly": "<string>", "epochMillis": 2154 }, "completedDate": { "iso8601": "<string>", "jira": "<string>", "friendly": "<string>", "epochMillis": 2154 }, "_links": { "self": "<string>" }, "condition": { "type": "<string>", "value": "<string>" } }
GET

Get approval comment config

Returns approval comment config for a given approval ID.

Request

Path parameters

issueIdOrKey

string

Required
approvalId

string

Required

Responses

Returns comment config of the requested approval.

application/json

ApprovalCommentConfig
GET/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}/config
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}/config' \ --header 'Accept: application/json'
200Response
1 2 3 4 { "commentsRequiredWhenApprove": true, "commentsRequiredWhenDecline": true }
GET

Get approvals

Returns all approvals on a request, for a given request Id/key.

Request

Path parameters

issueIdOrKey

string

Required

Query parameters

start

number

limit

number

Responses

Returns the requested approval.

application/json

object
GET/servicedeskapi/request/{issueIdOrKey}/approval
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/request/{issueIdOrKey}/approval' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 { "_expands": [ "<string>" ], "size": 1, "start": 0, "limit": 50, "isLastPage": true, "_links": { "base": "<string>", "context": "<string>", "next": "<string>", "prev": "<string>", "self": "<string>" }, "values": [ { "id": "<string>", "name": "<string>", "finalDecision": "approved", "canAnswerApproval": true, "approvers": [ { "approver": {}, "approverDecision": "approved" } ], "createdDate": { "iso8601": "<string>", "jira": "<string>", "friendly": "<string>", "epochMillis": 2154 }, "completedDate": { "iso8601": "<string>", "jira": "<string>", "friendly": "<string>", "epochMillis": 2154 }, "_links": { "self": "<string>" }, "condition": { "type": "<string>", "value": "<string>" } } ] }

Rate this page: