online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.workorder.title
View Work Order By External Id
Overview
Retrieve a work order by it's externalid.
URL Format
https://{domain}/api/rest/{clientId}/{versionNumber}/workOrder/view.html?token=XXXXXXXX&userId={userId}&externalId={externalId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: {0}
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
externalId
required
Specified in URL as a parameter, is the ExternalID of the project to be retrieved
userId
optional
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID
Return
Returns a Work Order Object if valid arguments are provided. Returns an error if not a valid request.
Request Body XSD
None
Response Body XSD
Curl Example
HTTP Method: GET
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/workOrder/view.html?token=COJL8X2FKSLMMRTYCH2B&externalId=AA-WO10001"
Response: