Requirements
An active Farsight® admin account
Authorized API key
Limitations
GET a Paginated List of Inventory Model Categories (GET /v1/inventorymodelcategories)
This API allows you to get a list of inventory Model Categories from your Farsight® organisation.
The following parameters are used to filter, sort, and paginate the list of assets returned in the response. All parameters are optional unless otherwise noted.
Input Parameter | Type | Required | Definition |
Limit | integer | No | The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25. |
Offset | integer | No | The index of the first item to return. Must be 0 or greater. It is set to 0 by default. |
Create a new Inventory Model Category (POST /v1/inventorymodelcategories)
You can use the API to programmatically create new inventory items
Input Parameter | Type | Required | Definition |
name | string | Yes | The name of the new inventory model category |
{
"name": "string"
}
GET a Inventory Model Category (GET /v1/inventorymodelcategories/{id})
This API allows you to get an inventory model category item from your Farsight® organisation.
The following parameters are used to filter, sort, and paginate the list of assets returned in the response. All parameters are optional unless otherwise noted.
Input Parameter | Type | Required | Definition |
Id | integer | Yes | The ID of the inventory model category |
Update a Inventory Model Category (PUT /v1/inventorymodelcategories/{id})
This API allows you to update an inventory model category from your Farsight® organisation.
Input Parameter | Type | Required | Definition |
Id | integer | Yes | The ID of the inventory item |
{
"name": "string"
}
Delete a Inventory Model Category (DELETE /v1/inventorymodelcategories/{id})
This API allows you to delete one inventory model category from your Farsight® organisation.
Input Parameter | Type | Required | Definition |
Id | integer | Yes | The ID of the inventory item |