developer notes

Get All Job Orders by Site

The JobOrderGetAllBySite API allows you to retrieve All existing Job Order records by Site.

Method	API Endpoint
GET	`{{endpoint}}/api/ext/job-orders`

‍

Headers

‍

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Filter Fields

‍

Parameter	Type	Example	Required	Description
`page`	Number	0	true	Specifies the page number
`perPage`	Number	25	true	Specifies the number of records per page
`startFrom`	Number	0	true	Specifies the start point of the column being sorted
`columnName`	String	id	true	Specifies the name of the column being sorted
`sortOrder`	String	desc/asc	true	Specifies the order in which the column is being sorted
`search`	String	a	true	Specifies the search query
`fromDate`	Date/Time	2023-10-05T02:15:13Z	false	Specifies the from date in search query
`toDate`	Date/Time	2023-10-05T03:15:13Z	false	Specifies the to date in search query
`customerId`	Number	2	false	Specifies the customer ID being filtered
`ticketId`	Number	1	false	Specifies the ticket ID being filtered
`assetId`	Number	2	false	Specifies the asset ID being filtered
`salesOrderId`	Number	3	false	Specifies the Sales Order ID being filtered
`status`	String	OPEN	false	Specifies the status of a task
`joTypeIds`	Number	2	false	Specifies the Job Order Type ID
`JobOrderTypeNames`	String	cext1	false	Specifies the Job Order Type Name
`systems`	***	***	false	System information for filtering
`serviceZoneId`	Number	1	false	Specifies the Service Zone ID
`faultId`	Number	12	false	Specifies the Fault ID
`fault`	String	Faulty Part	false	Specifies the Fault
`resolution`	String	Fixed on Site	false	Specifies the Resolution
`roleId`	Number	3	false	Specifies the Role ID
`faultNotEmpty`	***	***	false	Specifies if only filtered for Job orders with a fault
`systemNotEmpty`	***	***	false	Specifies if only filtered for Job orders with a system
`siteId`	Number	1	false	Specifies the Site ID
`projectId`	Number	5	false	Specifies the Project ID
`pmvId`	Number	3	false	Specifies the PMV ID
`checkListRecordId`	Number	1	false	Specifies the Checklist Record ID
`origin`	String	a	false	Origin information for filtering

‍

API Query Example

‍

Method	API Call
GET	`api/ext/job-orders?origin=f&startFrom=0&perPage=25&columnName=id&sortOrder=asc&search=a&fromDate=&toDate&customerId=2&ticketId&assestId&salesOrderId&status&joTypeIds&jobOrderTypeNames&systems&serviceZoneId&faultId&fault&resolution&fetchOnlyOverDueJobOrders&roleId&faultNotEmpty&systemNotEmpty&siteId&projectId&pmvId&checkListRecordId`