Using work order batch processing
Rather than integrating the various endpoints of the Field Services API, it is also possible to send batches of work orders so that they can be analysed quickly and without the constraints of a Rest API integration.

Format

To use batch processing, it is necessary to respect the format defined below.
  • An archive containing all the data must be uploaded to a server whose address is specified by your Customer Success Manager.
  • The archive should implement the following tree structure with one folder per work order. All images and files containing metadata and parameters for each work order should then be stored within each of these folders.
1
.
2
├── WO_123456/
3
│ ├── metadata.json
4
│ ├── parameters.json
5
│ ├── task-group-name-A_0.jpg
6
│ ├── task-group-name-A_1.jpg
7
│ ├── task-group-name-B_0.jpg
8
│ ├── ...
9
│ └── task-group-name-X_0.jpg
10
├── WO_789123/
11
│ ├── metadata.json
12
│ ├── parameters.json
13
│ ├── task-group-name-A_0.jpg
14
│ ├── task-group-name-B_0.jpg
15
│ ├── task-group-name-B_1.jpg
16
│ ├── ...
17
│ └── task-group-name-X_0.jpg
18
19
├── ...
20
21
└── WO_456789/
22
├── metadata.json
23
├── parameters.json
24
├── task-group-name-A_0.jpg
25
├── task-group-name-B_0.jpg
26
├── task-group-name-B_1.jpg
27
├── ...
28
└── task-group-name-X_0.jpg
29
Copied!

Naming conventions

  • The name of each directory must correspond to a unique id that identifies the intervention.
  • Each image should be named according to the task group to which it relates with an incremental index in case there are several images for the same task group (the task group corresponds to the type of the image).
  • The metadata.json and parameters.json files are JSON files containing dictionaries with all the information as specified on your application page on the Deepomatic platform. If no metadata or parameters are required according to the information available on the application page, then there is no need to include the corresponding empty file or files.
However, the analysis of the work order will not be possible if the parameters file does not contain all the required information as specified on the Deepomatic platform.
Copy link