Table of Contents | ||||
---|---|---|---|---|
|
...
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. |
Results
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Lists
Anchor | ||||
---|---|---|---|---|
|
When inserting or updating Equipment records, it is sometimes necessary to provide values that exist elsewhere in the system. The LIST method can help to retrieve available options for these values.
...
Contacts Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Department Hierarchy Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment Catalog Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Expense Types Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
GLAs Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Locations Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
UDF Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Cabling Equipment Types Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment Conditions Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment Statuses Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
VLANs Results
Anchor | ||||
---|---|---|---|---|
|
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Write Call
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
RECID | only when updating | 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 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). *Required if GLA is specified |
Results
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the equipment RECID will be returns as follows:
|
Equipment App Record
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the Recid(s) will be returned in the same order provided:
|
Equipment VLAN Tab App Record
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the Recid of the remark record will be returned as follows:
|
Equipment Remarks Tab App Record
Toggle 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 |
---|---|---|---|---|---|
recid | Conditionally* | Integer | *Required if attempting to UPDATE an Equipment Charge | ||
equipment_recid | yes | Integer | The RECID of the Equipment that the charge is for | ||
charge_recid | yes | Integer | RECID of the applicable charge catalog. | ||
description | no | String | The details or description of the charge on the Equipment | ||
amount | no* | Float | The amount to be charged. *Required if charge does not have an amount on it. | ||
quantity | no | Integer | 1 | Quantity of charge to be used. | |
prorate | no | Integer | 1 or 0 | 0 | Should the charge be prorated when activated |
bill_date | no | String | Date the charge was billed | ||
override_amount | no | Float | If allowed by the selected charge, overrides the default amount from the charge. | ||
override_gla | no | Integer | Recid of GLA to override default GLA with. | ||
stop_date | no | String | The Date the Recuring Charge should stop on. YYYY-MM-DD format. | ||
effective | no | String | today, backdate | today | Effective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API |
Results
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the RECID of the new Equipment charge is returned as follows:
|
Equipment GLA
GLAs 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 | ||
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the RECID(s) of the new Equipment GLA records will be returned in same order provided:
|
Equipment Form GLA Tab App Record
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the RECID(s) of the new Equipment contact records will be returned in same order provided:
|
Equipment Form Contacts Tab App Record
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
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the charge is for | ||
udf_UDF-RECID | yes | Mixed | UDF-RECID is the RECID of the UDF to assign the value to. example: udf_684=value |
Results
Toggle cloak |
---|
Cloak | ||
---|---|---|
If the request is successful, the RECID(s) of the new Equipment UDF records will be returned same order provided:
|
Locating Equipment Data
Within PCR-360, these menu options lists a variety of Grids that can be used to help locate any of the required fields.
...