Skip to content

workspaces_inventory_retrieve

GET
/api/workspaces/{id}/inventory
curl --request GET \
--url 'https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory?delimiter=comma' \
--header 'Authorization: Bearer <token>'

Download the inventory of the data of a workspace, in CSV or TSV.

The inventory lists the data the user sees, one row per data object: the owner of the workspace gets all its data, any other member the data linked to the nodes they belong to. The access given for each data object is the one of the user. The file is streamed, and named after the workspace and the day it is generated.

id
required
string format: uuid

A UUID string identifying this workspace.

delimiter
string
default: comma
Allowed values: comma semicolon tab

The column delimiter. Spreadsheets split the columns of a CSV file on the list separator of the locale: a comma in English, a semicolon where the comma is the decimal separator. A tabulation gives a TSV file.

The inventory, one row per data object, in UTF-8 with a byte order mark. The nodes of a data object share one cell, separated by |, each written as the path of its visible ancestors, separated by /. Sizes are in bytes, and left empty when unknown. Text values that a spreadsheet would read as a formula are prefixed with an apostrophe.

string
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "query_validation_error",
"message": "Invalid query parameters. Check the `details` property for more details.",
"details": [
{
"parameter": "delimiter",
"code": "invalid_choice",
"message": "\"<parameter_value>\" is not a valid choice."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "forbidden",
"message": "You do not have permission to perform this operation. Check the `details` property for more details.",
"details": [
{
"parameter": "workspace",
"code": "not_allowed",
"message": "You are not a member of this workspace."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "object_not_found",
"message": "Object not found. Check the `details` property for more details.",
"details": [
{
"parameter": "<id>",
"code": "does_not_exist",
"message": "\"<id>\" does not exist."
}
]
}