Skip to content

Setup a collection using a template

Background

For classification (and interpretation) you need to set-up a collection correctly with workflows, columns and fields.

Note: To be able to classify an item after setting up a collection follow the steps how to upload an item but set collection_id instead of workflow_id. This way you are uploading an item to the collection and aiida will move the item to item to it's correct workflow.

Setup a collection

Step 1: Create a collection

POST ‚Äč/collections

Body parameters

Parameter Comment
name Name of the collection
workspace_id Workspace UUID

Example

{
  "name": "string",
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Step 2: Setup a collection using a template

Setting up a collection using a template is the preferred method if that's a possibility. Setting up a collection using a template will create workflows, columns and fields with their correct settings.

POST /apply_template

Body parameters

Parameter Comment
collection_id UUID of the collection
template_name Use 'type-a'. Creates workflows "Supplier invoices" and "Reminders". This also has fields "Your References" and "Our Reference".

Example

{
  "collection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "template_name": "type-a"
}