---
title: "Start Export job"
method: POST
path: "/job/export"
tags: ["job"]
---

# Start Export job

`POST /job/export`

## Request body

- ExportJobInput
  - `project_id` integer, 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
  - `specific_export_job_parameters` union, required — Specific parameters for the export job w.r.t it's type
    - ExportSelectedSdocsParams
      - `export_job_type` 'SELECTED_SDOCS', required
      - `sdoc_ids` integer[], required — IDs of the source documents to export
    - ExportSelectedSpanAnnotationsParams
      - `export_job_type` 'SELECTED_SPAN_ANNOTATIONS', required
      - `span_annotation_ids` integer[], required — IDs of the span annotations to export
    - ExportSelectedSentenceAnnotationsParams
      - `export_job_type` 'SELECTED_SENTENCE_ANNOTATIONS', required
      - `sentence_annotation_ids` integer[], required — IDs of the sentence annotations to export
    - ExportSelectedBboxAnnotationsParams
      - `export_job_type` 'SELECTED_BBOX_ANNOTATIONS', required
      - `bbox_annotation_ids` integer[], required — IDs of the bbox annotations to export
    - ExportSelectedMemosParams
      - `export_job_type` 'SELECTED_MEMOS', required
      - `memo_ids` integer[], required — IDs of the memos to export
    - ExportSelectedWhiteboardsParams
      - `export_job_type` 'SELECTED_WHITEBOARDS', required
      - `whiteboard_ids` integer[], required — IDs of the whiteboards to export
    - ExportSelectedTimelineAnalysesParams
      - `export_job_type` 'SELECTED_TIMELINE_ANALYSES', required
      - `timeline_analysis_ids` integer[], required — IDs of the timeline analyses to export
    - ExportSelectedCotaParams
      - `export_job_type` 'SELECTED_COTA', required
      - `cota_ids` integer[], required — IDs of the cota to export

## Response `200`

Successful Response

- ExportJobRead
  - `job_id` string, required — RQ job ID
  - `job_type` string, required — Type of the job
  - `project_id` integer, required — Project ID associated with the job
  - `status` 'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled', required
  - `status_message` string, nullable — Status message
  - `current_step` integer, required — Current step in the job process
  - `steps` string[], required — Total number of steps in the job process
  - `input` ExportJobInput, required
    - `project_id` integer, 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
    - `specific_export_job_parameters` union, required — Specific parameters for the export job w.r.t it's type
      - ExportSelectedSdocsParams
        - `export_job_type` 'SELECTED_SDOCS', required
        - `sdoc_ids` integer[], required — IDs of the source documents to export
      - ExportSelectedSpanAnnotationsParams
        - `export_job_type` 'SELECTED_SPAN_ANNOTATIONS', required
        - `span_annotation_ids` integer[], required — IDs of the span annotations to export
      - ExportSelectedSentenceAnnotationsParams
        - `export_job_type` 'SELECTED_SENTENCE_ANNOTATIONS', required
        - `sentence_annotation_ids` integer[], required — IDs of the sentence annotations to export
      - ExportSelectedBboxAnnotationsParams
        - `export_job_type` 'SELECTED_BBOX_ANNOTATIONS', required
        - `bbox_annotation_ids` integer[], required — IDs of the bbox annotations to export
      - ExportSelectedMemosParams
        - `export_job_type` 'SELECTED_MEMOS', required
        - `memo_ids` integer[], required — IDs of the memos to export
      - ExportSelectedWhiteboardsParams
        - `export_job_type` 'SELECTED_WHITEBOARDS', required
        - `whiteboard_ids` integer[], required — IDs of the whiteboards to export
      - ExportSelectedTimelineAnalysesParams
        - `export_job_type` 'SELECTED_TIMELINE_ANALYSES', required
        - `timeline_analysis_ids` integer[], required — IDs of the timeline analyses to export
      - ExportSelectedCotaParams
        - `export_job_type` 'SELECTED_COTA', required
        - `cota_ids` integer[], required — IDs of the cota to export
  - `output` ExportJobOutput
    - `results_url` string, nullable — URL to download the results when done.
  - `created` string, date-time, required — Created timestamp of the job
  - `finished` string, date-time, nullable — Finished timestamp of the job

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api.md) · [All operations](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uhh-lt/discourse-analysis-tool-suite-api/revisions/6fcf6b0bc28a/schema)