/maintainx-maintenance | Type: Application | PCID required: Yes
Tools
maintainx_maintenance_create_maintenanceplans
Create a maintenance plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
intervals | object[] | No | — | Multi-cycle intervals with different blueprints per cycle. |
name | string | Yes | — | Name of the maintenance plan. |
nextCycleOccurrence | number | No | — | Which cycle in the multi-cycle sequence comes next. |
planAssets | object[] | No | — | Assets to associate with this plan. |
planningHorizon | object | Yes | — | How far ahead to generate work orders. |
recurrence | object | Yes | — | The recurrence schedule configuration. |
startDate | string | No | — | The first due date for generated work orders. |
workOrderBlueprintId | number | Yes | — | ID of the work order blueprint used to generate work orders. |
workOrderStartDatePadding | number | No | — | Hours between the start date and due date of generated work orders. |
maintainx_maintenance_create_meterreadings
Batch create new meter readings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object[] | Yes | — | Meter readings to create |
maintainx_maintenance_create_meters
Create new meter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
assetId | integer | No | — | Global ID of the asset tied to the meter |
description | string | No | — | Description of the meter |
locationId | integer | No | — | Global ID of the location tied to the meter |
measurementType | string | No | — | Represents the Type of meter. <br><br><code>Manual</code>: They are made to be used in the MaintainX app and to retain manually entered values and are limited to 10 distinct readings creation requests per 24 hours over REST API. Batched readings requests only count as one toward the rate limit. <br><br><code>Automated</code>: (Enterprise Plan) Automated meters store high frequency readings sent from integrations and have normal rate limiting. <br><br> |
name | string | Yes | — | Name of the meters |
readingFrequency | object | No | — | Expected reading frequency of the meter. Mostly useful for manual meters. |
unit | string | Yes | — | Measurement unit for the readings. Any string is accepted. However, if applicable, we recommed you to use the following units as it may carry extra functionality: <br><ul> <li>Distance: <ul> <li><code>Miles</code></li><li><code>Feet</code></li><li><code>Inches</code></li><li><code>Kilometers</code></li><li><code>Meters</code></li><li><code>Centimeters</code></li><li><code>Millimeters</code></li> </ul> </li> <li>Volume: <ul> <li><code>Gallons</code></li><li><code>Liters</code></li><li><code>Milliliters</code></li><li><code>Cubic Meters</code></li> </ul> </li> <li>Temperature: <ul> <li><code>Celsius</code></li><li><code>Fahrenheit</code></li><li><code>Kelvin</code></li> </ul> </li> <li>Other: <ul> <li><code>Hours</code></li><li><code>Cycles</code></li><li><code>PSI</code></li><li><code>Kilograms</code></li><li><code>Grams</code></li><li><code>dBm</code></li><li><code>Nm</code></li> </ul> </li> <li>Velocity: <ul> <li><code>MetersPerSecond</code></li><li><code>InchesPerSecond</code></li><li><code>MillimetersPerSecond</code></li> </ul> </li> <li>Acceleration: <ul> <li><code>G-Force</code></li><li><code>MetersPerSecondSquared</code></li><li><code>FeetPerSecondSquared</code></li> </ul> </li> <li>Electrical: <ul> <li><code>Volts</code></li><li><code>Amps</code></li> </ul> </li> </ul> |
maintainx_maintenance_create_metertriggers
Create meter trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
meterTrigger | object | Yes | — | Meter Trigger |
workOrderTemplate | object | No | — | Work Order Template |
maintainx_maintenance_create_proceduretemplates
Create procedure template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
fields | object[] | Yes | — | The fields value |
title | string | Yes | — | The title value |
maintainx_maintenance_delete_maintenanceplans
Delete maintenance plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the maintenance plan |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_delete_meters
Delete meter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meter |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_delete_metertriggers
Delete meterTrigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meterTrigger |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_delete_metertriggers_workordertemplates_attachments
Remove meter trigger’s work order template attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meter trigger’s work order template. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_delete_proceduretemplaterows
Delete procedure Template Row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedure Template Row |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_delete_proceduretemplaterows_attachments
Remove procedure template row attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedure template row. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_delete_proceduretemplates
Delete procedure Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedure Template |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_maintenance_get_maintenanceplans
Get maintenance plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the maintenancePlan |
maintainx_maintenance_get_meters
Get meter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meter |
expand | string[] | No | — | To expand multiple fields: expand=asset&expand=location |
maintainx_maintenance_get_metertriggers
Get meter trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meterTrigger |
expand | string[] | No | — | Related resources to expand inline |
maintainx_maintenance_get_proceduretemplates
Get procedure template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedureTemplate |
expand | string[] | No | — | Related resources to expand inline |
maintainx_maintenance_list_maintenanceplans
List maintenance plans Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Maintenance Plans returned |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_maintenance_list_meters
List meters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Meters returned |
measurementType | string | No | — | The measurement type of the meter to filter by |
expand | string[] | No | — | To expand multiple fields: expand=asset&expand=location |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_maintenance_list_metertriggers
List meter triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Meter Triggers returned |
meters | integer[] | No | — | To filter by multiple meter IDs: meters=630&meters=634 |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_maintenance_list_proceduretemplates
List procedure templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Procedure Templates returned |
expand | string[] | No | — | Related resources to expand inline |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_maintenance_update_maintenanceplans
Update a maintenance plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the maintenance plan |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
addedPlanAssets | object[] | No | — | Assets to add to this plan. |
addedUpdatedIntervals | object[] | No | — | Intervals to add or update. |
name | string | No | — | Name of the maintenance plan. |
nextCycleOccurrence | number | No | — | Which cycle in the multi-cycle sequence comes next. |
nextWorkOrderToGenerateDueDate | string | No | — | Override the due date of the next work order to be generated. |
planningHorizon | object | No | — | How far ahead to generate work orders. |
recurrence | object | No | — | The recurrence schedule configuration. |
removedIntervalIds | number[] | No | — | IDs of intervals to remove. |
removedPlanAssetIds | number[] | No | — | IDs of plan-asset associations to remove. |
startDate | string | No | — | The first due date for generated work orders. |
workOrderBlueprintId | number | No | — | ID of the work order blueprint used to generate work orders. |
workOrderStartDatePadding | number | No | — | Hours between the start date and due date of generated work orders. |
maintainx_maintenance_update_meters
Update meter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meter |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
assetId | integer | No | — | Global ID of the asset tied to the meter |
description | string | No | — | Description of the meter |
locationId | integer | No | — | Global ID of the location tied to the meter |
name | string | No | — | Name of the meters |
readingFrequency | object | No | — | Expected reading frequency of the meter. Mostly useful for manual meters. |
unit | string | No | — | Measurement unit for the readings. Any string is accepted. However, if applicable, we recommed you to use the following units as it may carry extra functionality: <br><ul> <li>Distance: <ul> <li><code>Miles</code></li><li><code>Feet</code></li><li><code>Inches</code></li><li><code>Kilometers</code></li><li><code>Meters</code></li><li><code>Centimeters</code></li><li><code>Millimeters</code></li> </ul> </li> <li>Volume: <ul> <li><code>Gallons</code></li><li><code>Liters</code></li><li><code>Milliliters</code></li><li><code>Cubic Meters</code></li> </ul> </li> <li>Temperature: <ul> <li><code>Celsius</code></li><li><code>Fahrenheit</code></li><li><code>Kelvin</code></li> </ul> </li> <li>Other: <ul> <li><code>Hours</code></li><li><code>Cycles</code></li><li><code>PSI</code></li><li><code>Kilograms</code></li><li><code>Grams</code></li><li><code>dBm</code></li><li><code>Nm</code></li> </ul> </li> <li>Velocity: <ul> <li><code>MetersPerSecond</code></li><li><code>InchesPerSecond</code></li><li><code>MillimetersPerSecond</code></li> </ul> </li> <li>Acceleration: <ul> <li><code>G-Force</code></li><li><code>MetersPerSecondSquared</code></li><li><code>FeetPerSecondSquared</code></li> </ul> </li> <li>Electrical: <ul> <li><code>Volts</code></li><li><code>Amps</code></li> </ul> </li> </ul> |
maintainx_maintenance_update_metertriggers
Update meter trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the work order template |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
meterTrigger | object | No | — | Meter Trigger |
maintainx_maintenance_update_metertriggers_workordertemplates
Update Meter Trigger’s Work Order Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the work order template |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
data | object | No | — | The data value |
procedureTemplateId | integer | No | — | ID of the procedure template used |
saveProcedureAsTemplate | boolean | No | — | Save the procedure in data as a new procedure template |
title | string | No | — | Title of the work order that will be generated. Same string for meter trigger’s name. Setting this will also set the corresponding meter’s trigger name. |
maintainx_maintenance_update_proceduretemplaterows
Update Procedure Template Row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedure template row |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
choices | string[] | No | — | The choices value |
description | string | No | — | The description value |
index | number | No | — | Order which the row is displayed |
isDateAndTime | boolean | No | — | Indicate if a DATE field also contains the time |
label | string | No | — | The label value |
meterId | number | No | — | Id of the meter |
type | string | No | — | The type value |
urls | object[] | No | — | The urls value |
maintainx_maintenance_update_proceduretemplates
Update Procedure Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedure template |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
description | string | No | — | Description of the procedure template |
fields | object[] | No | — | The fields value |
title | string | No | — | Title of the procedure template |
maintainx_maintenance_upload_metertriggers_thumbnail
Update meter trigger’s work order template’s thumbnail Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meter trigger’s work order template. |
filename | string | Yes | — | Name of the meter trigger’s work order template thumbnail, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the thumbnail. |
maintainx_maintenance_upload_metertriggers_workordertemplates_attachments
Update meter trigger’s work order template attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the meter trigger’s work order template. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the attachment. |
maintainx_maintenance_upload_proceduretemplaterows_attachments
Update procedure template row attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the procedure template row. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the attachment. |

