Parts Catalog API Methods
Parts Catalog API provides a set of methods used to manage the Oracle Field Service Parts Catalog.
Catalogs can be created and searched using single operations ('create_catalog' and 'search_catalog', respectively). At the same time, data uploading to an existing catalog involves a series of operations ('start_catalog_transaction', 'upload_catalog', 'commit_catalog_transaction' and 'rollback_catalog_transaction'). Optionally, the list of transactions for a certain catalog upload can be obtained by the 'get_transactions_list' method. Weights can be added or deleted by means of the 'upload_weights' and 'delete_weights' operations. Inventory types of the existing item types can be updated by the 'update_types' method. An entire catalog can be deleted using the 'delete_catalog' method.
The list of all methods that can be implemented with the API and their brief description is provided in the following table for reference. For the details of a specific method please refer to the corresponding section.
Method |
Description |
|---|---|
'create_catalog' |
Creates a new catalog |
'start_catalog_transaction' |
Starts an upload transaction for an existing catalog |
'upload_catalog' |
Uploads data to an existing catalog |
'commit_catalog_transaction' |
Closes an upload transaction for an existing catalog |
'rollback_catalog_transaction' |
Aborts the current transaction and deletes all data uploaded during such transaction |
'search_catalog' |
Searches for existing catalogs |
'upload_weights' |
Uploads item weights to an existing catalog |
'delete_weights' |
Deletes item weights from an existing catalog |
'update_types' |
Updates inventory types of the item types in the catalog |
'delete_catalog' |
Deletes all catalog data |
'get_transactions_list' |
Gets the list of transactions for an existing catalog |
| 'create_catalog' | Creates a new catalog |
| 'start_catalog_transaction' | Starts an upload transaction for an existing catalog |