Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Project Archive

3 endpoints3 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/data_exportsList project data exports
  2. POST /rest/v1.0/projects/{project_id}/data_exportsCreate (generate) a data export
  3. GET /rest/v1.0/projects/{project_id}/data_exports/{id}Show a data export
GET /rest/v1.0/projects/{project_id}/data_exports

List project data exports

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • tool_scope
    string[]required
  • status
    stringrequired
  • translated_status
    stringrequired
  • file_url
    string
  • requested_by_id
    integerrequired
  • requested_by
    object
  • created_at
    stringrequired
  • completed_at
    string
POST /rest/v1.0/projects/{project_id}/data_exports

Create (generate) a data export

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • tool_scope
    string[]required
  • status
    stringrequired
  • translated_status
    stringrequired
  • file_url
    string
  • requested_by_id
    integerrequired
  • requested_by
    object
  • created_at
    stringrequired
  • completed_at
    string
GET /rest/v1.0/projects/{project_id}/data_exports/{id}

Show a data export

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • tool_scope
    string[]required
  • status
    stringrequired
  • translated_status
    stringrequired
  • file_url
    string
  • requested_by_id
    integerrequired
  • requested_by
    object
  • created_at
    stringrequired
  • completed_at
    string

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file