Maintainx

These are the Maintainx actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create Category

  Tool to create a new category in MaintainX for organizing work orders, assets, and other items. Use when you need to add a new category to the organization's classification system.

• Create Location

  Tool to create a new location in MaintainX. Use when you need to add a new physical location where assets are stored or work is performed. Locations can be organized hierarchically using the parentId parameter.

• Create Procedure Template

  Tool to create a new procedure template in MaintainX with checklist items for work orders. Use when you need to create a standardized procedure that can be attached to work orders. The template can include various field types like text, checkboxes, signatures, and multiple choice options.

• Create Work Order

  This tool creates a new work order in MaintainX. It uses the POST /api/v1/workorders endpoint. The tool requires a 'title' for the work order and offers several optional parameters including description, priority, dueDate, startDate, userIds, teamIds, procedureTemplateId, locationId, assetId, and categories.

• Create Work Order Comment

  This tool creates a new comment on an existing work order in MaintainX. It allows users to add comments for documentation, updates, or communication purposes within a specific work order. It requires a workOrderId and the text content of the comment to create a new comment on the work order, providing capabilities to update maintenance work order records.

• Create Work Request

  Tool to create a new work request in MaintainX. Use when you need to submit a request for work that can later be converted to a work order. Work requests are typically used to initiate maintenance or service requests that require approval before becoming work orders.

• Create Work Request Portal

  Creates a new work request portal in MaintainX. A work request portal allows users to submit work requests through a dedicated URL. The portal can be customized with a title, welcome text, and description placeholder. It can be associated with a specific location and asset, and can be configured to require email contact information.

• Delete Assets

  Tool to delete an asset from MaintainX by its ID. Use when you need to permanently remove an asset from the system. Returns a success confirmation upon successful deletion (HTTP 204).

• Delete Category

  Tool to delete a category in MaintainX. Use when you need to remove a category from the system. Returns success status upon deletion (HTTP 204).

• Find Entity

  A tool to search and find specific entities within MaintainX by specified fields. This tool allows users to search for different types of entities including work orders, users, and locations.

• Get Category

  Tool to retrieve detailed information about a specific category by its ID. Use when you need to get the label, description, update time, or work order count for a category.

• Get Location

  Tool to retrieve detailed information about a specific location by its ID. Use when you need to get comprehensive details including address, attachments, child locations, and custom fields for a location.

• Get User

  Tool to retrieve detailed information about a specific user by their ID. Use when you need to get user data including name, email, role, hourly rate, and custom fields.

• Get Vendor

  Tool to retrieve detailed information about a specific vendor by its ID. Use when you need to get comprehensive details about a vendor including contact information, attachments, and custom fields.

• Get Work Order Costs

  Tool to retrieve costs information for a specific work order by its ID. Use when you need to get detailed cost breakdown including total costs and individual cost rows for a work order.

• List Asset Criticalities

  Tool to retrieve a list of asset criticalities from MaintainX. Use when you need to get all available asset criticality levels in the organization, optionally filtered by label or level.

• List Assets

  This tool allows users to retrieve a list of all assets in their organization.

• List Categories

  This tool retrieves a list of all categories in your MaintainX organization. Categories are used to organize and classify work orders, assets, and other items in the system. It supports listing the categories with pagination and provides details such as category_id, name, description, and timestamps for creation and update.

• List Locations

  This tool retrieves a list of all available locations in the organization's MaintainX account. The locations can be physical places where assets are located, work is performed, or maintenance is needed.

• List Meters

  Tool to list all meters in your organization. Use this to retrieve meter information including measurement types, units, and readings.

• List Parts

  Tool to list parts/inventory items with pagination and filtering. Use when you need to retrieve available parts from the organization's inventory.

• List Procedure Templates

  Tool to list procedure templates from MaintainX. Use when you need to retrieve available procedure templates that can be used in work orders.

• List Teams

  This tool retrieves a list of all teams in your MaintainX organization.

• List Work Orders

  Action to list work orders from MaintainX.

• List Work Request Portals

  Tool to list all work request portals in your MaintainX organization. Use when you need to retrieve available work request portals for managing external work requests.

• List Work Requests

  Tool to retrieve a list of work requests from MaintainX. Use when you need to view all work requests. Supports pagination for large result sets using cursor and limit parameters.

• Update Work Order

  This tool allows users to update an existing work order in MaintainX by modifying specific attributes without affecting other unchanged fields. It requires the workorder_id and at least one of the optional parameters (title, description, or priority) to perform the update.

• Update Work Order Status

  This tool allows users to update the status of a specific work order in MaintainX. It is focused specifically on status updates, making it more streamlined than the comprehensive 'Update Work Order' action which allows updating multiple fields.

• Update Work Request Portal

  Updates an existing work request portal in MaintainX. Tool to update work request portal information such as title, welcome text, contact information, and notification settings. Use when modifying an existing portal's configuration.

• Update Vendor Attachment

  Tool to update a vendor attachment in MaintainX. Use when you need to upload or replace a file attachment for a specific vendor. The file is uploaded as binary data.