Table of Contents | ||||
---|---|---|---|---|
|
...
By default, 20 items will be returned at a time. However, you can retrieve up to 50 items in a single API call by changing the ‘limit’ field. If you wish to retrieve more than 50 listings, you can do so by using the 'page' field and making more than one API call.
These parameters are added in addition to any fields from the specific data types.
Parameter | Default | Description |
---|---|---|
limitLIMIT | 20 | Number of listings to show. Maximum is 50. |
pagePAGE | 1 | Page number to show. To view more than 50 listings, make successive API calls while incrementing this field. |
Response Data
Name | Datatype | Searchable | Notes |
---|---|---|---|
BILLABLE | Yes/No | Yes | To indicate whether the Equipment item is or is not Billable. |
EQUIPMENT_ID | string | Yes | Unique identifier of a piece of Equipment; this is required for data Equipment. |
ASSET_TAG | string | Yes | Unique identifier of a piece of Equipment; this is required for Assets. |
SERIAL_NUM | string | Yes | A unique identifier for one individual instance of a piece of Equipment; often supplied by the manufacturer. |
PURCHASE_PRICE / | number | Yes | The price paid upon purchase of the Equipment. Searches can be exact match, greater than, or less than a specified value, respectively. |
CONSUMED | Yes/No | Yes | Shows whether or not an item from inventory is now in use. |
RECEIVED_DATE | string | Yes | Date the piece of Equipment was received. |
BILLED_DATE | string | Yes | Date the piece of Equipment was billed. |
CATALOG | string | Yes | Equipment part number. |
OWNER | string | Yes | The Contact or Dept Hierarchy that owns this piece of Equipment. |
DEPT_HIERARCHY_PATH | string | No | If OWNER is Dept Hierarchy, this will list the hierarchical path to the OWNER. |
LOCATIONS_PATH | string | Yes | The full hierarchical path to the Location of the piece of Equipment; use LOCATIONS for search. |
EQP_STATUS | string | Yes | Current status of the piece of Equipment. Use STATUS for search. |
EQUIPMENT_UDF | list | No | List of all the User Defined Fields and the selected values for this piece of Equipment. |
EQUIPMENT_CHARGES | list | No | Charges listed for the piece of Equipment. |
EQUIPMENT_CONTACTS | list | No | Contacts associated with the piece of Equipment. |
EQUIPMENT_EXPENSE_GLA | list | No | Expense G/L Accounts to be used for billing for the piece of Equipment. |
EQUIPMENT_REMARKS | list | No | List of all remarks/comments for the piece of Equipment. |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 908 |
vlan | 1 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 456231 |
remarks | This is a Remark from the API |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 58337 |
charge_recid | 1 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 2345 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 2345 |
contact | 1 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 765 |
udf_UDF-RECID | 1 |
...