List requests

1 min

GET

https://api.app.kognic.com/v2/requests

Query Parameters

projectIdstring<uuid>required
Format
uuid
includeInputProgressCountsboolean
Description
Include per-request input progress counts (notStarted, completed, total). Defaults to false.

Responses

200

Enveloped_Seq_Request
- dataRequest[]
  - createdAtstring<date-time>required
    Format
    date-time
  - externalIdstringrequired
  - idstring<uuid>required
    Format
    uuid
  - inputProgressCountsInputProgressCounts
    - completedinteger<int32>required
      Format
      int32
    - inProgressinteger<int32>required
      Format
      int32
    - notStartedinteger<int32>required
      Format
      int32
    - totalinteger<int32>required
      Format
      int32
  - projectIdstring<uuid>required
    Format
    uuid
  - titlestringrequired

400Bad request

BadRequest
- errorCodestring
- messagestringrequired

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

404Not found

NotFound
- messagestringrequired

python

import requests
import json

url = "https://api.app.kognic.com/v2/requests?projectId=string<uuid>"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
  "data": [
    {
      "createdAt": "",
      "externalId": "",
      "id": "",
      "inputProgressCounts": {
        "completed": "",
        "inProgress": "",
        "notStarted": "",
        "total": ""
      },
      "projectId": "",
      "title": ""
    }
  ]
}

400

// Bad request
{
  "errorCode": "",
  "message": ""
}

401

// Unauthorized
{
  "message": ""
}

403

// Forbidden
{
  "message": ""
}

404

// Not found
{
  "message": ""
}