Work order management
A work order in Deepomatic corresponds to the set of elementary tasks that must be performed by a field worker.
Last updated
Was this helpful?
A work order in Deepomatic corresponds to the set of elementary tasks that must be performed by a field worker.
Last updated
Was this helpful?
A task in this context refers to a specific checkpoint that can be validated via the Deepomatic application. Tasks are grouped into task groups, which we can consider as a type of photo requested from the field workers. The list of task groups therefore corresponds to the list of photos that a field worker must take during an intervention.
Here you can find the different endpoints to create, update and delete work orders. Open each card to learn more.
Every Deepomatic application is versioned. We recommend to not integrate any logic based on the tasks and task groups ids as those ids changes when a version is upgraded. You can instead use tasks and task groups names that are agnostic to version changes.
POST https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/
Authorization*
string
Deepomatic API Key associated to your account.
name*
string
Name of the work order. Only letters, numbers, underscores and hyphens are accepted for the name.
The name is limited to 128 characters maximum.
It recommended to set a unique name per work order. If your system keeps track of work orders, it is also recommended to use your internal work order id as a name.
metadata
object
When a metadata is not available, it is not necessary to include the field in the request.
The metadata must be sent as a key-value object, otherwise a 400 error will be generated.
tags
array
List of tags attached to your work order. These tags make it possible to group work orders according to your own logic.
field_engineer_email
string
Email of the field engineer assigned to the work order.
For analytics purposes, it is recommended to assign a specific field engineer to a work order.
Warning: the API will only accept engineers that have a Deepomatic account.
user_group_ids
array
List of user group assigned to the work order. User groups allow you to define the group(s) associated to a specific work order.
To retrieve the list of user_group_ids, please contact your CSM.
work_order_types
array
List of work order types. Work order types allow you to filter the tasks of a work order at the time of its creation to activate only the relevant tasks for the intervention.
Response format
progress_score - number (between 0 and 100) : completion state of the work order computed based on the tasks included in the conformity score.
Only letters, numbers, underscores and hyphens are accepted for the name.
The name is limited to 128 characters maximum.
PATCH https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/
id*
string
Id of the work order to update This id corresponds to the id returned in the create a work order API response.
Authorization*
string
Deepomatic API Key associated to your account.
name
string
Override work order name
metadata
object
Override work order metadata
tags
array
Override work order tags
field_engineer_email
string
Add or override a field engineer
Warning: the API will only accept engineers that have a Deepomatic account.
user_group_ids
array
List of user group assigned to the work order. User groups allow you to define the group(s) associated to a specific work order.
To retrieve the list of user_group_ids, please contact your CSM.
work_order_types
array
Override work order types
Response format
progress_score - number (between 0 and 100) : completion state of the work order computed based on the tasks included in the conformity score.
DELETE https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/
id*
string
Id of the work order to delete This id corresponds to the id returned in the create a work order API response.
Authorization*
string
Deepomatic API Key associated to your account.
Dictionary to set metadata to a work order. Metadata let you store custom data on a per work order basis. Metadata can be used in the but also to filter the work orders on our monitoring platform.
To retrieve the list of metadata to be provided for your application, please refer to the .
Warning: this requires that work order types have been configured beforehand. To retrieve the list of work order types configured, please refer to the .
To retrieve the list of metadata to be provided for your application, please refer to the .