Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
exports

Api Export Jobs Partial Update 2

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)
patch/api/export-jobs/{id}/

Path parameters

idinteger required

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

namestring
status'pending' | 'processing' | 'paused' | 'completed' | 'failed' | 'cancelled'
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
export_format'csv' | 'json' | 'jsonl'
  • csv - Csv
  • json - Json
  • jsonl - Jsonl
{"stackTrail":"components:schemas:PatchedExportJobDetailRequest:properties:query_params","oasType":"schema","type":"unknown","description":"Any type"}
{"stackTrail":"components:schemas:PatchedExportJobDetailRequest:properties:post_params","oasType":"schema","type":"unknown","description":"Any type"}
list_typestring
source_workflow_version_idstring nullable

Response

idinteger required
projectstring nullable required
namestring
created_atstring date-time required
updated_atstring date-time required
status'pending' | 'processing' | 'paused' | 'completed' | 'failed' | 'cancelled'
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
export_format'csv' | 'json' | 'jsonl'
  • csv - Csv
  • json - Json
  • jsonl - Jsonl
export_check_point_atstring date-time nullable required
exported_chunk_countinteger required
export_progress_percentagenumber double required
estimated_entry_countinteger required
exported_record_countinteger required
{"stackTrail":"components:schemas:ExportJobDetail:properties:query_params","oasType":"schema","type":"unknown","description":"Any type"}
{"stackTrail":"components:schemas:ExportJobDetail:properties:post_params","oasType":"schema","type":"unknown","description":"Any type"}
celery_task_idstring required
list_typestring
failed_reasonstring required
warningsobject[] required
generated_sqlstring required
dispatch_generationinteger required
source_workflow_version_idstring nullable
userinteger nullable required