Jump to

• Request
• Response

List maintenance activities

get

/serviceapi/entityModel/data/entities/maintenances

List maintenance activites using given filter query parameters.

API View: Standard

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer(int32)
  number of maintenance activities returned per call

  Default Value: 200
• name(optional): string
  maintenance name or the start of maintenance name
• offset(optional): integer(int32)
  offset into the result-set if result is retrieved in chunks

  Default Value: 0
• timeframe(optional): string
  The timeframe of the maintenance, allowed values ACTIVE, PLANNED, COMPLETED

  Allowed Values: [ "ACTIVE", "PLANNED", "COMPLETED" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object MaintenanceSummary

  Defines the summary of a maintenance activity

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MaintenanceSummary"
    }
}

Nested Schema : MaintenanceSummary

Type: object

Defines the summary of a maintenance activity

Show Source

• endTimeUtc(optional): string(date-time)
  End time of the maintenance schedule in UTC

  API View: Standard

• frequencyCode: string
  Allowed Values: [ "ONE_TIME_SCHEDULE", "REPEAT_DAILY", "REPEAT_SPECIFIC_DAY_OF_WEEK", "REPEAT_FIRST_DAY_OF_WEEK_EVERY_MONTH" ]

  Frequency code indicating how the maintenance schedule should operate

  API View: Standard

• id: string
  Id of the maintenance activity

  API View: Standard

• name: string
  Name of the Maintenance Activity

  API View: Standard

• startTimeUtc(optional): string(date-time)
  Start time of the maintenance schedule in UTC

  API View: Standard

{
    "type":"object",
    "required":[
        "frequencyCode",
        "id",
        "name"
    ],
    "properties":{
        "endTimeUtc":{
            "type":"string",
            "format":"date-time",
            "description":"End time of the maintenance schedule in UTC<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "frequencyCode":{
            "type":"string",
            "description":"Frequency code indicating how the maintenance schedule should operate<p>API View: Standard</p>",
            "enum":[
                "ONE_TIME_SCHEDULE",
                "REPEAT_DAILY",
                "REPEAT_SPECIFIC_DAY_OF_WEEK",
                "REPEAT_FIRST_DAY_OF_WEEK_EVERY_MONTH"
            ],
            "x-api-view":"default"
        },
        "id":{
            "type":"string",
            "description":"Id of the maintenance activity<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "name":{
            "type":"string",
            "description":"Name of the Maintenance Activity<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "startTimeUtc":{
            "type":"string",
            "format":"date-time",
            "description":"Start time of the maintenance schedule in UTC<p>API View: Standard</p>",
            "x-api-view":"default"
        }
    },
    "description":"<p>Defines the summary of a maintenance activity</p>"
}

Back to Top