Skip to content

Issue

Issues are used to help organize planning assignments.

GET /v3/issue

List issues

Acl Action: ISSUE 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.
  • include_archived - string: 1 to include archived issues, 0 to ignore them. Default is 0.

Example Response:

{
    "items": [
        {
            "id": "1",
            "uuid": "AAAA-123",
            "label": "",
            "description": "",
            "status": "1",
            "created_at": "2016-12-07 20:53:09",
            "modified_at": "2017-01-04 21:26:43",
            "published_at": "2016-12-30 05:00:00",
            "srn": "srn:tsn:ceo-core\/issue:AAAA-123",
            "decorated_label": "2016-12-30"
        },
        {
            "id": "2",
            "uuid": "BBBB-123",
            "label": "",
            "description": "",
            "status": "1",
            "created_at": "2016-12-07 20:53:16",
            "modified_at": "2017-01-04 21:26:30",
            "published_at": "2017-01-03 05:00:00",
            "srn": "srn:tsn:ceo-core\/issue:BBBB-123",
            "decorated_label": "2017-01-03"
        }
    ],
    "first": 1,
    "before": 1,
    "current": 1,
    "last": 1,
    "next": 1,
    "total_pages": 1,
    "total_items": 2,
    "limit": 50
}

GET /v3/issue/{uuid}

Fetch a single issue

Acl Action: ISSUE get

Example Response:

[
    {
        "id": "1",
        "uuid": "AAAA-1234",
        "label": "",
        "description": "",
        "status": "1",
        "created_at": "2016-12-07 20:53:09",
        "modified_at": "2017-01-04 21:26:43",
        "published_at": "2016-12-30 05:00:00",
        "srn": "srn:tsn:ceo-core\/issue:AAAA-1234",
        "decorated_label": "2016-12-30"
    }
]

POST /v3/issue

Create new issue.

NOTE Published time is UTC.

Acl Action: ISSUE create

Example Request:

{
    "label": "A test label",
    "description": "My description",
    "status": 1,
    "published_at": "2017-31-12 05:00:00"
}

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

PUT /v3/issue/{uuid}

Update existing issue.

Acl Action: ISSUE update

Example Request: See POST /v3/issue

Example Response: See POST /v3/issue

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

Delete one or more issues.

Acl Action: ISSUE remove

Example Response:

{
    "message": "ok"
}