Get request input

1 min

GET

https://api.app.kognic.com/v2/request-inputs/{requestInputId}

Get a single request input, its status and its current workflow progress by request-input id.

Validation: flexible workflows only (a legacy-workflow request returns 400); returns 404 if the input or its 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:

status is not_started until work begins on the input, completed while it has a valid (non-invalidated) delivery annotation, and in_progress otherwise. A re-correction invalidates the delivery annotation, so an input can go back from completed to in_progress.
progressDetails is 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 progressDetails as null.
progressDetails.currentTask is null when no task is ongoing (for example the last task completed and the input is awaiting a decision).
progressDetails.currentWorkflowStage splits into phase, action and a combined name (for example "Review 1: Correct"). phase.id identifies one phase of this request, while phase.phaseDefinition.id identifies the kind of phase (for example annotate, correct, sampled-review) and is the same for every request and project using that phase type, so it can be used to group inputs across requests. action is absent when the input is between actions — for example waiting for a decision after the phase's last task completed.
progressDetails.availableForIntegrationReview is true only for an input sitting in an integration review phase and awaiting a verdict, that is, one an integration review can be posted for right now. It turns false once the verdict is in, while a rejected input is being corrected, and for every input outside such a phase.
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.
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 holds the production time of the input's current valid delivery annotation and is null whenever status is not completed.

Path Parameters

requestInputIdstring<uuid>required
Format
uuid

Responses

200

Enveloped_RequestInputV2
- dataRequestInputV2required
  - completedAtstring<date-time>
    Description
    When the input's current valid delivery annotation was produced. Set whenever status is completed 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
  - 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
  - progressDetailsInputProgressDetails
    Description
    The input's current workflow progress. Only returned when the caller has access to the input's current phase.
    - availableForIntegrationReviewbooleanrequired
      Description
      Whether an integration review verdict can be posted for the input right now: it sits in an integration review phase and is awaiting a verdict. False for every input outside such a phase.
    - currentTaskCurrentTask
      - assignedUserIdinteger<int64>
        Format
        int64
      - isOngoingbooleanrequired
      - taskIdstring<uuid>required
        Format
        uuid
      - taskTypeTaskTyperequired
    - currentWorkflowStageWorkflowStageV2required
      Description
      The workflow stage an input is currently in. name combines the phase and action names, ex: "Review 1: Correct".
      - actionPhaseAction
        Description
        The action within the phase that the input is currently at.
        idstring<uuid>required
        Format
        uuid
        namestringrequired
      - namestringrequired
      - phasePhaserequired
        Description
        One phase of one request's workflow. Unlike phaseDefinition.id, id is unique to this request.
        idstring<uuid>required
        Format
        uuid
        namestringrequired
        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
  - requestIdstring<uuid>required
    Format
    uuid
  - sceneIdstring<uuid>required
    Format
    uuid
  - statusRequestInputStatusrequired
    Description
    not_started until work begins, completed while a valid delivery annotation exists, in_progress otherwise.

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/v2/request-inputs/{requestInputId}"

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": "",
    "id": "",
    "lastCompletedAnnotationId": "",
    "lastUpdatedAt": "",
    "progressDetails": {
      "availableForIntegrationReview": false,
      "currentTask": {
        "assignedUserId": "",
        "isOngoing": false,
        "taskId": "",
        "taskType": ""
      },
      "currentWorkflowStage": {
        "action": {
          "id": "",
          "name": ""
        },
        "name": "",
        "phase": {
          "id": "",
          "name": "",
          "phaseDefinition": {
            "id": "",
            "name": ""
          }
        }
      }
    },
    "requestId": "",
    "sceneId": "",
    "status": ""
  }
}

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