GEgetmaintainx
Procedure Template Rows

Update Procedure Template Row

Changed on
patch/proceduretemplaterows/{id}

Request

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

Path parameters

idinteger required

ID of the procedure template row

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

labelstring
type'NUMBER' | 'AMOUNT' | 'TEXT' | 'UNSUPPORTED' | 'HEADING' | 'FILE' | 'SIGNATURE' | 'MULTIPLE_CHOICE' | 'INSPECTION_CHECK' | 'YES_NO_NA' | 'CHECKBOX' | 'CHECKLIST' | 'METER' | 'DATE' | 'CYCLE_COUNT'
descriptionstring nullable
choicesstring[]
meterIdnumber nullable

Id of the meter

isDateAndTimeboolean

Indicate if a DATE field also contains the time

indexnumber

Order which the row is displayed

Example request

{
  "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 edited the procedure template row

Example response

{
  "row": {
    "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

    • warning

      added the new CYCLE_COUNT enum value to the / response property for the response status

    • warning

      added the new UNSUPPORTED enum value to the / response property for the response status

    • 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

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response property / became required for the status