GEgetmaintainx
Procedure Templates

Create procedure template

Changed on
post/proceduretemplates

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

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

Example request

{
  "title": "Ladder Inspection Checklist",
  "fields": [
    {
      "label": "Metal Parts: broken, loose, dented, rusty, missing",
      "type": "INSPECTION_CHECK",
      "choices": [
        "Partially"
      ],
      "urls": [
        {
          "label": "MaintainX Website",
          "link": "www.getmaintainx.com"
        }
      ],
      "meterId": 1,
      "index": 1
    }
  ]
}

Response

Successfully created the custom fields

idnumber required

Id of the procedure template

Example response

{
  "id": 1,
  "fields": [
    {
      "id": 1,
      "label": "Metal Parts: broken, loose, dented, rusty, missing",
      "type": "INSPECTION_CHECK",
      "choices": [
        "Partially"
      ],
      "attachmentId": 1,
      "attachments": [
        {
          "id": 12345,
          "mimeType": "image/png",
          "fileName": "image.png",
          "url": "http://example.com/image.png",
          "createdAt": "2022-01-01T00:00:00.000Z",
          "width": 220,
          "height": 100
        }
      ],
      "urls": [
        {
          "label": "MaintainX Website",
          "link": "www.getmaintainx.com"
        }
      ]
    }
  ]
}

Changes

  • 222e6fad7c1fRevision changes
    • breaking

      removed the media type application/octet-stream from the request body

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new CYCLE_COUNT enum value to the request property //

    • info

      added the new UNSUPPORTED enum value to the request property //

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status