Tasks

Project Tasks are the core object of Aphex Plan - this endpoint will return realtime Task data for a provided query.

Get Tasks

Use this endpoint to query Tasks on a project.

get tasks

get

Get tasks

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Query parameters

startanyOptional

YYYY-MM-DD formatted date

finishanyOptional

YYYY-MM-DD formatted date

shiftanyOptional

day | afternoon | night | 24hr

ownerIdsanyOptional

comma-delimited user IDs

folderIdsanyOptional

comma-delimited folder IDs

packageIdsanyOptional

comma-delimited package IDs

locationIdsanyOptional

comma-delimited location IDs

calendarIdsanyOptional

comma-delimited calendar IDs

subcontractorIdsanyOptional

comma-delimited subcontractor IDs

assignedToIdsanyOptional

comma-delimited user IDs

fieldsanyOptional

comma-delimited additional fields (assignees,wbs,package,parent,contractor,labourResources,plantResources,materialResources,location,workArea,progress,predecessors,successors,externalId,notes)

Header parameters

X-API-KeyanyRequired

access token

Responses

200

OK

application/json

Responseall of

401

Unauthorized

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET //{region}/v1/projects/{projectId}/tasks HTTP/1.1
Host: app.aphex.co
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "assignedTo": [
        {
          "displayName": "text",
          "email": "text",
          "id": "text"
        }
      ],
      "calendar": {
        "id": "text",
        "name": "text",
        "type": "five-day"
      },
      "duration": 1,
      "externalId": "text",
      "finish": "text",
      "folder": {
        "code": "text",
        "id": "text",
        "name": "text",
        "parentId": "text",
        "path": "text"
      },
      "id": "text",
      "keyTask": true,
      "labour": [
        {
          "id": "text",
          "name": "text",
          "quantity": 1
        }
      ],
      "location": {
        "id": "text",
        "name": "text",
        "type": "map"
      },
      "materials": [
        {
          "dailyActual": [
            {
              "date": "text",
              "quantity": 1
            }
          ],
          "dailyPlanned": [
            {
              "date": "text",
              "quantity": 1
            }
          ],
          "id": "text",
          "name": "text",
          "quantity": 1,
          "unit": "text"
        }
      ],
      "name": "text",
      "notes": "text",
      "owner": {
        "displayName": "text",
        "email": "text",
        "id": "text"
      },
      "package": {
        "code": "text",
        "id": "text",
        "name": "text"
      },
      "parent": {
        "id": "text",
        "name": "text"
      },
      "plant": [
        {
          "category": "text",
          "id": "text",
          "name": "text",
          "quantity": 1
        }
      ],
      "progress": [
        {
          "amount": 1,
          "date": "text",
          "name": "text",
          "type": "delay"
        }
      ],
      "relatedTasks": [
        {
          "id": "text",
          "lag": 1,
          "name": "text",
          "relation": "predecessor",
          "type": "start-start"
        }
      ],
      "shift": "day",
      "start": "text",
      "status": "planned",
      "subcontractor": {
        "id": "text",
        "name": "text"
      },
      "workArea": {
        "bbox": [
          1
        ],
        "geometry": null,
        "id": null,
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "text"
      }
    }
  ]
}