Provides you a session token that can be used to make requests as a logged in user.
On success the session token will be returned.
{
"sessionToken": "r:ee091a894626a62d9dc09073884d91ba"
}
Invalidates the session token.
On success success message message will be returned in message key.
{
"message": "Successfully logged out"
}
Changes status of your upkeep work order.
On success success message message will be returned in message key. For example if the request was to change status to onHold.
{
"message": "status changed to onHold"
}
Provides all the work orders of user's company.
On success array of work order object will be returned having the keys- id, status, title, description, dueDate, endDueDate, dateCompleted, completedBy,completedById, createdAt, workOrderNo, category, time, cost, assignedBy, assignedById, assignedTo, assignedToId, asset, assetId, location,locationId, team, teamId, requestedBy, requestedById, formItems(array of objects having keys formName, formValue if set) (keys not set will be excluded). Response will be similar to.
[
{
"id": "wfhn43LMh3",
"status": "open",
"title": "Repair sink",
"dueDate": "2016-10-22T01:00:00.000Z",
"createdAt": "2016-10-20T10:17:13.712Z",
"updatedAt": "2016-10-20T10:17:13.712Z",
"endDueDate": "2016-10-20T10:17:13.712Z",
"dateCompleted": "2016-10-20T10:17:13.712Z",
"workOrderNo": "150",
"assignedBy": "abc@xyz.com",
"assignedById": "LfGn43LMh3",
"assignedTo": "def@xyz.com",
"assignedToId": "Lhhn43LMh3",
"completedBy": "def@xyz.com",
"completedById": "Nfhnt3LMh3",
"asset": "printer",
"assetId": "gHhn43LMh3",
"location": "New York",
"locationId": "Kfhn03LMh3",
"category": "Damage",
"cost": "100",
"time": "30",
"team": "Hardware Group",
"teamId": "Prfhn43LML",
"requestedBy": "ghi@xyz.com",
"requestedById": "FfhnFFLMh3",
"formItems": [
{
"formName": "English",
"formValue": "87"
},
{
"formName": "Math",
"formValue": "88"
}
]
}
...
]
Fetches list of Asset items.
On success array of asset objects will be returned with key shown below. Any keys with unset value will be skipped.
[
{
"id": "OTHNmL0szz",
"location": {
"id": "oo8lyqIDG3",
"name": "delhi",
"address": "Delhi, India",
"longitude": 77.22739580000007,
"latitude": 28.6618976
},
"name": "Printer",
"model": "JGT Laser 23",
"barcodeSerial": "Per patch mx",
"parentAssetId": "uPScwR46ra",
"description": "Laser printer",
"isActive": true,
"additionalInformation": "Works fine"
}
...
]
Fetches particular asset by id.
For example to fetch asset with id OTHNmL0szz call will be made to https://api.onupkeep.com/api/public/assets/OTHNmL0szz .On success asset object will be returned with key shown below. Any keys with unset value will be skipped.
{
"id": "OTHNmL0szz",
"location": {
"id": "oo8lyqIDG3",
"name": "delhi",
"address": "Delhi, India",
"longitude": 77.22739580000007,
"latitude": 28.6618976
},
"name": "Printer",
"model": "JGT Laser 23",
"barcodeSerial": "Per patch mx",
"parentAssetId": "uPScwR46ra",
"description": "Laser printer",
"isActive": true,
"additionalInformation": "Works fine"
}
Fetches list of location items.
On success array of location objects will be returned with key shown below. Any keys with unset value will be skipped.
[
{
"id": "oo8lyqIDG3",
"name": "delhi",
"address": "Delhi, India",
"longitude": 77.22739580000007,
"latitude": 28.6618976
}
...
]
Fetches particular location by id.
For example to fetch location with id oo8lyqIDG3 call will be made to https://api.onupkeep.com/api/public/locations/oo8lyqIDG3 .On success asset object will be returned with key shown below. Any keys with unset value will be skipped.
{
"id": "oo8lyqIDG3",
"name": "delhi",
"address": "Delhi, India",
"longitude": 77.22739580000007,
"latitude": 28.6618976
}
Creates new work order.
On success the id(id of the workorder created) and workOrderNo(workorder serial number) will be returned.
{
"id": "MC6CwMlBWL"
"workOrderNo": "165"
}
Creates new workorder request.
On success the id(id of the workorder request created) and title(title of work order) request will be returned.
{
"id": "u6h3J4iaIZ",
"title": "fix system"
}
All the error will have code and message
{
"code": 400
"message": "invalid session token"
}