Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Maintenance Plans

Create a maintenance plan work order blueprint

post/maintenanceplans/workorderblueprints

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

titlestring required

Title of the work order blueprint.

descriptionstring

Description of the work order blueprint.

estimatedTimeinteger

Estimated time in seconds to complete the work order.

procedureBlueprintIdsinteger[]

IDs of procedure blueprints to attach to the work order blueprint.

userIdsinteger[]

IDs of users to assign to work orders generated from this blueprint.

teamIdsinteger[]

IDs of teams to assign to work orders generated from this blueprint.

priority'NONE' | 'LOW' | 'MEDIUM' | 'HIGH'

Priority of work orders generated from this blueprint.

tagIdsinteger[]

IDs of tags (categories) to associate with the work order blueprint.

vendorIdsinteger[]

IDs of vendors to associate with the work order blueprint.

Example request

{
  "title": "Weekly Inspection",
  "description": "Inspect the conveyor belt for wear and tear.",
  "estimatedTime": 3600,
  "procedureBlueprintIds": [
    1,
    2
  ],
  "userIds": [
    1,
    2
  ],
  "teamIds": [
    3,
    4
  ],
  "priority": "MEDIUM",
  "partsUsed": [
    {
      "partId": 10,
      "quantityUsed": 2
    }
  ],
  "tagIds": [
    5,
    6
  ],
  "vendorIds": [
    7,
    8
  ],
  "customFieldValues": [
    {
      "workOrderFieldId": 100,
      "value": "high"
    }
  ]
}

Response

Successfully created the work order blueprint.

idnumber required

ID of the created work order blueprint.

Example response

{
  "id": 1
}