> For the complete documentation index, see [llms.txt](https://developer.ultimo.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.ultimo.net/api-key-templates/jobs/fleet-jobs.md).

# Fleet jobs

This template can help you create an API to integrate Fleet jobs. The template contains all relevant entities and properties of a fleet job (**context 16384 in table 'Job'**). 

All relations from 'Job' to another entity have minimum read access to the 'Description'. This way you can easily receive the right information. Below is an overview of all entities, properties and filters of this template.

Additional entities, properties and filters can be added, which may be missing from the template but are necessary for your process. All entities can be found through the 'Entity overview' in the customisation tool of IFS Ultimo (consult application administrator or consultant).

## Entities and properties

<table><thead><tr><th width="367">Entity</th><th>Properties</th></tr></thead><tbody><tr><td>Job</td><td><p>Id</p><p>Description</p><p> </p><p>Context</p><p>CostCenter<br>Customer</p><p>Department</p><p>Equipment</p><p>Employee</p><p>EquipmentType</p><p>Failtype</p><p>Feedbacktext</p><p>Incident</p><p>Priority</p><p>Processfunction</p><p>ProgressStatus</p><p>ReportForeignKeyEmployee</p><p>ReportText</p><p>ScheduledStartDate</p><p>ServiceContract</p><p>ServiceContractTargetFinishedDate</p><p>ServiceContractTargetResponseDate</p><p>Site</p><p>SkillCategory</p><p>Space</p><p>Status</p><p>StatusActiveDate</p><p>StatusCreateReportDate</p><p>StatusFinishDate</p><p>TargetDate</p><p>Text</p><p>Vendor</p><p>WorkorderType</p><p></p><p>ExternalId</p><p>DataProvider</p></td></tr><tr><td>CostCenter</td><td>Description</td></tr><tr><td>Customer</td><td>Description</td></tr><tr><td>Department</td><td>Description</td></tr><tr><td>Employee</td><td>Description</td></tr><tr><td>Equipment</td><td><p>Description</p><p>Site</p><p>EquipmentType</p><p>Serialnumber</p><p>ExternalId</p></td></tr><tr><td>EquipmentType</td><td>Description</td></tr><tr><td>Failtype</td><td>Description</td></tr><tr><td>Incident</td><td>Description</td></tr><tr><td>Priority</td><td>Description</td></tr><tr><td>ProcessFunction</td><td>Description<br>Site</td></tr><tr><td>ProgressStatus</td><td>Description</td></tr><tr><td>ServiceContract</td><td>Description</td></tr><tr><td>Site</td><td>Description</td></tr><tr><td>SkillCategory</td><td>Description</td></tr><tr><td>Space</td><td>Description<br>RoomNumber</td></tr><tr><td>Vendor</td><td>Description</td></tr><tr><td>WorkorderType</td><td>Description</td></tr></tbody></table>

### Filters

| Entity          | Filter property name | Operator |   Value  |
| --------------- | -------------------- | :------: | :------: |
| Job             | Context              |     =    |   16384  |
| Job             | Status               |    IN    | 1,2,4,16 |
| Costcenter      | Context              |     =    |     1    |
| Costcenter      | Status               |     =    |     2    |
| Customer        | Context              |     =    |     1    |
| Customer        | Status               |    >=    |     0    |
| Department      | Context              |     =    |     1    |
| Department      | Status               |    >=    |     0    |
| Employee        | Context              |     =    |     1    |
| Employee        | Status               |    >=    |     0    |
| Equipment       | Context              |     =    |     8    |
| Equipment       | Status               |     =    |     2    |
| EquipmentType   | Context              |     =    |    16    |
| EquipmentType   | Status               |    >=    |     0    |
| Failtype        | Context              |     =    |    64    |
| Failtype        | Status               |    >=    |     0    |
| Incident        | Context              |     =    |     1    |
| Incident        | Status               |    >=    |     0    |
| Priority        | Context              |     =    |     1    |
| Priority        | Status               |    >=    |     0    |
| ProcessFunction | Context              |     =    |     4    |
| ProcessFunction | Status               |     =    |     1    |
| ProgressStatus  | Context              |     =    |     8    |
| ProgressStatus  | Status               |    >=    |     0    |
| ServiceContract | Context              |     =    |    128   |
| ServiceContract | Status               |    >=    |     0    |
| Site            | Context              |     =    |     1    |
| Site            | Status               |    >=    |     0    |
| Skillcategory   | Context              |     =    |     1    |
| Skillcategory   | Status               |    >=    |     0    |
| Space           | Context              |     =    |     1    |
| Space           | Status               |    >=    |     0    |
| Vendor          | Context              |     =    |     1    |
| Vendor          | Status               |    >=    |     0    |
| Workordertype   | Context              |     =    |    64    |
| Workordertype   | Status               |    >=    |     0    |

## Change job status

For changing a job status we provide a 'POST' action that triggers a workflow in Ultimo. Below is an overview of all properties of this workflow. It's by default only possible to change jobs that comply with filters of entity 'Job', as described above. When those filters changed, this also applied to this workflow.&#x20;

| **Property**                  | **Accessor** |
| ----------------------------- | ------------ |
| JobId                         | Optional     |
| ExternalId                    | Optional     |
| ProgressStatus                | Required     |
| Date                          | Required     |
| Employee                      | Required     |
| Text                          | Optional     |
| Hours                         | Optional     |
| Hourcode                      | Optional     |
| HourTariffCategory            | Optional     |
| EquipmentProgressStatus       | Optional     |
| EquipmentProgressStatusRemark | Optional     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.ultimo.net/api-key-templates/jobs/fleet-jobs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.