Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Maintenance Plans

Update a maintenance plan

patch/maintenanceplans/{id}

Path parameters

idinteger required

ID of the maintenance plan

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Request body

namestring

Name of the maintenance plan.

startDatestring date-time

The first due date for generated work orders.

workOrderBlueprintIdnumber

ID of the maintenance plan work order blueprint used to generate work orders. These can be created through the /maintenanceplans/workorderblueprints endpoint.

workOrderStartDatePaddingnumber

Hours between the start date and due date of generated work orders. Deprecated: use workOrderStartDateOffset instead.

nextWorkOrderToGenerateDueDatestring date-time nullable

Override the due date of the next work order to be generated.

removedPlanAssetIdsnumber[]

IDs of plan-asset associations to remove.

removedIntervalIdsnumber[]

IDs of intervals to remove.

nextCycleOccurrencenumber nullable

Which cycle in the multi-cycle sequence comes next.

Example request

{
  "name": "Weekly Conveyor Belt Inspection",
  "startDate": "2022-01-01T00:00:00.000Z",
  "workOrderBlueprintId": 10,
  "workOrderStartDatePadding": 48,
  "workOrderStartDateOffset": {
    "value": 2,
    "unit": "DAY"
  },
  "planningHorizon": {
    "value": 3,
    "unit": "WEEK"
  },
  "nextWorkOrderToGenerateDueDate": "2022-01-01T00:00:00.000Z",
  "addedPlanAssets": [
    {
      "assetId": 100
    }
  ],
  "removedPlanAssetIds": [
    1,
    2
  ],
  "addedUpdatedIntervals": [
    {
      "id": 1,
      "interval": 3,
      "workOrderBlueprintId": 50
    }
  ],
  "removedIntervalIds": [
    1,
    2
  ],
  "nextCycleOccurrence": 2
}

Response

Successfully updated the maintenance plan.

Example response

{
  "maintenancePlan": {
    "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"
  }
}