Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Maintenance Plans

Create a maintenance plan

post/maintenanceplans

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

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required

Name of the maintenance plan.

startDatestring date-time

The first due date for generated work orders.

workOrderBlueprintIdnumber required

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.

nextCycleOccurrencenumber

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"
  },
  "planAssets": [
    {
      "assetId": 100
    }
  ],
  "intervals": [
    {
      "interval": 3,
      "workOrderBlueprintId": 50
    }
  ],
  "nextCycleOccurrence": 2
}

Response

Successfully created the maintenance plan.

idnumber required

ID of the created maintenance plan.

Example response

{
  "id": 1
}