...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
RECID | no* | Integer | Identifier of the record to be updated | ||
status | yes | Integer | The status of the Equipment | ||
eqp_catalog | yes | Integer | Recid of the Equipment Catalog item | ||
location | no | Integer | Recid of Location | ||
owner | no* | Integer | Record ID of either the Contact or the Department Owner | ||
owner_type | no* | String | "contact" or "department" | Type of Owner. | |
serial_number | no | String | Serial number of Equipment | ||
serial_number_barcode | no | String | Serial number barcode of Equipment | ||
equipment_id | no | String | ID of Equipment | ||
asset_tag | no | String | Asset tag of the Equipment | ||
billable | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment is Billable | |
consumed | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment is consumed | |
purchase_price | no | Decimal | Purchase price of the Equipment | ||
received_date | no | String | Date Equipment was received | ||
billed_date | no | String | Date Equipment was billed | ||
card_number | no | String | Card number of Equipment | ||
parent_equipment | no | Integer | Recid of parent Equipment, if applicable | ||
cabling_equipment_type | no | Integer | Recid of Cabling Equipment type | ||
ip4_gateway | no | String | IPv4 address of gateway for Equipment | ||
ip6_gateway | no | String | IPv6 address of gateway for Equipment | ||
lan_name | no | String | Name of LAN Equipment is attached to | ||
mac | no | String | MAC address of Equipment | ||
ip4 | no | String | IPv4 address of Equipment | ||
ip6 | no | String | IPv6 address of Equipment | ||
ip4_subnet | no | String | IPv4 address for subnet that Equipment is attached to | ||
ip6_subnet | no | String | IPv6 address for subnet that Equipment is attached to | ||
ip4_gateway_address | no | String | IPv4 address of gateway | ||
ip6_gateway_address | no | String | IPv6 address of gateway | ||
host_name | no | String | Host name of Equipment | ||
condition | no | Integer | Recid of condition value for Equipment. | ||
ordered_date | no | String | Date Equipment was ordered | ||
units | no | Quantity on hand | |||
warranty_end_date | no | String | Date that warranty ends on Equipment | ||
use_dhcp | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment uses DHCP | |
private | yes | Integer | 1 = yes; 0 = no | Designate if this Equipment is private | |
vlan | no | Mixed | Recid of VLAN this Equipment belongs to. Multiple Recids can be provided using commas. Example: 23,34 | ||
contact | no | Integer | Recid of the contact(s) to associate this Equipment with | ||
remarks | no | String | Remarks for the Equipment | ||
gla | no | Integer | Recid(s) of GLA record(s) to assign to this Service. If multiple GLAs are to be assigned, separate recids with commas. Example: 874,32. | ||
gla_percent | no* | String | 100 | Percentage(s) of this Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is Conditionally Required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100. | |
gla_type | no* | Integer | Recid(s) of Expense Type(s). |
Results Toggle cloak
...
If the request is successful, the equipment RECID will be returns as follows:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Equipment VLANs
Equipment can be assigned to one or more VLANs.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | Recid of equipment | ||
vlan | yes | String | One or more Recids of VLANs. If multiple, separate with commas. Example: 23,43 |
Results Toggle cloak
...
If the request is successful, the Recid(s) will be returned in the same order provided:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Equipment Remarks
Remarks can be added to Equipment.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | Recid of equipment | ||
remarks | yes | String | The remark to add to the Equipment |
Results Toggle cloak
...
If the request is successful, the Recid of the remark record will be returned as follows:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Cloak | |
---|---|
Equipment Charges
Charges can be easily added to Equipment. If multiple Charges need to be added to Equipment, then separate POST requests will need to be made.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for | ||
gla | yes | String | Record ID(s) of the applicable GLA(s). | ||
gla_percent | yes | String | Percentages to apply to each GLA. All percentages must equal exactly 100. | ||
gla_type | yes | String | The type(s) of GLA(s). |
Results Toggle cloak
...
If the request is successful, the RECID(s) of the new Equipment GLA records will be returned in same order provided:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Equipment Contacts
Contacts can be easily added to Equipment. If multiple charges need to be added to Equipment, then separate each value with commas.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for | ||
contact | yes | String | Record ID(s) of the Contact(s). |
Results Toggle cloak
...
If the request is successful, the RECID(s) of the new Equipment contact records will be returned in same order provided:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Equipment UDFs
User Defined Fields can be easily set for Equipment. To get a list of available UDFs for a piece of Equipment, visit Lists
...