Skip to main content

Operations API

Welcome to the Operations API documentation. This API provides a comprehensive set of functions for managing and interacting with operations in the MES system. Below is a list of available functions, each with a brief description and a link to its detailed documentation.

Function List​

newOperation​

Generates an empty non-persisted Operations object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveOperation method in order to persist the record. Returns a JSON representation of the newly created operation object.

saveOperation​

Creates or updates a Operations record in the system based on the provided parameters. Returns a JSON representation of the saved operation.

findOperations​

Retrieves Operations records based on the specified pagination, sort, and column constraint parameters. Returns a Query Result object.

getOperation​

Retrieves a Operations record by its ID. Returns a JSON representation of the operation.

getOperationsByLocation​

Retrieves all the Operations records at a given location. Returns a list of JSON objects representing all operations at the given location.

getOperations​

Retrieves all the Operations records. Returns a list of JSON objects representing all operations.

getOperationReferences​

Retrieves a list of references to an Operations object by its ID. Returns a list of JSON objects.

getOperationStatus​

Retrieves the status of an Operations object by its ID. Returns the status of the operation.

validateOperation​

Validates the specified parameters for an Operations record and returns any validation errors. This only checks if the operation object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteOperation​

Deletes an Operations record by its ID. This cannot delete an operation with references to it. If successful, an ApiResponse Object is returned with the success bool set True.

startOperation​

Starts an Operations object. Returns a JSON object of the operation execution result for the start of the operation.

stopOperation​

Stops an Operations object. Returns a JSON object of the operation execution result for the end of the operation.

pauseOperation​

Pauses an Operations object. Returns a JSON object of the operation execution result for the suspension of the operation.

setProductionOrderForOperation​

Sets the production order for a given Operations record. No response is returned.

getProductionOrderForOperation​

Retrieves the production order for a given Operations record. Returns a JSON objects representing a production order associated with the operation.

findOperationRecords​

Retrieves Operation Records records based on the specified pagination, sort, and column constraint parameters. Returns a Query Result object.

getActiveOperationRecords​

Retrieves all active Operation Records. Returns a list of JSON objects representing the active operation records.

getOperationRecordForLocationAndDate​

Retrieves a Operation Records record by the location ID or path, the start date and the end date. Returns a JSON representation of the operation record. Returns nothing if no operation record is found.

getOperationRecordReferences​

Retrieves a list of references to an Operation Records object by its ID. Returns a list of JSON objects.

updateOperationStatesFromDatabase​

No Parameter: Updates the states of all the Operations from the database.

With a Parameter: Updates the states of only the specified Operations from the database given the ID of the operations.

If successful, no response is returned.

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