Update pre-annotation judgement for request input

1 min

PATCH

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

Set the pre-annotation judgement for a request input, used to seed annotation work from an existing judgement. Returns 204 No Content on success.

Access: the caller must hold a workspace Admin, Developer or Project Manager role on the input's project, otherwise 403. Returns 404 if the input does not exist.

Body validation:

preAnnotationJudgementId is required. Omitting it (null) returns 400: this endpoint cannot unset a pre-annotation.
The referenced judgement must exist, otherwise 404.
The input must have no completed or live in-progress work, otherwise 400. Discarded work does not count: an expired in-progress assignment, or work on a task that was deleted (e.g. by a request reset), still allows the pre-annotation to be (re)set.

Path Parameters

requestInputIdstring<uuid>required
Format
uuid

Body Parameters

bodyUpdateRequestInputrequired
- preAnnotationJudgementIdstring<uuid>
  Format
  uuid

Responses

204

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

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

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

print(response.text)

204

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