Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Maintenance Plans

List maintenance plans

Endpoint used to list maintenance plan resources

get/maintenanceplans

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Maintenance Plans returned

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Maintenance Plans list

nextCursorstring nullable required

The cursor to retrieve the next page of Maintenance Plans.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Maintenance Plans.

Example response

{
  "maintenancePlans": [
    {
      "id": 1,
      "name": "Weekly Conveyor Belt Inspection",
      "organizationId": 42,
      "startDate": "2022-01-01T00:00:00.000Z",
      "workOrderStartDatePadding": 48,
      "workOrderStartDateOffset": {
        "value": 2,
        "unit": "DAY"
      },
      "workOrderStartDateFixedDay": 5,
      "blueprintEstimatedTime": 60,
      "triggerType": "CALENDAR",
      "intervalStrategy": "FIXED",
      "planningHorizon": {
        "value": 3,
        "unit": "WEEK"
      },
      "workOrderBlueprintId": 10,
      "assets": [
        {
          "id": 1,
          "assetId": 100
        }
      ],
      "intervals": [
        {
          "id": 1,
          "interval": 3,
          "workOrderBlueprintId": 50
        }
      ],
      "nextCycleOccurrence": 2,
      "nextScheduledWorkOrderDueDate": "2022-01-01T00:00:00.000Z",
      "lastPlannedDueDate": "2022-01-01T00:00:00.000Z",
      "nextWorkOrderGenerationAt": "2022-01-01T00:00:00.000Z",
      "lastWorkOrderGeneratedAt": "2022-01-01T00:00:00.000Z",
      "creatorId": 5,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "archivedAt": "2022-01-01T00:00:00.000Z"
    }
  ]
}