The Inventory Web API offers a way to programmatically access assets and their details. The Web API can be used to update existing assets in the Inventory or create new ones. To provide the user with a complete view, there are also handlers to fetch configuration options required for updating or creating assets.
Requests to the Web API are performed in a RESTful way, using the scheme http(s)://[HOST]:[PORT]/api/inventory/[Command]
. The Verbs GET
and POST
can be used where applicable.
Note: The Inventory Web API can be used only by users who have the Web API
and at lest Access to Inventory
permission set.
Using the Web API you have access to the following features in the Inventory, provided your user has the required permissions:
The following commands are available for the Ticket Web API:
Command | Description |
---|---|
/<asset-id> | Show details of an asset |
/<asset id>/attachments | A list of attachments for an asset |
/<asset id>/history | The history of changes of an asset |
/<asset id>/archive | Archive an asset |
/<asset id>/unarchive | Un-archive an asset |
/<asset id>/unarchive-all | Un-archive an asset and all its child assets |
/search | Search for an asset using the same syntax as in the UI |
/types | A list of available asset types from the configuration |
/fields | A list of all asset fields from the configuration |
/owner | Intermediate handler |
/owner/<owner id> | Show all fields available from a user |
/sla | List of available Service-Level Agreements from the configuration |
/sla/<sla id> | Show details about a specific SLA |
/license | List of available license types from the configuration |
/license/<license id> | Show details about a specific license |
/vendor | List of available vendors from the configuration |
/vendor/<vendor id> | Show details about a specific vendor |