Get a single request input, its status and its current workflow progress by request-input id.
\nValidation: flexible workflows only (a legacy-workflow request returns 400); returns 404 if the input\nor its request does not exist.
\nAccess: the caller must be a collaborator on the request (owner, producer or reviewer) with a workspace\nrole in the project, otherwise 403.
\nPer-input field availability:
\nstatus is not_started until work begins on the input, completed while it has a valid (non-invalidated)\ndelivery annotation, and in_progress otherwise. A re-correction invalidates the delivery annotation, so an\ninput 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\nproducer sees every phase; a reviewer sees only the phases and actions granted to them, so an input\ncurrently 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\nthe input is awaiting a decision).progressDetails.currentWorkflowStage splits into phase, action and a combined name (for example\n\"Review 1: Correct\"). phase.id identifies one phase of this request, while\nphase.phaseDefinition.id identifies the kind of phase (for example annotate, correct,\nsampled-review) and is the same for every request and project using that phase type, so it can be used\nto group inputs across requests. action is absent when the input is between actions — for example\nwaiting for a decision after the phase's last task completed.progressDetails.availableForIntegrationReview is true only for an input sitting in an integration\nreview phase and awaiting a verdict, that is, one an integration review can be posted for right now. It\nturns false once the verdict is in, while a rejected input is being corrected, and for every input\noutside such a phase.lastCompletedAnnotationId is the judgement produced by the input's most recently completed assignment. It\nis 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\nadded to the request; lastUpdatedAt is its last workflow state change (entering a phase, a task being\ncreated, or completing a phase — not edits inside an ongoing task); completedAt holds the production\ntime of the input's current valid delivery annotation and is null whenever status is not completed.When the input's current valid delivery annotation was produced. Set whenever status is\ncompleted and absent otherwise: a re-correction invalidates the annotation and clears this\nfield, and re-delivery sets it again to a later value. Not a first-delivery audit stamp —\nclients polling for completion must tolerate it reverting to null.
The input's last workflow state change: entering a phase, a task being created for it, or the\ninput completing a phase. Edits made inside an ongoing task do not bump it.
", "format": "date-time" }, { "name": "progressDetails", "kind": "optional", "type": "object", "description": "The input's current workflow progress. Only returned when the caller has access to the input's current phase.", "modelRef": "#/components/schemas/InputProgressDetails", "customType": "InputProgressDetails", "schema": [ { "name": "availableForIntegrationReview", "kind": "required", "type": "boolean", "description": "Whether an integration review verdict can be posted for the input right now: it sits in an\nintegration review phase and is awaiting a verdict. False for every input outside such a\nphase.
" }, { "name": "currentTask", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CurrentTask", "customType": "CurrentTask", "schema": [ { "name": "assignedUserId", "kind": "optional", "type": "integerThe workflow stage an input is currently in. name combines the phase and action names, ex: \"Review 1: Correct\".
One phase of one request's workflow. Unlike phaseDefinition.id, id is unique to this request.
not_started until work begins, completed while a valid delivery annotation exists, in_progress otherwise.
", "modelRef": "#/components/schemas/RequestInputStatus", "customType": "RequestInputStatus", "schema": [] } ] } ], "modelRef": "#/components/schemas/Enveloped_RequestInputV2", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "BadRequest", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/BadRequest", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Unauthorized", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/Unauthorized", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Forbidden", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/Forbidden", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "NotFound", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/NotFound", "isExpanded": true } ] }, { "statusCode": "413", "description": "Payload too large", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "PayloadTooLarge", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/PayloadTooLarge", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "InternalServerError", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/InternalServerError", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "AlcDuDBUr-tpoWy-OH-tj", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.app.kognic.com/v2/request-inputs/{requestInputId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "AlcDuDBUr-tpoWy-OH-tj" }, "results": { "languages": [ { "id": "bxzYzDs_h4QhzCuY8Wtw9", "language": "200", "code": "{\n \"data\": {\n \"completedAt\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"lastCompletedAnnotationId\": \"\",\n \"lastUpdatedAt\": \"\",\n \"progressDetails\": {\n \"availableForIntegrationReview\": false,\n \"currentTask\": {\n \"assignedUserId\": \"\",\n \"isOngoing\": false,\n \"taskId\": \"\",\n \"taskType\": \"\"\n },\n \"currentWorkflowStage\": {\n \"action\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"phase\": {\n \"id\": \"\",\n \"name\": \"\",\n \"phaseDefinition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n },\n \"requestId\": \"\",\n \"sceneId\": \"\",\n \"status\": \"\"\n }\n}" }, { "id": "PXqlNBiRllXkpgxybnn8A", "language": "400", "code": "// Bad request\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "id": "Jh7tyibrUUcDRWsI8hG5C", "language": "401", "code": "// Unauthorized\n{\n \"message\": \"\"\n}" }, { "id": "wDHVhyX9XF02P-FwdGUL8", "language": "403", "code": "// Forbidden\n{\n \"message\": \"\"\n}" }, { "id": "reoa7ksLzBnWNzi67ky7t", "language": "404", "code": "// Not found\n{\n \"message\": \"\"\n}" }, { "id": "TD_UUlUyyCsLYVrDZioJH", "language": "413", "code": "// Payload too large\n{\n \"message\": \"\"\n}" }, { "id": "qn6_vDJsh2FIeZCqaMnYI", "language": "500", "code": "// Internal server error\n{\n \"message\": \"\"\n}" } ], "selectedLanguageId": "bxzYzDs_h4QhzCuY8Wtw9" } }, "children": [ { "text": "" } ] }