UHuhh-lt
job

Start Export job

Changed on
post/job/export

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

Request body

project_idinteger required

Project ID associated with the job

export_job_type'ALL_DATA' | 'ALL_USERS' | 'ALL_SDOCS' | 'ALL_CODES' | 'ALL_TAGS' | 'ALL_FOLDERS' | 'ALL_SPAN_ANNOTATIONS' | 'ALL_SENTENCE_ANNOTATIONS' | 'ALL_BBOX_ANNOTATIONS' | 'ALL_MEMOS' | 'ALL_PROJECT_METADATA' | 'ALL_WHITEBOARDS' | 'ALL_TIMELINE_ANALYSES' | 'ALL_COTA' | 'SELECTED_SDOCS' | 'SELECTED_SPAN_ANNOTATIONS' | 'SELECTED_SENTENCE_ANNOTATIONS' | 'SELECTED_BBOX_ANNOTATIONS' | 'SELECTED_MEMOS' | 'SELECTED_WHITEBOARDS' | 'SELECTED_TIMELINE_ANALYSES' | 'SELECTED_COTA' required

Response

Successful Response

job_idstring required

RQ job ID

job_type'export' required

Type of the job

project_idinteger required

Project ID associated with the job

status'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required
status_messagestring nullable

Status message

current_stepinteger required

Current step in the job process

stepsstring[] required

Total number of steps in the job process

createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job

Changes

  • 3bdfd02830b1Revision changes
    • warning

      added the new export enum value to the response property for the response status

    • info

      the response property const value export was added for the status

  • bd1187f3520eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status