> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # maintainx-maintenance > MaintainX Maintenance — manage plans, meters, triggers, and procedures **Server path:** `/maintainx-maintenance` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | [`maintainx_maintenance_create_maintenanceplans`](#maintainx_maintenance_create_maintenanceplans) | Create a maintenance plan | | [`maintainx_maintenance_create_meterreadings`](#maintainx_maintenance_create_meterreadings) | Batch create new meter readings | | [`maintainx_maintenance_create_meters`](#maintainx_maintenance_create_meters) | Create new meter | | [`maintainx_maintenance_create_metertriggers`](#maintainx_maintenance_create_metertriggers) | Create meter trigger | | [`maintainx_maintenance_create_proceduretemplates`](#maintainx_maintenance_create_proceduretemplates) | Create procedure template | | [`maintainx_maintenance_delete_maintenanceplans`](#maintainx_maintenance_delete_maintenanceplans) | Delete maintenance plan | | [`maintainx_maintenance_delete_meters`](#maintainx_maintenance_delete_meters) | Delete meter | | [`maintainx_maintenance_delete_metertriggers`](#maintainx_maintenance_delete_metertriggers) | Delete meterTrigger | | [`maintainx_maintenance_delete_metertriggers_workordertemplates_attachments`](#maintainx_maintenance_delete_metertriggers_workordertemplates_attachments) | Remove meter trigger's work order template attachment | | [`maintainx_maintenance_delete_proceduretemplaterows`](#maintainx_maintenance_delete_proceduretemplaterows) | Delete procedure Template Row | | [`maintainx_maintenance_delete_proceduretemplaterows_attachments`](#maintainx_maintenance_delete_proceduretemplaterows_attachments) | Remove procedure template row attachment | | [`maintainx_maintenance_delete_proceduretemplates`](#maintainx_maintenance_delete_proceduretemplates) | Delete procedure Template | | [`maintainx_maintenance_get_maintenanceplans`](#maintainx_maintenance_get_maintenanceplans) | Get maintenance plan | | [`maintainx_maintenance_get_meters`](#maintainx_maintenance_get_meters) | Get meter | | [`maintainx_maintenance_get_metertriggers`](#maintainx_maintenance_get_metertriggers) | Get meter trigger | | [`maintainx_maintenance_get_proceduretemplates`](#maintainx_maintenance_get_proceduretemplates) | Get procedure template | | [`maintainx_maintenance_list_maintenanceplans`](#maintainx_maintenance_list_maintenanceplans) | List maintenance plans | | [`maintainx_maintenance_list_meters`](#maintainx_maintenance_list_meters) | List meters | | [`maintainx_maintenance_list_metertriggers`](#maintainx_maintenance_list_metertriggers) | List meter triggers | | [`maintainx_maintenance_list_proceduretemplates`](#maintainx_maintenance_list_proceduretemplates) | List procedure templates | | [`maintainx_maintenance_update_maintenanceplans`](#maintainx_maintenance_update_maintenanceplans) | Update a maintenance plan | | [`maintainx_maintenance_update_meters`](#maintainx_maintenance_update_meters) | Update meter | | [`maintainx_maintenance_update_metertriggers`](#maintainx_maintenance_update_metertriggers) | Update meter trigger | | [`maintainx_maintenance_update_metertriggers_workordertemplates`](#maintainx_maintenance_update_metertriggers_workordertemplates) | Update Meter Trigger's Work Order Template | | [`maintainx_maintenance_update_proceduretemplaterows`](#maintainx_maintenance_update_proceduretemplaterows) | Update Procedure Template Row | | [`maintainx_maintenance_update_proceduretemplates`](#maintainx_maintenance_update_proceduretemplates) | Update Procedure Template | | [`maintainx_maintenance_upload_metertriggers_thumbnail`](#maintainx_maintenance_upload_metertriggers_thumbnail) | Update meter trigger's work order template's thumbnail | | [`maintainx_maintenance_upload_metertriggers_workordertemplates_attachments`](#maintainx_maintenance_upload_metertriggers_workordertemplates_attachments) | Update meter trigger's work order template attachment | | [`maintainx_maintenance_upload_proceduretemplaterows_attachments`](#maintainx_maintenance_upload_proceduretemplaterows_attachments) | Update procedure template row attachment | *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "intervals": { "type": "array", "items": { "type": "object", "properties": { "interval": { "type": "number", "description": "The cycle number at which this interval's blueprint is used." }, "workOrderBlueprintId": { "type": "number", "description": "ID of the work order blueprint for this cycle." } }, "required": [ "interval", "workOrderBlueprintId" ] }, "description": "Multi-cycle intervals with different blueprints per cycle." }, "name": { "type": "string", "description": "Name of the maintenance plan." }, "nextCycleOccurrence": { "type": "number", "description": "Which cycle in the multi-cycle sequence comes next." }, "planAssets": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "number", "description": "ID of the asset." } }, "required": [ "assetId" ] }, "description": "Assets to associate with this plan." }, "planningHorizon": { "type": "object", "description": "How far ahead to generate work orders.", "properties": { "value": { "type": "number", "description": "The numeric value of the planning horizon." }, "unit": { "type": "string", "description": "The unit of the planning horizon.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] } }, "required": [ "value", "unit" ] }, "recurrence": { "type": "object", "description": "The recurrence schedule configuration." }, "startDate": { "type": "string", "description": "The first due date for generated work orders." }, "workOrderBlueprintId": { "type": "number", "description": "ID of the work order blueprint used to generate work orders." }, "workOrderStartDatePadding": { "type": "number", "description": "Hours between the start date and due date of generated work orders." } }, "required": [ "PCID", "name", "planningHorizon", "recurrence", "workOrderBlueprintId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "body": { "type": "array", "items": { "type": "object", "properties": { "meterId": { "type": "number", "description": "Global ID of the meter." }, "value": { "type": "number", "description": "The reading value given by the meter." }, "readingDate": { "type": "string", "description": "Date at which the meter was read. This date can be set in the past, but cannot be further than 3 days for IoT meters." } }, "required": [ "meterId", "value" ] }, "description": "Meter readings to create" } }, "required": [ "PCID", "body" ] } ``` *** ## 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 | null | No | — | Global ID of the asset tied to the meter | | `description` | string | null | No | — | Description of the meter | | `locationId` | integer | null | No | — | Global ID of the location tied to the meter | | `measurementType` | string | No | — | Represents the Type of meter. \
\
\Manual\: 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. \
\
\Automated\: (Enterprise Plan) Automated meters store high frequency readings sent from integrations and have normal rate limiting. \
\
~~\IoT Device\~~: 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. | | | `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: \
\ | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "assetId": { "type": [ "integer", "null" ], "description": "Global ID of the asset tied to the meter" }, "description": { "type": [ "string", "null" ], "description": "Description of the meter" }, "locationId": { "type": [ "integer", "null" ], "description": "Global ID of the location tied to the meter" }, "measurementType": { "type": "string", "description": "Represents the Type of meter.

Manual: 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.

Automated: (Enterprise Plan) Automated meters store high frequency readings sent from integrations and have normal rate limiting.

~~IoT Device~~: 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.", "enum": [ "MANUAL", "IOT_DEVICE", "AUTOMATED_SENSOR" ] }, "name": { "type": "string", "description": "Name of the meters" }, "readingFrequency": { "type": "object", "description": "Expected reading frequency of the meter. Mostly useful for manual meters." }, "unit": { "type": "string", "description": "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:
" } }, "required": [ "PCID", "name", "unit" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "meterTrigger": { "type": "object", "description": "Meter Trigger", "properties": { "meterId": { "type": "integer", "description": "Meter Id" }, "workOrderTemplateId": { "type": "integer", "description": "Id of an existing work order template. Once this is set, the `workOrderTemplate` object will completely be ignored in favour of the work order template associated with the id. NOTE: If this is set, the name of the meter trigger will match the name of the linked work order template." }, "amount": { "type": "number", "description": "The amount value" }, "condition": { "type": "string", "description": "The condition value", "enum": [ "DECREMENTED_BY", "INCREMENTED_BY", "IS_EQUAL", "IS_GREATER", "IS_LESS", "INCREMENTED_BY_BASED_ON_LAST_READING", "DECREMENTED_BY_BASED_ON_LAST_READING" ] }, "dataPoints": { "type": "object", "description": "Data Points" }, "description": { "type": "string", "description": "The description value" }, "minDateForProcessing": { "type": "string", "description": "Date that the trigger will start to be active" }, "name": { "type": "string", "description": "Name of the trigger" }, "nextTriggerValue": { "type": "number", "description": "Can be set to override the first trigger value" }, "period": { "type": "integer", "description": "Window in seconds where the data points can be checked" } }, "required": [ "meterId", "amount", "condition", "name" ] }, "workOrderTemplate": { "type": "object", "description": "Work Order Template", "properties": { "procedureTemplateId": { "type": "integer", "description": "ID of the procedure template used" }, "saveProcedureAsTemplate": { "type": "boolean", "description": "Save the procedure in data as a new procedure template" }, "title": { "type": "string", "description": "Title of the work order that will be generated. Use the meter trigger's name instead. If both `workOrderTemplate.title` and `meterTrigger.name` are provided, `meterTrigger.name` will be used." }, "data": { "type": "object", "description": "The data value" } } } }, "required": [ "PCID", "meterTrigger" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The label value" }, "type": { "type": "string", "enum": [ "NUMBER", "AMOUNT", "TEXT", "UNSUPPORTED", "HEADING", "FILE", "SIGNATURE", "MULTIPLE_CHOICE", "INSPECTION_CHECK", "YES_NO_NA", "CHECKBOX", "CHECKLIST", "METER", "DATE", "CYCLE_COUNT" ], "description": "The type value" }, "description": { "type": "string", "description": "The description value" }, "choices": { "type": "array", "items": { "type": "string" }, "description": "The choices value" }, "urls": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Label of the url" }, "link": { "type": "string", "description": "Link" } } }, "description": "The urls value" }, "meterId": { "type": "number", "description": "Id of the meter" }, "isDateAndTime": { "type": "boolean", "description": "Indicate if a DATE field also contains the time" }, "index": { "type": "number", "description": "Order which the row is displayed" } }, "required": [ "type", "label" ] }, "description": "The fields value" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "fields", "title" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the maintenance plan" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meter" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meterTrigger" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meter trigger's work order template." }, "filename": { "type": "string", "description": "Name of the attachment, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id", "filename" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedure Template Row" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedure template row." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedure Template" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_maintenance\_get\_maintenanceplans Get maintenance plan **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------- | | `id` | integer | Yes | — | ID of the maintenancePlan | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the maintenancePlan" } }, "required": [ "PCID", "id" ] } ``` *** ## 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` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meter" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "asset", "location", "last_reading" ] }, "description": "To expand multiple fields: `expand=asset&expand=location`" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meterTrigger" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "work_order_template" ] }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedureTemplate" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "rows" ] }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Maintenance Plans returned" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Meters returned" }, "measurementType": { "type": "string", "description": "The measurement type of the meter to filter by", "enum": [ "MANUAL", "IOT_DEVICE", "AUTOMATED_SENSOR" ] }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "asset", "location", "last_reading" ] }, "description": "To expand multiple fields: `expand=asset&expand=location`" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Meter Triggers returned" }, "meters": { "type": "array", "items": { "type": "integer" }, "description": "To filter by multiple meter IDs: `meters=630&meters=634`" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Procedure Templates returned" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "rows" ] }, "description": "Related resources to expand inline" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## 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 | null | No | — | Which cycle in the multi-cycle sequence comes next. | | `nextWorkOrderToGenerateDueDate` | string | null | 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. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the maintenance plan" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "addedPlanAssets": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "number", "description": "ID of the asset." } }, "required": [ "assetId" ] }, "description": "Assets to add to this plan." }, "addedUpdatedIntervals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of an existing interval to update. Omit to create a new one." }, "interval": { "type": "number", "description": "The cycle number at which this interval's blueprint is used." }, "workOrderBlueprintId": { "type": "number", "description": "ID of the work order blueprint for this cycle." } }, "required": [ "interval", "workOrderBlueprintId" ] }, "description": "Intervals to add or update." }, "name": { "type": "string", "description": "Name of the maintenance plan." }, "nextCycleOccurrence": { "type": [ "number", "null" ], "description": "Which cycle in the multi-cycle sequence comes next." }, "nextWorkOrderToGenerateDueDate": { "type": [ "string", "null" ], "description": "Override the due date of the next work order to be generated." }, "planningHorizon": { "type": "object", "description": "How far ahead to generate work orders.", "properties": { "value": { "type": "number", "description": "The numeric value of the planning horizon." }, "unit": { "type": "string", "description": "The unit of the planning horizon.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] } }, "required": [ "value", "unit" ] }, "recurrence": { "type": "object", "description": "The recurrence schedule configuration." }, "removedIntervalIds": { "type": "array", "items": { "type": "number" }, "description": "IDs of intervals to remove." }, "removedPlanAssetIds": { "type": "array", "items": { "type": "number" }, "description": "IDs of plan-asset associations to remove." }, "startDate": { "type": "string", "description": "The first due date for generated work orders." }, "workOrderBlueprintId": { "type": "number", "description": "ID of the work order blueprint used to generate work orders." }, "workOrderStartDatePadding": { "type": "number", "description": "Hours between the start date and due date of generated work orders." } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | null | No | — | Global ID of the asset tied to the meter | | `description` | string | null | No | — | Description of the meter | | `locationId` | integer | null | 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: \
\ | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meter" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "assetId": { "type": [ "integer", "null" ], "description": "Global ID of the asset tied to the meter" }, "description": { "type": [ "string", "null" ], "description": "Description of the meter" }, "locationId": { "type": [ "integer", "null" ], "description": "Global ID of the location tied to the meter" }, "name": { "type": "string", "description": "Name of the meters" }, "readingFrequency": { "type": "object", "description": "Expected reading frequency of the meter. Mostly useful for manual meters." }, "unit": { "type": "string", "description": "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:
" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the work order template" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "meterTrigger": { "type": "object", "description": "Meter Trigger", "properties": { "meterId": { "type": "integer", "description": "Meter Id" }, "workOrderTemplateId": { "type": "integer", "description": "Id of an existing work order template. NOTE: If this changes, the name of the meter trigger will also changed to match the name of the linked work order template." }, "amount": { "type": "number", "description": "The amount value" }, "condition": { "type": "string", "description": "The condition value", "enum": [ "DECREMENTED_BY", "INCREMENTED_BY", "IS_EQUAL", "IS_GREATER", "IS_LESS", "INCREMENTED_BY_BASED_ON_LAST_READING", "DECREMENTED_BY_BASED_ON_LAST_READING" ] }, "dataPoints": { "type": "object", "description": "Data Points" }, "description": { "type": "string", "description": "The description value" }, "minDateForProcessing": { "type": "string", "description": "Date that the trigger will start to be active" }, "name": { "type": "string", "description": "Name of the trigger" }, "nextTriggerValue": { "type": "number", "description": "Can be set to override the first trigger value" }, "period": { "type": "integer", "description": "Window in seconds where the data points can be checked" } } } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | null | No | — | ID of the procedure template used | | `saveProcedureAsTemplate` | boolean | null | 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. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the work order template" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "data": { "type": "object", "description": "The data value", "properties": { "assetId": { "type": "integer", "description": "Asset Id" }, "assigneeIds": { "type": "array", "items": { "type": "number" }, "description": "Users IDs assigned to the template" }, "description": { "type": "string", "description": "The description value" }, "dueDate": { "type": "object", "description": "Due Date" }, "locationId": { "type": "integer", "description": "Global ID of the location assigned to the work order" }, "partsUsed": { "type": "array", "items": { "type": "object" }, "description": "Parts Used" }, "priority": { "type": "string", "description": "The priority value", "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ] }, "procedure": { "type": "object", "description": "The procedure value" }, "tagsIds": { "type": "array", "items": { "type": "number" }, "description": "Categories IDs" }, "teamIds": { "type": "array", "items": { "type": "number" }, "description": "Teams IDs" }, "title": { "type": "string", "description": "Use the `title` field at the root level. If both `title` and `data.title` are provided, `title` will be used." }, "vendorIds": { "type": "array", "items": { "type": "number" }, "description": "Vendor IDs" } } }, "procedureTemplateId": { "type": [ "integer", "null" ], "description": "ID of the procedure template used" }, "saveProcedureAsTemplate": { "type": [ "boolean", "null" ], "description": "Save the procedure in data as a new procedure template" }, "title": { "type": "string", "description": "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." } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | null | 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 | null | No | — | Id of the meter | | `type` | string | No | — | The type value | | | `urls` | object\[] | No | — | The urls value | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedure template row" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "choices": { "type": "array", "items": { "type": "string" }, "description": "The choices value" }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "index": { "type": "number", "description": "Order which the row is displayed" }, "isDateAndTime": { "type": "boolean", "description": "Indicate if a DATE field also contains the time" }, "label": { "type": "string", "description": "The label value" }, "meterId": { "type": [ "number", "null" ], "description": "Id of the meter" }, "type": { "type": "string", "description": "The type value", "enum": [ "NUMBER", "AMOUNT", "TEXT", "UNSUPPORTED", "HEADING", "FILE", "SIGNATURE", "MULTIPLE_CHOICE", "INSPECTION_CHECK", "YES_NO_NA", "CHECKBOX", "CHECKLIST", "METER", "DATE", "CYCLE_COUNT" ] }, "urls": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Label of the url" }, "link": { "type": "string", "description": "The link value" } }, "required": [ "link" ] }, "description": "The urls value" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | null | No | — | Description of the procedure template | | `fields` | object\[] | No | — | The fields value | | | `title` | string | No | — | Title of the procedure template | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedure template" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "description": { "type": [ "string", "null" ], "description": "Description of the procedure template" }, "fields": { "type": "array", "items": { "type": "object" }, "description": "The fields value" }, "title": { "type": "string", "description": "Title of the procedure template" } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meter trigger's work order template." }, "filename": { "type": "string", "description": "Name of the meter trigger's work order template thumbnail, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "body": { "type": "object", "description": "Content type should be `application/octet-stream` and payload should use binary format for the thumbnail." } }, "required": [ "PCID", "id", "filename", "body" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the meter trigger's work order template." }, "filename": { "type": "string", "description": "Name of the attachment, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "body": { "type": "object", "description": "Content type should be `application/octet-stream` and payload should use binary format for the attachment." } }, "required": [ "PCID", "id", "filename", "body" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the procedure template row." }, "filename": { "type": "string", "description": "Name of the attachment, including the extension." }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "body": { "type": "object", "description": "Content type should be `application/octet-stream` and payload should use binary format for the attachment." } }, "required": [ "PCID", "id", "filename", "body" ] } ```