Inventories: List of Tasks

You can perform the following tasks using the Inventories resource:

Task/Method Method Type URI Description

Create Inventory

POST

/rest/ofscCore/v1/inventories

This operation is used to fill customer pool with inventories.

Delete Inventory

DELETE

/rest/ofscCore/v1/inventories/{inventoryId}

This operation deletes the specified inventory.

Get Inventory

GET

/rest/ofscCore/v1/inventories/{inventoryId}

This operation retrieves data on all service requests assigned to the specified inventory.

Update Inventory

PATCH

/rest/ofscCore/v1/inventories/{inventoryId}

This operation changes the specified inventory properties.

Delete file property

DELETE

/rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}

This operation deletes the specified 'file' property for the specific inventory.

Get file property

GET

/rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}

This operation gets the specified 'file' property for the specific inventory.

It's possible to resume an incomplete download by identifying the offset in the range header.

For example, "Range: bytes=1000-" means that downloading starts from offset 1000 bytes up to the end of the file."

Set file property

PUT

/rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}

This operation creates the specified 'file' property for the specific inventory.

Deinstall Inventory

POST

/rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/deinstall

This operation uninstalls inventories of the specified activity.

These inventories have a status of deinstalled.

The quantity must be provided for the nonserialized inventory.

Install Inventory

POST

/rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/install

This operation installs the specified inventory to the specified activity.

After the update, the specified inventory is moved from the resources pool to the 'installed' pool.

These inventories have a status of installed.

Undo Deinstall Inventory

POST

/rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/undoDeinstall

This operation will 'undo' the specified inventory that was uninstalled.

After the update, the specified inventory is moved from the 'Deinstalled' pool to the customer's pool.

The quantity must be provided for the nonserialized inventory.

Undo Install Inventory

POST

/rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/undoInstall

This operation will 'undo' the specified inventory that was installed.

After the update, the specified inventory is moved from the 'install' pool to the resources pool.

The quantity must be provided for the nonserialized inventory.