Collections

Create a collection

post/v1/data/{workspace_id}/collections

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Create a collection with the fields shown below. See the Collection object for all fields.

This example creates a data collection at the workspace root. You can also create a folder or create a collection inside a folder with this endpoint.

You can supply createdAt and @id, or let the API generate them. An existing @id returns 400 IntegrityError.

A successful request returns 201 Created with {"@id": "COLLECTION_ID"} and the new object's URL in the Location header.

Request

import requests

url = "https://api.datablist.com/v1/data/workspace_example/collections"

headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

payload = {
    "@type": "Collection",
    "label": "My collection",
    "itemsType": "Person",
    "parents": ["/workspace_example"]
}

response = requests.post(url, headers=headers, json=payload)

print(response.text)

Response · illustrative example

{
  "@id": "collection_example"
}