Production Order API
Welcome to the Production Order API documentation. This API provides a comprehensive set of functions for managing and interacting with production orders within the system. Below is a list of available functions, each with a brief description and a link to its detailed documentation.
Function List
newProductionOrder
Generates an empty non-persisted Production Orders object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveProductionOrder method in order to persist the record. Returns a JSON representation of the newly created production order object.
saveProductionOrder
Creates or updates a Production Orders record in the system based on the provided parameters. Returns a JSON representation of the saved production order.
findProductionOrders
Retrieves Production Orders records based on the specified pagination, sort, and column constraint parameters. Returns a Query Result object.
getProductionOrder
Retrieves a Production Orders record by its ID or name. Returns a JSON representation of the production order.
getAllProductionOrders
Retrieves a list of all Production Orders records in the system. Returns a list of JSON objects representing all production orders.
getProductionOrderReferences
Retrieves a list of references to a Production Orders record by its ID. Returns a list of JSON objects.
getDetailedProductionOrdersByLocationAndStatus
Retrieves a list of detailed Production Orders records filtered by location IDs or paths and statuses. Returns a list of JSON objects with expanded information including property values and bill of materials.
validateProductionOrder
Validates the specified parameters for a Production Orders record and returns any validation errors. This only checks if the production order 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.
deleteProductionOrder
Deletes a Production Orders record by its ID. This cannot delete a production order with references to it. If successful, an ApiResponse Object is returned with the success bool set True.
newProductionOrderProperty
Generates an empty non-persisted Production Order Properties object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveProductionOrderProperty method in order to persist the record. Returns a JSON representation of the newly created production order property object.
saveProductionOrderProperty
Creates or updates a Production Order Properties record in the system based on the provided parameters. Returns a JSON representation of the saved production order property.
getProductionOrderPropertyOrCreateNew
Retrieves a Production Order Properties record if an existing production order property exists with the specified ID or name. Otherwise, creates a new Production Order Properties record with the specified name and attributes. Returns a JSON representation of the production order property.
getProductionOrderProperty
Retrieves a Production Order Properties record by its specified ID or name. Returns a JSON representation of the production order property.
getAllProductionOrderProperties
Retrieves a list of all Production Order Properties records in the system. Returns a list of JSON objects representing all production order properties.
getProductionOrderPropertyReferences
Retrieves a list of references to a Production Order Properties record by its ID. Returns a list of JSON objects.
validateProductionOrderProperty
Validates the specified parameters for a Production Order Properties record and returns any validation errors. This only checks if the production order property 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.
deleteProductionOrderProperty
Deletes a Production Order Properties record by its ID. This cannot delete a production order property with references to it. If successful, an ApiResponse Object is returned with the success bool set True.
newProductionOrderPropertyValue
Generates an empty non-persisted Production Order Property Values object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveProductionOrderPropertyValue method in order to persist the record. Returns a JSON representation of the newly created production order property value object.
saveProductionOrderPropertyValue
Creates or updates a Production Order Property Values record in the system based on the provided parameters. Returns a JSON representation of the saved production order property value.
setPropertyValue
Updates the value of a Production Order Property Values record given a production order ID or name and a property ID or name. Returns a JSON representation of the updated production order property value.
setPropertyValues
getProductionOrderPropertyValue
Retrieves a Production Order Property Values record by its specified ID. Returns a JSON representation of the production order property value.
getProductionOrderPropertyValuesForOrder
Retrieves a list of Production Order Property Values records associated with a production order ID or name. Returns a list of JSON objects representing all production order property values associated with the given production order.
getProductionOrderPropertyValueFor
Retrieves a Production Order Property Values record given a production order ID or name and a property ID or name. Returns a JSON representation of the production order property value.
validateProductionOrderPropertyValue
Validates the specified parameters for a Production Order Property Values record and returns any validation errors. This only checks if the production order property value 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.
deleteProductionOrderPropertyValue
Deletes a Production Order Property Values record by its ID. This cannot delete a production order property value with references to it. If successful, an ApiResponse Object is returned with the success bool set True.
newBillOfMaterialsItem
Generates an empty non-persisted Production Order Bill of Materials object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveBillOfMaterials method in order to persist the record. Returns a JSON representation of the newly created bill of materials object.
saveBillOfMaterialsItem
Creates or updates a Production Order Bill of Materials record in the system based on the provided parameters. Returns a JSON representation of the saved bill of materials.
getBillOfMaterialsItem
Retrieves a Production Order Bill of Materials record by its ID. Returns a JSON representation of the bill of materials.
getBillOfMaterialsForOrder
Retrieves the Production Order Bill of Materials record associated with a production order ID or name. Returns a JSON representation of the bill of materials associated with the given production order.
getBillOfMaterialsForOrderFlattened
Retrieves a flattened representation of all Production Order Bill of Materials records associated with a production order ID or name. This provides an easier-to-consume format where material relationships are flattened out. Returns a list of flattened JSON objects representing the bill of materials.
getBillOfMaterialsFor
Retrieves the Production Order Bill of Materials record associated with a production order ID or name and a material ID or path. Returns a JSON representation of the bill of materials associated with the given production order and material.
validateBillOfMaterialsItem
Validates the specified parameters for a Production Order Bill of Materials record and returns any validation errors. This only checks if the bill of materials 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.
deleteBillOfMaterialsItem
Deletes a Production Order Bill of Materials record by its ID. This cannot delete a bill of materials with references to it. If successful, an ApiResponse Object is returned with the success bool set True.
swapBillOfMaterialsPositions
Swaps the position values of two Production Order Bill of Materials records within the same production order. This is useful for reordering bill of materials items in a user interface. If successful, an ApiResponse Object is returned with the success bool set True.
deleteBillOfMaterialsForOrder
Deletes all Production Order Bill of Materials records associated with a production order ID or name. This cannot delete any bill of materials with references to it. If successful, an ApiResponse Object is returned with the success bool set True.
Explore each function’s documentation for detailed usage examples and additional information.