gb | au
OK
Not Found
Unprocessable Entity
Internal Server Error
POST /{region}/v1/auth/token HTTP/1.1
Host: app.aphex.co/
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"clientId": "text",
"clientSecret": "text"
}{
"accessToken": "text",
"expiresIn": "text",
"tokenType": "text"
}gb | au
OK
Not Found
Unprocessable Entity
Internal Server Error
POST /{region}/v1/auth/token/revoke HTTP/1.1
Host: app.aphex.co/
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"clientId": "text",
"clientSecret": "text",
"token": "text"
}textgb | au
projectId
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
GET /{region}/v1/projects/{projectId}/users HTTP/1.1
Host: app.aphex.co/
Accept: */*
{
"paging": {
"next": {
"after": "text",
"link": "text"
}
},
"results": [
{
"displayName": "text",
"email": "text",
"id": "text"
}
]
}gb | au
projectId
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
GET /{region}/v1/projects/{projectId}/subcontractors HTTP/1.1
Host: app.aphex.co/
Accept: */*
{
"paging": {
"next": {
"after": "text",
"link": "text"
}
},
"results": [
{
"id": "text",
"name": "text"
}
]
}gb | au
projectId
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
GET /{region}/v1/projects/{projectId}/folders HTTP/1.1
Host: app.aphex.co/
Accept: */*
{
"paging": {
"next": {
"after": "text",
"link": "text"
}
},
"results": [
{
"code": "text",
"id": "text",
"name": "text",
"parentId": "text",
"path": "text"
}
]
}gb | au
projectId
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
GET /{region}/v1/projects/{projectId}/packages HTTP/1.1
Host: app.aphex.co/
Accept: */*
{
"paging": {
"next": {
"after": "text",
"link": "text"
}
},
"results": [
{
"code": "text",
"id": "text",
"name": "text"
}
]
}gb | au
projectId
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
GET /{region}/v1/projects/{projectId}/calendars HTTP/1.1
Host: app.aphex.co/
Accept: */*
{
"paging": {
"next": {
"after": "text",
"link": "text"
}
},
"results": [
{
"id": "text",
"name": "text",
"type": "five-day"
}
]
}gb | au
projectId
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
GET /{region}/v1/projects/{projectId}/locations HTTP/1.1
Host: app.aphex.co/
Accept: */*
{
"paging": {
"next": {
"after": "text",
"link": "text"
}
},
"results": [
{
"id": "text",
"name": "text",
"type": "map"
}
]
}gb | au
projectId
YYYY-MM-DD formatted date
YYYY-MM-DD formatted date
day | afternoon | night | 24hr
comma-delimited user IDs
comma-delimited folder IDs
comma-delimited package IDs
comma-delimited location IDs
comma-delimited calendar IDs
comma-delimited subcontractor IDs
comma-delimited user IDs
comma-delimited additional fields (assignees,wbs,package,parent,contractor,labourResources,plantResources,materialResources,location,workArea,progress,predecessors,successors,externalId,notes)
access token
OK
Unauthorized
Unprocessable Entity
Internal Server Error
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"
}
}
]
}