GET /v3/workflow

List workflows. Return order is by priority.

Acl Action: WORKFLOW list

Arguments:

  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.

Example Response:

{
    "items": [
        {
            "id": "1",
            "uuid": "AAAA-1234",
            "slug": "new",
            "name": "New",
            "status": "1",
            "is_web": "0",
            "is_print": "1",
            "priority": "0",
            "is_content": "1",
            "is_assignment": "1",
            "srn": "srn:tsn:ceo-core\/workflow:AAAA-1234"
        },
        {
            "id": "2",
            "uuid": "BBBB-1234",
            "slug": "to-copy",
            "name": "To Copy",
            "status": "1",
            "is_web": "1",
            "is_print": "1",
            "priority": "1",
            "is_content": "1",
            "is_assignment": "1",
            "srn": "srn:tsn:ceo-core\/workflow:BBBB-1234"
        }
    ],
    "first": 1,
    "before": 1,
    "current": 1,
    "last": 1,
    "next": 1,
    "total_pages": 1,
    "total_items": 2,
    "limit": 50
}

GET /v3/workflow/{uuid}

Get a single workflow item

Acl Action: WORKFLOW get

Example Response:

[
    {
        "id": "1",
        "uuid": "AAAA-1234",
        "slug": "new",
        "name": "New",
        "status": "1",
        "is_web": "0",
        "is_print": "1",
        "priority": "0",
        "is_content": "1",
        "is_assignment": "1",
        "srn": "srn:tsn:ceo-core\/workflow:AAAA-1234"
    }
]

POST /v3/workflow

Create new workflow. Priority works in reverse, so the lower numbers will appear first.

Acl Action: WORKFLOW post

Example Request:

{
    'slug': 'my-workflow',
    'name': 'My workflow'
    'status': 1,
    'is_web': 1,
    'is_print': 0
    'is_content': 1,
    'is_assignment': 1,
    'priority': 10
}

Example Response: See GET /v3/workflow/{uuid}

PUT /v3/workflow/{uuid}

Update workflow.

Acl Action: WORKFLOW update

Example Request: See POST /v3/workflow

Example Response: See POST /v3/workflow

PUT /v3/workflow/priority

Update all workflow priority order. Priority is set according to placement in posted array.

Acl Action: WORKFLOW priority

Arguments:

  • name - type: Description

Example Request:

[
    "AAAA-1234",
    "BBBB-1234",
    "CCCC-1234"
]

Example Response: See GET /v3/workflow

DELETE /v3/workflow/{uuid}[,{uuid}]

Remove one or more workflows.

Acl Action: WORKFLOW delete

Example Response:

{
    "message": "ok"
}