Categories
The available APIs for categories are explained below.
inventory/category/add
This adds a category to the Equotix One account.
Path
/api/inventory/category/add
POST Parameters
| Name | Type | Required | Description |
| domain | string | Yes | The domain you are assigned to authenticate your Equotix One account. |
| api_key | string | Yes | The email address assigned to the user account in your Equotix One. |
| auth_timestamp | int | Yes | The unix timestamp used to sign this API request. |
| auth_signature | string | Yes |
The calculated signature for this API request. |
| parent_id | int | Yes | The parent ID for the category. Use 0 if is a parent itself. |
| name | string | Yes |
The name of the category. |
| image | string | Yes |
The image URL or file path to the image stored on Equotix One. Leave empty if none. |
Response Parameters
| Name | Type | Description |
| success | boolean | True if added. |
| category_id | int | The newly added category ID. |
| error | object | The errors relating to the API call. |
inventory/category/edit
This edits a category in the Equotix One account.
Path
/api/inventory/category/edit
POST Parameters
| Name | Type | Required | Description |
| domain | string | Yes | The domain you are assigned to authenticate your Equotix One account. |
| api_key | string | Yes | The email address assigned to the user account in your Equotix One. |
| auth_timestamp | int | Yes | The unix timestamp used to sign this API request. |
| auth_signature | string | Yes |
The calculated signature for this API request. |
| category_id | int | Yes |
The category ID to edit. |
| parent_id | int | Yes |
The parent ID for the category. Use 0 if is a parent itself. |
| name | string | Yes |
The name of the category. |
| image | string | Yes |
The image URL or file path to the image stored on Equotix One. Leave empty if none. |
Response Parameters
| Name | Type | Description |
| success | boolean | True if edited. |
| category_id | int | The edited category ID. |
| error | object | The errors relating to the API call. |
inventory/category/delete
This deletes a category from the Equotix One account.
Path
/api/inventory/category/delete
POST Parameters
| Name | Type | Required | Description |
| domain | string | Yes | The domain you are assigned to authenticate your Equotix One account. |
| api_key | string | Yes | The email address assigned to the user account in your Equotix One. |
| auth_timestamp | int | Yes | The unix timestamp used to sign this API request. |
| auth_signature | string | Yes |
The calculated signature for this API request. |
| category_id | int | Yes |
The category ID. |
Response Parameters
| Name | Type | Description |
| success | boolean | True if deleted. |
| error | object | The errors relating to the API call. |
inventory/category/get
This gets a list of categories or a specific category from the Equotix One account.
Path
/api/inventory/category/get
POST Parameters
| Name | Type | Required | Description |
| domain | string | Yes | The domain you are assigned to authenticate your Equotix One account. |
| api_key | string | Yes | The email address assigned to the user account in your Equotix One. |
| auth_timestamp | int | Yes | The unix timestamp used to sign this API request. |
| auth_signature | string | Yes |
The calculated signature for this API request. |
| category_id | int | No |
The category ID to search for specifically. |
| filter_name | string | No |
Filter the results by category name. |
| filter_date_modified | string | No |
Filter the results by categories modified after this date. |
| page | int | No |
Page number of the results. |
Response Parameters
| Name | Type | Description |
| categories | object | The categories results. |
| > category_id | int | The category ID. |
| > parent_id | int | The parent category ID. |
| > name | string | The category name. |
| > image | string | The category image URL. |
| > category_name | string | The full path for the category name. |
| > date_modified | string | The date and time category was last modified. |
| total | int | The total number of results. |
Comments
0 comments
Article is closed for comments.