Skip to main content
POST
Export an object of the workspace

Authorizations

Authorization
string
header
required

Path Parameters

organization_id
string<uuid>
required

A UUID string identifying the organization.

workspace_id
string<uuid>
required

A UUID string identifying the workspace.

Body

export_type
enum<string>
required

What is exported.

  • search_project - search project
Available options:
search_project
target_id
string
required

Id of the exported object, in the workspace of the URL; for search_project, the Search project.

Maximum string length: 255
format
enum<string>
required

Format of every file in the export.

  • csv - csv
  • xlsx - xlsx
Available options:
csv,
xlsx
params
object
required

What the export needs beside the target; its shape depends on export_type.

Response

Export created in pending status, flow started.

id
string<uuid>
required
read-only
status
enum<string>
required
  • pending - pending
  • in_progress - in progress
  • completed - completed
  • failed - failed
Available options:
pending,
in_progress,
completed,
failed
created_by
string<uuid>
required
created_at
string<date-time>
required
read-only
report_type
enum<string>
  • baseline_report - baseline report
  • export - export
Available options:
baseline_report,
export
url
string | null
Maximum string length: 255
search_project_id
string | null
Maximum string length: 255
workspace_id
string<uuid> | null
name
string | null
Maximum string length: 255
export_type
enum<string> | null
  • search_project - search project
Available options:
search_project,
,
null
target_id
string | null
Maximum string length: 255
analysis
string<uuid> | null