XLSX

Download data structures as XLSX

post

Downloads data structures matching the provided filters as an XLSX file.

Body

application/json

data_structure_idinteger · nullableOptional

Filter by structure ID

download_typestring · enum · nullableOptional

Type of download (only 'editable' supported)

Possible values:

include_childrenboolean · nullableOptional

Include children structures

Default: false

langstring · nullableOptional

Language for labels

Default: en

note_typestring · enum · nullableOptional

Which note to export

Possible values:

pageinteger · nullableOptional

Page number (unused for download)

querystring · nullableOptional

Full-text search query

sizeinteger · nullableOptional

Page size (unused for download)

structure_url_schemastring · nullableOptional

URL template for structure links

Responses

200

XLSX file download

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string · binaryOptional

204

No data structures available for download

401

Unauthorized

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/data_structures/xlsx/download

HTTPcURLJavaScriptPython

POST /api/data_structures/xlsx/download HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "download_type": "editable",
  "header_labels": {
    "name": "Name",
    "type": "Type"
  },
  "lang": "en",
  "note_type": "published",
  "query": "customer",
  "structure_url_schema": "http://example.com/structures/{id}"
}

binary

Upload data structures from XLSX

post

Uploads an XLSX file to create or update data structures asynchronously.

Body

multipart/form-data

auto_publishbooleanOptional

langstringOptional

structuresstring · binaryRequired

Responses

200

Upload job created

application/json

job_idintegerOptional

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/data_structures/xlsx/upload

HTTPcURLJavaScriptPython

POST /api/data_structures/xlsx/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66

{
  "auto_publish": false,
  "lang": "en",
  "structures": "@structures.xlsx"
}

{
  "job_id": "9731"
}