Iris API Reference
Start typing to search…

Create overlay

post
https://iris.trackunit.com/api/service-management/v2/plans//overlay

Create overlay on the specified service plan. The overlay will only have effect on your own usage of the service plan.

Path Params
uuid
required

ID of service plan.

Body Params
serviceCriteriaOverlays
array of objects
required
length ≥ 1
serviceCriteriaOverlays*
uuid
required

Unique identifier

int32
required

Depending on referenced service criteria the days, operating hours or km prior to service to flags an upcoming service. For example given a serviceHours of 500 hours and a overriddenNotifyBefore of 50 (hours) then at 450 operating hours the asset is flagged for upcoming service.

documentIds
array of objects
length ≥ 1
documentIds
int32

Days before service interval to mark upcoming service based on predicted due date.

Responses

429

Rate limit exceeded

504

Upstream request timeout

Updated 6 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago