Skip to main content
Version: V2 (Ignition 8.1)

Equipment API

Welcome to the Equipment API documentation. This API provides a comprehensive set of functions for managing equipment, equipment classes, equipment properties, and equipment property values within the system. Below is a list of available functions, each with a brief description and a link to its detailed documentation.

Equipment Class Functions​

newEquipmentClass​

Generates an empty non-persisted Equipment Class object to provide the structure required by the API to save a new record. Must be combined with saveEquipmentClass to persist the record.

saveEquipmentClass​

Creates or updates an Equipment Class record. Returns a JSON representation of the saved equipment class.

findEquipmentClasses​

Retrieves Equipment Class records based on pagination, sort, and filter parameters. Returns a Query Result object.

getEquipmentClass​

Retrieves an Equipment Class record by its ID or path. Returns nothing if no equipment class is found.

getAllEquipmentClasses​

Retrieves a list of all Equipment Class records in the system.

getAllEquipmentClassPaths​

Retrieves a list of all Equipment Class path strings in the system.

getEquipmentClassReferences​

Retrieves a list of references to an Equipment Class record by its ID or path.

validateEquipmentClass​

Validates the specified parameters for an Equipment Class record and returns any validation errors.

deleteEquipmentClass​

Deletes an Equipment Class record by its ID or path. Cannot delete a class with references.

deleteAllEquipmentClasses​

Deletes multiple Equipment Class records by their IDs or paths.

createEquipmentClassesForPath​

Creates all Equipment Class records needed to represent the given hierarchical path, creating any intermediate classes that do not already exist.

Equipment Functions​

newEquipment​

Generates an empty non-persisted Equipment object to provide the structure required by the API to save a new record. Must be combined with saveEquipment to persist the record.

saveEquipment​

Creates or updates an Equipment record. Returns a JSON representation of the saved equipment.

findEquipment​

Retrieves Equipment records based on pagination, sort, and filter parameters. Returns a Query Result object.

getEquipment​

Retrieves an Equipment record by its ID or path. Returns nothing if no equipment is found.

getAllEquipment​

Retrieves a list of all Equipment records in the system.

getAllEquipmentPaths​

Retrieves a list of all Equipment path strings in the system.

getEquipmentReferences​

Retrieves a list of references to an Equipment record by its ID or path.

validateEquipment​

Validates the specified parameters for an Equipment record and returns any validation errors.

deleteEquipment​

Deletes an Equipment record by its ID or path. Cannot delete equipment with references.

deleteAllEquipments​

Deletes multiple Equipment records by their IDs or paths.

Equipment Property Functions​

newEquipmentProperty​

Generates an empty non-persisted Equipment Property object to provide the structure required by the API to save a new record. Must be combined with saveEquipmentProperty to persist the record.

saveEquipmentProperty​

Creates or updates an Equipment Property record. Returns a JSON representation of the saved equipment property.

findEquipmentProperties​

Retrieves Equipment Property records based on pagination, sort, and filter parameters. Returns a Query Result object.

getEquipmentProperty​

Retrieves an Equipment Property record by its ID or name. Returns nothing if no equipment property is found.

getAllEquipmentProperties​

Retrieves a list of all Equipment Property records in the system.

getEquipmentPropertyReferences​

Retrieves a list of references to an Equipment Property record by its ID or name.

validateEquipmentProperty​

Validates the specified parameters for an Equipment Property record and returns any validation errors.

deleteEquipmentProperty​

Deletes an Equipment Property record by its ID or name. Cannot delete a property with references.

deleteAllEquipmentProperties​

Deletes multiple Equipment Property records by their IDs or names.

Equipment Property Value Functions​

newEquipmentPropertyValue​

Generates an empty non-persisted Equipment Property Value object to provide the structure required by the API to save a new record. Must be combined with saveEquipmentPropertyValue to persist the record.

saveEquipmentPropertyValue​

Creates or updates an Equipment Property Value record. Returns a JSON representation of the saved equipment property value.

getEquipmentPropertyValue​

Retrieves an Equipment Property Value record directly by its ID. Returns nothing if no equipment property value is found.

getEquipmentPropertyValuesForEquipment​

Retrieves a list of all Equipment Property Value records for a given equipment. Returns a list of JSON objects.

getPropertiesAndValuesForEquipment​

Retrieves a combined list of equipment properties and their values for a given equipment. Returns a list of JSON objects.

getValueForEquipmentAndProperty​

Retrieves an Equipment Property Value record by its equipment ID or path and property ID or name. Returns nothing if no record is found.

setEquipmentPropertyValue​

Sets the value of an Equipment Property Value record given an equipment ID or path and a property ID or name, creating the record if it does not already exist. Returns a JSON representation of the saved equipment property value.

validateEquipmentPropertyValue​

Validates the specified parameters for an Equipment Property Value record and returns any validation errors.

getEquipmentPropertyValueReferences​

Retrieves a list of references to an Equipment Property Value record by its ID.

deleteEquipmentPropertyValue​

Deletes an Equipment Property Value record by its ID.

deleteEquipmentPropertyValueFor​

Deletes an Equipment Property Value record by its equipment ID or path and property ID or name.

deleteEquipmentPropertyValues​

Deletes multiple Equipment Property Value records by their IDs.

deleteEquipmentPropertyValuesFor​

Deletes Equipment Property Value records for a given equipment, filtered to the specified list of property IDs or names.

Import and Export Functions​

importFromCsv​

Imports Equipment records from a CSV-formatted string. Returns an ApiResponse indicating success or failure.

importFromJson​

Imports Equipment records from a JSON-formatted string. Returns an ApiResponse indicating success or failure.

exportAsCsv​

Exports all Equipment records as a CSV-formatted string.

exportAsJson​

Exports all Equipment records as a JSON-formatted string.

getEquipmentImportQueueSize​

Returns the number of Equipment import jobs currently waiting in the import queue.

cancelEquipmentImportQueue​

Cancels all pending Equipment import jobs in the import queue.

Property Import and Export Functions​

importPropertiesFromCsv​

Imports Equipment Property records from a CSV-formatted string. Returns an ApiResponse indicating success or failure.

importPropertiesFromJson​

Imports Equipment Property records from a JSON-formatted string. Returns an ApiResponse indicating success or failure.

exportPropertiesAsCsv​

Exports all Equipment Property records as a CSV-formatted string.

exportPropertiesAsJson​

Exports all Equipment Property records as a JSON-formatted string.

Permissions and Cache Functions​

getEquipmentPermissions​

Retrieves the permissions associated with the Equipment module for the currently authenticated user.

clearEquipmentCache​

Clears the cached Equipment records, forcing the next read to retrieve fresh data from the database.

clearEquipmentClassCache​

Clears the cached Equipment Class records, forcing the next read to retrieve fresh data from the database.

Explore each function's documentation for detailed usage examples and additional information.

Last updated on by SholomEllenbogenTamaki