Assignments are objects that collect content together and can be assigned to multiple users with issues and due dates.

GET /v3/assignment

List assignments

Acl Action: ASSIGNMENT list

Arguments:

  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to modified_at.
  • dir - string: Either asc or desc.

Example Response:

{
    "items": [
        {
            "id": "5",
            "uuid": "AAAAAAAA-1234-4567-7890-BBBBBBBBBBBB",
            "slug": "some-slug",
            "type": "article",
            "title": "A title",
            "abstract": "",
            "content": "<p>something<\/p>",
            "notes": "",
            "created_at": "2016-12-15 21:12:28",
            "modified_at": "2017-02-16 22:01:21",
            "published_at": null,
            "due_at": "2016-12-30 05:00:00",
            "creator_id": "1",
            "issue_id": "2",
            "srn": "srn:tsn:ceo-core\/assignment:AAAAAAAA-1234-4567-7890-BBBBBBBBBBBB",
            "children": [],
            "issue": {
                ...
            },
            "lock": {
                ...
            },
            "users": [
                ...
            ]
        },
        ...
    ],
    "first": 1,
    "before": 1,
    "current": 1,
    "last": 1,
    "next": 1,
    "total_pages": 1,
    "total_items": 5,
    "limit": 50
}

GET /v3/assignment/{assignment-uuid}

Get single assignment.

Acl Action: ASSIGNMENT get

Example Response:

{
    "id": "5",
    "uuid": "AAAAAAAA-1234-4567-7890-BBBBBBBBBBBB",
    "slug": "some-slug",
    "type": "article",
    "title": "A title",
    "abstract": "",
    "content": "<p>something<\/p>",
    "notes": "",
    "created_at": "2016-12-15 21:12:28",
    "modified_at": "2017-02-16 22:01:21",
    "published_at": null,
    "due_at": "2016-12-30 05:00:00",
    "creator_id": "1",
    "issue_id": "2",
    "srn": "srn:tsn:ceo-core\/assignment:AAAAAAAA-1234-4567-7890-BBBBBBBBBBBB",
    "children": [],
    "issue": {
        ...
    },
    "lock": {
        ...
    },
    "users": [
        ...
    ]
}

POST /v3/assignment

Create new assignment item.

Acl Action: ASSIGNMENT create

Example Request:

{
    "slug": "some-slug",
    "type": "article",
    "title": "A title",
    "content": "<p>something<\/p>",
    "published_at": null,
    "due_at": "2016-12-30 05:00:00",
    "issue_id": "2",
    "children": [
        "UUUUUUUU-1234-4567-7890-BBBBBBBBBBBB",
        "OOOOOOOO-1234-4567-7890-BBBBBBBBBBBB"
    ],
    "users": [
        "PPPPPPPP-1234-4567-7890-BBBBBBBBBBBB"
    ]
}

PUT /v3/assignment/{assignment-uuid}

Update existing assignmment. Exclusive lock is required to update an assignment.

Acl Action: ASSIGNMENT update

Example Request: See POST /v3/assignment

Example Response: See POST /v3/assignment

DELETE /v3/assignment/{assignment-uuid}

Delete an assignment. Exclusive lock is required to delete an assignment.

Acl Action: ASSIGNMENT delete

Example Response:

{
    "message": "ok"
}