Skip to main content
Server path: /maintainx-maintenance | Type: Application | PCID required: Yes

Tools

ToolDescription
maintainx_maintenance_create_maintenanceplansCreate a maintenance plan
maintainx_maintenance_create_meterreadingsBatch create new meter readings
maintainx_maintenance_create_metersCreate new meter
maintainx_maintenance_create_metertriggersCreate meter trigger
maintainx_maintenance_create_proceduretemplatesCreate procedure template
maintainx_maintenance_delete_maintenanceplansDelete maintenance plan
maintainx_maintenance_delete_metersDelete meter
maintainx_maintenance_delete_metertriggersDelete meterTrigger
maintainx_maintenance_delete_metertriggers_workordertemplates_attachmentsRemove meter trigger’s work order template attachment
maintainx_maintenance_delete_proceduretemplaterowsDelete procedure Template Row
maintainx_maintenance_delete_proceduretemplaterows_attachmentsRemove procedure template row attachment
maintainx_maintenance_delete_proceduretemplatesDelete procedure Template
maintainx_maintenance_get_maintenanceplansGet maintenance plan
maintainx_maintenance_get_metersGet meter
maintainx_maintenance_get_metertriggersGet meter trigger
maintainx_maintenance_get_proceduretemplatesGet procedure template
maintainx_maintenance_list_maintenanceplansList maintenance plans
maintainx_maintenance_list_metersList meters
maintainx_maintenance_list_metertriggersList meter triggers
maintainx_maintenance_list_proceduretemplatesList procedure templates
maintainx_maintenance_update_maintenanceplansUpdate a maintenance plan
maintainx_maintenance_update_metersUpdate meter
maintainx_maintenance_update_metertriggersUpdate meter trigger
maintainx_maintenance_update_metertriggers_workordertemplatesUpdate Meter Trigger’s Work Order Template
maintainx_maintenance_update_proceduretemplaterowsUpdate Procedure Template Row
maintainx_maintenance_update_proceduretemplatesUpdate Procedure Template
maintainx_maintenance_upload_metertriggers_thumbnailUpdate meter trigger’s work order template’s thumbnail
maintainx_maintenance_upload_metertriggers_workordertemplates_attachmentsUpdate meter trigger’s work order template attachment
maintainx_maintenance_upload_proceduretemplaterows_attachmentsUpdate procedure template row attachment

maintainx_maintenance_create_maintenanceplans

Create a maintenance plan Parameters:
ParameterTypeRequiredDefaultDescription
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
x-organization-idintegerNoRequired if using a multi organizations token
intervalsobject[]NoMulti-cycle intervals with different blueprints per cycle.
namestringYesName of the maintenance plan.
nextCycleOccurrencenumberNoWhich cycle in the multi-cycle sequence comes next.
planAssetsobject[]NoAssets to associate with this plan.
planningHorizonobjectYesHow far ahead to generate work orders.
recurrenceobjectYesThe recurrence schedule configuration.
startDatestringNoThe first due date for generated work orders.
workOrderBlueprintIdnumberYesID of the work order blueprint used to generate work orders.
workOrderStartDatePaddingnumberNoHours between the start date and due date of generated work orders.

maintainx_maintenance_create_meterreadings

Batch create new meter readings Parameters:
ParameterTypeRequiredDefaultDescription
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
bodyobject[]YesMeter readings to create

maintainx_maintenance_create_meters

Create new meter Parameters:
ParameterTypeRequiredDefaultDescription
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
x-organization-idintegerNoRequired if using a multi organizations token
assetIdintegerNoGlobal ID of the asset tied to the meter
descriptionstringNoDescription of the meter
locationIdintegerNoGlobal ID of the location tied to the meter
measurementTypestringNoRepresents 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><code>IoT Device</code>: IoT Device meters are deprecated and should no longer be used in the future. Creating an IoT Device meter will mimic automated meters in terms of behavior to avoid breaking changes.
namestringYesName of the meters
readingFrequencyobjectNoExpected reading frequency of the meter. Mostly useful for manual meters.
unitstringYesMeasurement 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:
ParameterTypeRequiredDefaultDescription
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
x-organization-idintegerNoRequired if using a multi organizations token
meterTriggerobjectYesMeter Trigger
workOrderTemplateobjectNoWork Order Template

maintainx_maintenance_create_proceduretemplates

Create procedure template Parameters:
ParameterTypeRequiredDefaultDescription
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
x-organization-idintegerNoRequired if using a multi organizations token
fieldsobject[]YesThe fields value
titlestringYesThe title value

maintainx_maintenance_delete_maintenanceplans

