List request inputs

1 min

GET

https://api.app.kognic.com/v1/request-inputs

List a request's inputs together with their current workflow progress, optionally narrowed to a single scene via sceneId.

Validation: only requests on flexible workflows are supported. A legacy-workflow request returns 400, and a 404 is returned if the request does not exist.

Access: the caller must be a collaborator on the request (owner, producer or reviewer) with a workspace role in the project, otherwise 403.

Per-input field availability:

workflowStage and currentTask are populated only when the caller has access to the input's current phase/action. A producer sees every phase; a reviewer sees only the phases and actions granted to them, so an input currently sitting in a phase they cannot see returns both fields as null. currentTask is also null when no task is ongoing (for example the last task completed and the input is awaiting a decision).
workflowStage.phaseDefinition identifies the kind of phase the input is currently in (for example annotate, correct, sampled-review). Its id is the same for every request and project using that phase type, so it can be used to group inputs across requests. workflowStage.requestPhaseId, by contrast, identifies one phase instance of one request. phaseDefinition is always present whenever workflowStage is.
lastCompletedAnnotationId is the judgement produced by the input's most recently completed assignment. It is null until at least one task has completed and is not access-gated.
deliveryReady is true once a non-invalidated delivery annotation exists for the input; it is always present.
createdAt, lastUpdatedAt and completedAt are never access-gated. createdAt is when the input was added to the request; lastUpdatedAt is its last workflow state change (entering a phase, a task being created, or completing a phase — not edits inside an ongoing task); completedAt mirrors deliveryReady and holds the production time of the input's current valid delivery annotation. Because a re-correction invalidates that annotation, completedAt can return to null and later be set again to a higher value — do not treat it as a first-delivery stamp.

Query Parameters

requestIdstring<uuid>required
Description
The request whose inputs to list
Format
uuid
sceneIdstring<uuid>
Description
Optional scene filter; when set, only the input for that scene is returned
Format
uuid

Responses

200

Enveloped_Seq_RequestInput
- dataRequestInput[]
  - completedAtstring<date-time>
    Description
    When the input's current valid delivery annotation was produced. Set whenever deliveryReady is true and absent otherwise: a re-correction invalidates the annotation and clears this field, and re-delivery sets it again to a later value. Not a first-delivery audit stamp — clients polling for completion must tolerate it reverting to null.
    Format
    date-time
  - createdAtstring<date-time>required
    Description
    When the input was added to the request. Not the scene's own creation time.
    Format
    date-time
  - currentTaskCurrentTask
    - assignedUserIdinteger<int64>
      Format
      int64
    - isOngoingbooleanrequired
    - taskIdstring<uuid>required
      Format
      uuid
    - taskTypeTaskTyperequired
  - deliveryReadybooleanrequired
  - idstring<uuid>required
    Format
    uuid
  - lastCompletedAnnotationIdstring<uuid>
    Format
    uuid
  - lastUpdatedAtstring<date-time>required
    Description
    The input's last workflow state change: entering a phase, a task being created for it, or the input completing a phase. Edits made inside an ongoing task do not bump it.
    Format
    date-time
  - requestIdstring<uuid>required
    Format
    uuid
  - sceneIdstring<uuid>required
    Format
    uuid
  - workflowStageWorkflowStage
    - namestringrequired
    - phaseActionIdstring<uuid>
      Format
      uuid
    - phaseDefinitionPhaseDefinitionrequired
      Description
      The phase type of a workflow stage. The id is the same for every request and project using this kind of phase.
      - idstring<uuid>required
        Format
        uuid
      - namestringrequired
    - requestPhaseIdstring<uuid>required
      Format
      uuid

400Bad request

BadRequest
- errorCodestring
- messagestringrequired

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

404Not found

NotFound
- messagestringrequired

413Payload too large

PayloadTooLarge
- messagestringrequired

500Internal server error

InternalServerError
- messagestringrequired

python

import requests
import json

url = "https://api.app.kognic.com/v1/request-inputs?requestId=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": [
    {
      "completedAt": "",
      "createdAt": "",
      "currentTask": {
        "assignedUserId": "",
        "isOngoing": false,
        "taskId": "",
        "taskType": ""
      },
      "deliveryReady": false,
      "id": "",
      "lastCompletedAnnotationId": "",
      "lastUpdatedAt": "",
      "requestId": "",
      "sceneId": "",
      "workflowStage": {
        "name": "",
        "phaseActionId": "",
        "phaseDefinition": {
          "id": "",
          "name": ""
        },
        "requestPhaseId": ""
      }
    }
  ]
}

400

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

401

// Unauthorized
{
  "message": ""
}

403

// Forbidden
{
  "message": ""
}

404

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

413

// Payload too large
{
  "message": ""
}

500

// Internal server error
{
  "message": ""
}