Update a request

1 min

PATCH

https://api.app.kognic.com/v2/requests/{requestId}

Update a request's title, sentToClientPhaseId, isArchived and/or sceneType, with the request identified by its UUID. Fields left out of the body are not changed. Returns 204 No Content on success.

All checks run before any write, and title, sceneType and isArchived are written in one transaction, so a rejected call changes nothing.

Access: the caller must belong to an organization producing the request and hold a workspace Admin, Project Manager or Annotation Manager role on its project, otherwise 403.

Archiving: isArchived: true archives the request's input batch and turns automatic allocation off for the request. isArchived: false reopens an archived input batch, and leaves a batch that isn't archived as it is. Unarchiving does not turn automatic allocation back on.

Scene type: sceneType can only be set while the request has no inputs. Allowed values: lidars_and_cameras, lidars_and_cameras_sequence, cameras, cameras_sequence, aggregated_lidars_and_cameras_sequence.

Errors:

400 when the body sets no field, or sceneType is not one of the allowed values.
400 when isArchived is set and the request shares its input batch with other requests.
400 when sentToClientPhaseId is not a phase of the request's workflow, or the request has a classic workflow.
400 when sceneType is set and the request already has inputs.
403 when the caller may not update the request.
404 when no request has the UUID.
409 when the request's workflow changed while sentToClientPhaseId was being set. The other fields are already written by then; retrying the call is safe.

Path Parameters

requestIdstring<uuid>required
Format
uuid

Body Parameters

bodyPatchRequestrequired
- isArchivedboolean
- sceneTypeSceneType
- sentToClientPhaseIdstring<uuid>
  Format
  uuid
- titlestring

Responses

204

400Bad request

BadRequest
- errorCodestring
- messagestringrequired

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

404Not found

NotFound
- messagestringrequired

409Conflict

Conflict
- messagestringrequired

python

import requests
import json

url = "https://api.app.kognic.com/v2/requests/{requestId}"

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

409

// Conflict
{
  "message": ""
}