Work management
Read work-order parts and available operations
GET
/
work-orders
/
{id}
/
parts
Read work-order parts and available operations
curl --request GET \
--url https://api.oncanary.com/v1/work-orders/{id}/parts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.oncanary.com/v1/work-orders/{id}/parts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oncanary.com/v1/work-orders/{id}/parts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"workOrderId": "<string>",
"partStatus": "assigned",
"partAvailability": "available",
"aggregateVersion": "<string>",
"items": [
{
"id": "<string>",
"partId": "<string>",
"locationId": "<string>",
"quantity": 2,
"quantityUsed": 1,
"part": {
"id": "<string>",
"name": "<string>",
"partNumber": "<string>",
"imageUrl": "<string>",
"imageBlur": "<string>",
"archived": true
},
"location": {
"id": "<string>",
"name": "<string>",
"area": "<string>",
"imageUrl": "<string>",
"imageBlur": "<string>"
},
"inStockQuantity": 123,
"availableQuantity": 123,
"readiness": "available",
"linkable": true,
"issuedSnapshot": {
"quantityUsed": 1,
"issuedAt": "2023-11-07T05:31:56Z",
"partName": "<string>",
"partNumber": "<string>",
"locationName": "<string>",
"locationArea": "<string>",
"snapshotKind": "exact",
"unitCost": {
"minor": 123,
"currency": "<string>"
}
},
"unitCost": {
"minor": 123,
"currency": "<string>"
}
}
],
"competingDemands": [
{
"workOrderId": "<string>",
"title": "<string>",
"partId": "<string>",
"locationId": "<string>",
"partStatus": "reserved",
"quantity": 123
}
],
"capabilities": {
"canEditParts": true,
"canRemoveParts": true,
"canTransitionPartStatus": true,
"canRelease": true,
"canOverrideOvercommit": true,
"canReconcile": true,
"canViewCost": true,
"canOverrideUnitCost": true,
"allowedTransitions": [
"assigned"
]
},
"historyOnly": true
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}Authorizations
Organization API key with an sk_live_ or sk_test_ prefix
Path Parameters
Resource ID
Response
Direct section object with effective quantities, costs when authorized, capabilities and aggregate version
Available options:
assigned, reserved, kitted, staged, issued Available options:
available, partial, unavailable Pattern:
^[0-9a-f]{64}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Read work-order parts and available operations
curl --request GET \
--url https://api.oncanary.com/v1/work-orders/{id}/parts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.oncanary.com/v1/work-orders/{id}/parts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oncanary.com/v1/work-orders/{id}/parts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"workOrderId": "<string>",
"partStatus": "assigned",
"partAvailability": "available",
"aggregateVersion": "<string>",
"items": [
{
"id": "<string>",
"partId": "<string>",
"locationId": "<string>",
"quantity": 2,
"quantityUsed": 1,
"part": {
"id": "<string>",
"name": "<string>",
"partNumber": "<string>",
"imageUrl": "<string>",
"imageBlur": "<string>",
"archived": true
},
"location": {
"id": "<string>",
"name": "<string>",
"area": "<string>",
"imageUrl": "<string>",
"imageBlur": "<string>"
},
"inStockQuantity": 123,
"availableQuantity": 123,
"readiness": "available",
"linkable": true,
"issuedSnapshot": {
"quantityUsed": 1,
"issuedAt": "2023-11-07T05:31:56Z",
"partName": "<string>",
"partNumber": "<string>",
"locationName": "<string>",
"locationArea": "<string>",
"snapshotKind": "exact",
"unitCost": {
"minor": 123,
"currency": "<string>"
}
},
"unitCost": {
"minor": 123,
"currency": "<string>"
}
}
],
"competingDemands": [
{
"workOrderId": "<string>",
"title": "<string>",
"partId": "<string>",
"locationId": "<string>",
"partStatus": "reserved",
"quantity": 123
}
],
"capabilities": {
"canEditParts": true,
"canRemoveParts": true,
"canTransitionPartStatus": true,
"canRelease": true,
"canOverrideOvercommit": true,
"canReconcile": true,
"canViewCost": true,
"canOverrideUnitCost": true,
"allowedTransitions": [
"assigned"
]
},
"historyOnly": true
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}{
"type": "https://api.oncanary.com/errors/validation_error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
"code": "validation_error"
}