Requests

List requests

get

Authorizations

Query parameters

pageinteger · min: 1Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

typestring · enumOptional

Search by request type

Possible values:

statestring · enumOptional

Search by request state

Possible values:

createdBystringOptional

reviewedBystringOptional

pendingBystringOptional

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible 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

HTTPcURLJavaScriptPython

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"
      }
    }
  ]
}

Create a request

post

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

HTTPcURLJavaScriptPython

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"
  }
}

Get a request by ID

get

Authorizations

Path parameters

idstringRequired

Id of the request

Query parameters

withInflightbooleanOptional

Include extra inflight information

Default: 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

HTTPcURLJavaScriptPython

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"
  }
}