API ReferenceEvaluations

Api Annotation Items Partial Update

PATCH handler with superadmin lock and field protection.

Checks:

  1. Object lock (is_managed=True -> non-superadmins can’t modify)
  2. Field protection (non-superadmins can’t modify specific fields)

Authentication

AuthorizationBearer
JWT access token or Respan API key

Request

This endpoint expects an object.
idstringOptional1-255 characters
source_idstringOptional1-255 characters
source_typeenumOptional
  • logs - Logs
  • dataset_logs - Dataset Logs
  • threads - Threads
source_dataset_idstring or nullOptional<=255 characters
statusenumOptional
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
evaluator_idslist of stringsOptional
List of evaluator IDs that define which scoring criteria the assignee should fill out
completed_atdatetime or nullOptional

Response

source_idstring<=255 characters
source_typeenum
  • logs - Logs
  • dataset_logs - Dataset Logs
  • threads - Threads
assigneeobject
created_byobject
created_atdatetimeRead-only
idstring<=255 characters
source_dataset_idstring or null<=255 characters
statusenum
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
evaluator_idslist of strings
List of evaluator IDs that define which scoring criteria the assignee should fill out
completed_atdatetime or null