Requests
Authorizations
Query parameters
pageinteger · min: 1OptionalDefault:
Which page to fetch
1
pageSizeinteger · min: 1 · max: 30OptionalDefault:
Page size to use
30
typestring · enumOptionalPossible values:
Search by request type
statestring · enumOptionalPossible values:
Search by request state
createdBystringOptional
reviewedBystringOptional
pendingBystringOptional
sortBystring · enumOptionalDefault:
Sort by attribute
createdAt
Possible values: sortOrderstring · enumOptionalDefault:
Sort order
asc
Possible values: Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /rest/requests HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"page": 1,
"next": 1,
"prev": 1,
"pageSize": 1,
"total": 1,
"results": [
{
"type": "UPDATE_QUORUM",
"data": {
"quorum": 1
},
"id": "text",
"legacyId": 1,
"state": "INITIAL",
"reviewSteps": [
{
"stageName": "text",
"quorum": 1
}
],
"currentStepIndex": 1,
"expiredAt": "text",
"targetId": "text",
"note": {
"title": "text",
"content": "text"
},
"reviews": [
{
"stepIndex": 1,
"userId": "text",
"status": "PENDING",
"createdAt": "text",
"updatedAt": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"inflight": {
"lastError": "text",
"numFailed": 1,
"retryAfter": "text"
}
}
]
}
Authorizations
Body
requestone ofRequired
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200
Successful response
application/json
Responseone of
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /rest/requests HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"request": {
"type": "UPDATE_QUORUM",
"data": {
"quorum": 1
}
}
}
{
"type": "UPDATE_QUORUM",
"data": {
"quorum": 1
},
"id": "text",
"legacyId": 1,
"state": "INITIAL",
"reviewSteps": [
{
"stageName": "text",
"quorum": 1
}
],
"currentStepIndex": 1,
"expiredAt": "text",
"targetId": "text",
"note": {
"title": "text",
"content": "text"
},
"reviews": [
{
"stepIndex": 1,
"userId": "text",
"status": "PENDING",
"createdAt": "text",
"updatedAt": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"inflight": {
"lastError": "text",
"numFailed": 1,
"retryAfter": "text"
}
}
Authorizations
Path parameters
idstringRequired
Id of the request
Query parameters
withInflightbooleanOptionalDefault:
Include extra inflight information
false
Responses
200
Successful response
application/json
Responseone of
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /rest/requests/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"type": "UPDATE_QUORUM",
"data": {
"quorum": 1
},
"id": "text",
"legacyId": 1,
"state": "INITIAL",
"reviewSteps": [
{
"stageName": "text",
"quorum": 1
}
],
"currentStepIndex": 1,
"expiredAt": "text",
"targetId": "text",
"note": {
"title": "text",
"content": "text"
},
"reviews": [
{
"stepIndex": 1,
"userId": "text",
"status": "PENDING",
"createdAt": "text",
"updatedAt": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"inflight": {
"lastError": "text",
"numFailed": 1,
"retryAfter": "text"
}
}