v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB

Workflows

Create workflow

Creates workflow by specified parameters.

post/api/v2/teams/{team_slug}/workflows

Path parameters

team_slugstring required

Team's sluggified name

Request body

namestring required

Example request

{
  "stages": [
    {
      "assignable_users": [
        {
          "stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "config": {
        "allowed_property_ids": [
          "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        ],
        "annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
      },
      "edges": [
        {
          "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "source_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "target_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ]
}

Response

WorkflowsV2.Workflow.Workflow

idstring uuid nullable required

A unique identifier for a workflow

inserted_atstring required

namestring required

team_idinteger required

thumbnailsstring[] required

List of thumbnails urls

updated_atstring required

work_batch_requestedboolean nullable

Whether there is a pending request for more work for the current user and this workflow. This field is experimental and may be removed without notice.

Example response

{
  "dataset": {
    "id": 123
  },
  "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "stages": [
    {
      "assignable_users": [
        {
          "stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "config": {
        "allowed_property_ids": [
          "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        ],
        "annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
      },
      "edges": [
        {
          "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "source_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "target_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ]
}