Delete maintenance plan Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the maintenance plan
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meter
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meterTrigger
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meter trigger’s work order template.
filenamestringYesName of the attachment, including the extension.
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedure Template Row
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedure template row.
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedure Template
skipWebhookbooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the maintenancePlan

maintainx_maintenance_get_meters

Get meter Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meter
expandstring[]NoTo expand multiple fields: expand=asset&expand=location

maintainx_maintenance_get_metertriggers

Get meter trigger Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meterTrigger
expandstring[]NoRelated resources to expand inline

maintainx_maintenance_get_proceduretemplates

Get procedure template Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedureTemplate
expandstring[]NoRelated resources to expand inline

maintainx_maintenance_list_maintenanceplans

List maintenance plans Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoLast pagination reference
limitintegerNomax number of Maintenance Plans returned
x-organization-idintegerNoRequired if using a multi organizations token

maintainx_maintenance_list_meters

List meters Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoLast pagination reference
limitintegerNomax number of Meters returned
measurementTypestringNoThe measurement type of the meter to filter by
expandstring[]NoTo expand multiple fields: expand=asset&expand=location
x-organization-idintegerNoRequired if using a multi organizations token

maintainx_maintenance_list_metertriggers

List meter triggers Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoLast pagination reference
limitintegerNomax number of Meter Triggers returned
metersinteger[]NoTo filter by multiple meter IDs: meters=630&meters=634
x-organization-idintegerNoRequired if using a multi organizations token

maintainx_maintenance_list_proceduretemplates

List procedure templates Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoLast pagination reference
limitintegerNomax number of Procedure Templates returned
expandstring[]NoRelated resources to expand inline
x-organization-idintegerNoRequired if using a multi organizations token

maintainx_maintenance_update_maintenanceplans

Update a maintenance plan Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the maintenance plan
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
addedPlanAssetsobject[]NoAssets to add to this plan.
addedUpdatedIntervalsobject[]NoIntervals to add or update.
namestringNoName of the maintenance plan.
nextCycleOccurrencenumberNoWhich cycle in the multi-cycle sequence comes next.
nextWorkOrderToGenerateDueDatestringNoOverride the due date of the next work order to be generated.
planningHorizonobjectNoHow far ahead to generate work orders.
recurrenceobjectNoThe recurrence schedule configuration.
removedIntervalIdsnumber[]NoIDs of intervals to remove.
removedPlanAssetIdsnumber[]NoIDs of plan-asset associations to remove.
startDatestringNoThe first due date for generated work orders.
workOrderBlueprintIdnumberNoID of the work order blueprint used to generate work orders.
workOrderStartDatePaddingnumberNoHours between the start date and due date of generated work orders.

maintainx_maintenance_update_meters

Update meter Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meter
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
assetIdintegerNoGlobal ID of the asset tied to the meter
descriptionstringNoDescription of the meter
locationIdintegerNoGlobal ID of the location tied to the meter
namestringNoName of the meters
readingFrequencyobjectNoExpected reading frequency of the meter. Mostly useful for manual meters.
unitstringNoMeasurement 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the work order template
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
meterTriggerobjectNoMeter Trigger

maintainx_maintenance_update_metertriggers_workordertemplates

Update Meter Trigger’s Work Order Template Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the work order template
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
dataobjectNoThe data value
procedureTemplateIdintegerNoID of the procedure template used
saveProcedureAsTemplatebooleanNoSave the procedure in data as a new procedure template
titlestringNoTitle 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedure template row
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
choicesstring[]NoThe choices value
descriptionstringNoThe description value
indexnumberNoOrder which the row is displayed
isDateAndTimebooleanNoIndicate if a DATE field also contains the time
labelstringNoThe label value
meterIdnumberNoId of the meter
typestringNoThe type value
urlsobject[]NoThe urls value

maintainx_maintenance_update_proceduretemplates

Update Procedure Template Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedure template
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
descriptionstringNoDescription of the procedure template
fieldsobject[]NoThe fields value
titlestringNoTitle of the procedure template

maintainx_maintenance_upload_metertriggers_thumbnail

Update meter trigger’s work order template’s thumbnail Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meter trigger’s work order template.
filenamestringYesName of the meter trigger’s work order template thumbnail, including the extension.
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
bodyobjectYesContent 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the meter trigger’s work order template.
filenamestringYesName of the attachment, including the extension.
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
bodyobjectYesContent 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the procedure template row.
filenamestringYesName of the attachment, including the extension.
skipWebhookbooleanNoSet skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
x-organization-idintegerNoRequired if using a multi organizations token
bodyobjectYesContent type should be application/octet-stream and payload should use binary format for the attachment.