Iris API Reference
Start typing to search…

Get service statuses

get https://iris.trackunit.com/api/service-management/v2/plans/assignments/service-status

Returns the available statuses for the planned service for a given asset.

➡️

OpenAPI Specification for the Service Management API domain

Get the OpenAPI Specification (formerly Swagger), which is a standardized format that describes the functionalities, endpoints, parameters, and data models of this API in a JSON file here.

Query Params
string
required

Unique identifier

Responses

Response body
object
plannedServiceStatuses
array of objects
required

List of planned service statuses for the given asset.

plannedServiceStatuses*
object
string
required

Identifier for service plan

string
required

Identifier for planned service

string
required

Account Id of Service Provider

cumulativeOperatingHoursCriteria
object
distanceCriteria
object
timeCriteria
object
date-time
string
required
string
length between 1 and 255

Name of the planned service

string | null

Criteria that is expected to go overdue at the predicted time

date-time | null

Estimated time in which the service will have to be performed.

date-time | null

Time when prediction for service was calculated.

boolean
Defaults to false
date-time | null

The date-time that the service is scheduled for.

429

Rate limit exceeded

504

Upstream request timeout

Updated over 1 year ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?