Project Problem Tasks

Get All Project Problem Tasks

This endpoint retrieves a list of Task resources that are applicable to a particular Problem associated with a Project. This endpoint will only return accepted Tasks.

GET /api/v2/projects/{project_id}/problems/{problem_id}/tasks/

URL Parameters

Parameter Description
project_id The id of the applicable Project
problem_id The id of the Problem to retrieve

Query Parameters

The following parameters may be used to filter the Problem Task resources in the response.

Parameter Description
risk_relevant Filter Problem Tasks to those relevant for the Project's risk policy if true and non-relevant for false.
assigned_to Filter Problem Tasks based on who they are assigned to. Expects an email or list of emails for assigned_to__in.
priority Filter Problem Tasks based on the priority of the task.
status Filter Problem Tasks based on task status. Expects task status id (such as TS1)

GET /api/v2/projects/120/problems/120-P1171/tasks/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
    "results": [{
            "id": "120-T1366",
            "task_id": "T1366",
            "title": "Identify applicable compliance regulations",
            "assigned_to": [
                {
                    "id": 1,
                    "email": "admin@example.com",
                    "first_name": "Admin",
                    "last_name": "Testerton",
                    "is_active": true,
                    "role": {
                        "id": "UR4",
                        "name": "Administrator"
                    }
                }],
            "status": "TS2",
            "risk_relevant": false
        }]
}

Expand Parameters

See the Expand Parameters section for more details.

Parameter Description
status Status field is expanded to display information on the Task's status
GET /api/v2/projects/120/problems/120-P1171/tasks/?expand=status HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
    "results": [{
            "id": "120-T1366",
            "task_id": "T1366",
            "title": "Identify applicable compliance regulations",
            "assigned_to": [
                {
                "id": 1,
                "email": "admin@example.com",
                "first_name": "Admin",
                "last_name": "Testerton",
                "is_active": true,
                "role": {
                    "id": "UR4",
                    "name": "Administrator"
                    }
                }],
            "status": {
                "id": "TS2",
                "meaning": "TODO",
                "icon": "clock-o",
                "name": "Incomplete",
                "requires_comment": false,
                "slug": "TODO"
            }
        }]
}

Get a Specific Project Problem's Task

This endpoint retrieves a single Task resource of a particular Problem, as specified by the id parameter. This endpoint will only return accepted Tasks.

GET /api/v2/projects/{project_id}/problems/{problem_id}/tasks/{id}/

URL Parameters

Parameter Description
project_id The id of the Project of the Task
problem_id The id of the applicable Problem
id The id of the Task to retrieve

All of the expand parameters for the 'Get All Project Problem Tasks' endpoint apply here as well.

GET /api/v2/projects/120/problems/120-P1171/tasks/120-T1366/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": "120-T1366",
    "task_id": "T1366",
    "title": "Identify applicable compliance regulations",
    "assigned_to": [
        {
            "id": 1,
            "email": "admin@example.com",
            "first_name": "Admin",
            "last_name": "Testerton",
            "is_active": true,
            "role": {
                "id": "UR4",
                "name": "Administrator"
            }
        }
    ],
    "status": "TS2",
    "risk_relevant": false
}

results matching ""

    No results matching ""