Skip to main content

Get Work Order Detail

Support avatar
Written by Support
Updated over 6 months ago

GET [ work-order/details ]

Production Endpoint:  
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/work-order/details

Overview

This endpoint returns the detail of requested Work Orders from the current organisation.


Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user should possess the permissions below:

  • API User

  • User is staff

  • User have View Supplier Permission (minimum)

Please also refer to the Permissions Overview guide.

Query parameters

FIELD

TYPE

DESCRIPTION

EXAMPLE

REQUIRED

DEFAULT

PATTERN

woids

string

Work Order ID (can be multiple with a comma)

253,257

Yes

null

\d+(,\d+)*

Request Example

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/work-order/details?woids=253%2C257' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'

Response Example

The API Request returns a list of staff from the current organisation:

{
"token": "",
"data": {
"StatusCode": 200,
"Message": "Work Order details retrieved successfully.",
"Data": [
{
"CFWOID": 253,
"WONumber" => "WO1",
"WorkRef": "Postman1",
"Type": "Maintenance",
"Description": "Brief description of the work order",
"Priority": "Low",
"WorkOrderActive": false,
"Status": 0,
"LastUpdated": "2025-01-17 15:58:37",
"CompletionDate": "2025-01-01",
"ContractorActivity": [
{
"ActivityID": 1,
"SupplierCompany": "asda123123123123123",
"SupplierABN": "123123123",
"SupplierID": 1554,
"WorkerName": "Worker Shughi",
"WorkerID": 3269,
"SignOutStatus": "Completed",
"Comment": "asd",
"TimeIn": "2025-01-21 17:31",
"TimeOut": "2025-01-22 14:12",
"TotalMinutes": 1241
}
]
},
{
"CFWOID": 257,
"WONumber" => "WO2",
"WorkRef": "Postman2",
"Type": "Maintenance",
"Description": "Brief description of the work order",
"Priority": "Low",
"WorkOrderActive": false,
"Status": 0,
"LastUpdated": "2025-01-20 17:43:00",
"CompletionDate": "2025-01-01",
"ContractorActivity": []
}
]
}
}

Did this answer your question?