Introduction

The in\site API is a programming interface that gives you direct access to the business intelligence information available through in\site from your own internal I.T. platform. This allows you to grow your brand without requiring users to learn a new system.

By leveraging the power of the API, you can directly access information from any of the following areas of in\site from your own systems:

  • Tickets
    • Create new Support and Shipping Tickets
    • View one or more existing tickets
    • Update existing tickets
  • Transactions
    • View summary information related to sales orders, service orders, and invoices
  • Data Center Access Log
    • See who entered the facility and when
  • in\site Access Log
    • See who is accessing in\site and when
  • Power Usage
    • View current power utilization for all of your cabinets or power circuits
    • View up to 100 days of past usage history for any of your cabinets or power circuits
  • Bandwidth Usage
    • View current bandwidth usage for all of your vXchnge provided bandwidth services
    • View up to 100 days of past bandwidth usage history
  • Bandwidth and Power Threshold Notifications
    • View threshold overage notifications for your vXchnge bandwidth services or power circuits
  • Data Center Inventory
    • See your collocation inventory (cabinets, power circuits, cross connects, and vXchnge provided bandwidth services)
    • Update existing items with your own custom name (customer tag)
  • Asset Compliance
    • View the list of rack mounted I.T. assets, their makes and models, their positions within the cabinets, and their status
  • User Management
    • Access your company's user list, including all users' authorizations
Before using the API, you must first create a set of credentials to use.

API Credentials

In order to connect to the in\site system, so that you can begin making API calls, you must first create a unique set of credentials under the User Management area of in\site.

How to create in\site API credentials:

  1. Login to in\site with an account that has the Master Admin role or User Manager access.
  2. Open the User Management area.
  3. Click New User in the upper right.
  4. Enter a first name and last name for the account, such as in\site API, or something similar to help easily identify the account that will be used to make API calls.
  5. Enter a unique email address to use for the account.
  6. Enter any phone number into one of the phone number fields.
  7. Enable the User allowed to perform access via API option near the bottom.
  8. Next, enable the in\site Access option and disable the Send welcome email option if it is available.
  9. Enter a password that you would like to use with the API account and then re-enter it into the Confirm Password field.
  10. Specify the areas of in\site to which you want to grant the account access. To grant access to all areas, enable the 'Modify' radio buttons for everything listed under the Authorizations section and then enable all check boxes under the Access section.
  11. Click Submit to create the account.

You are now ready to begin using this email address and password to Login to the in\site system to run API calls.

APIs

in\site API
https://insite.vxchnge.com:8443/insite
in\site API to communicate with external applications.

API Support
Version 1.0


Security Definitions
basicAuth

type basic

Login

/api/v1/login

GET
Please pass username and password credentials with Authorization header; use request parameters for testing purposes only!

Request
Parameters

Name Located in Required Description Default Schema

username

query

yes

Email address used to login

-

string

password

query

yes

Password used to login

-

string

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

 

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Logout

/api/v1/logout

GET
Logout and close session

Request
Parameters

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

 

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Assets

/api/v1/assets

GET
Retrieve assets that belong to the customer

Request
Parameters

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Asset Details]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Data Center Access Log

/api/v1/dataCenterAccessLogs

GET
Retrieve data center access logs created by users that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

numberOfDays

query

no

Number of days to retrieve data center access logs for 

90

integer(int32)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Datacenter Access Log Entry]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

in\site Access Log

/api/v1/insiteAccessLogs

GET
Retrieve in\site access logs created by users that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

numberOfDays

query

no

Number of days to retrieve in\site access logs for 

90

integer(int32)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[in\site Access Log Entry]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Data Center Inventory

/api/v1/inventory

PUT
Assign a customer-specific tag to inventory items

Request
Parameters

Name Located in Required Description Default Schema

inventoryId

query

yes

Id of the inventory item to update 

-

integer(int32)

inventoryType

query

yes

Type of inventory item to update

Allowable values: CABINETS, CROSS_CONNECTS, POWER_CIRCUITS

-

 

string

customerTag

query

yes

Tag value to assign

-

string

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

 

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Cabinets

/api/v1/inventory/cabinets

GET
Retrieve cabinets that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all cabinets will be returned.

-

Array[integer] (multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Cabinet]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Cross Connects

/api/v1/inventory/crossConnects

GET
Retrieve cross connects that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all cross connects will be returned.

-

Array[integer] (multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Cross Connect]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

IP Bandwidth Services

/api/v1/inventory/bandwidths

GET
Retrieve IP bandwidth services that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all bandwidth services will be returned.

-

Array[integer] (multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[IP Bandwidth Service]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Bandwidth Usage (Historical)

/api/v1/usage/bandwidth

GET
Request generation of bandwidth usage of a bandwidth service over time. The return values are in 5 minute increments for the given date range. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

The date range specified must be 100 days or less.

Request
Parameters

Name Located in Required Description Default Schema

inventoryid

query

yes

The inventory id of the bandwidth service

-

integer (int32)

start

query

yes

The start date in UTC, i.e. 1/01/2019 5:20 PM

-

string (date-time)

end

query

yes

The end date in UTC, i.e. 1/31/2019 5:20 PM

NOTE: The date range specified must be 100 days or less.

-

string (date-time)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

results id

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Bandwidth Usage (Current)

/api/v1/usage/bandwidths/current

GET
Request generation of current bandwidth usage for bandwidth services that belong to the customer. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all bandwidth services will be returned

-

Array[integer](multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

integer(int32)

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Bandwidth Notifications

/api/v1/notifications/bandwidth

GET
Retrieve bandwidth notifications

Request
Parameters

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Bandwidth Notification]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Power Circuits

/api/v1/inventory/powerCircuits

GET
Retrieve power circuits that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all power circuits will be returned.

-

Array[integer] (multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Power Circuit]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Power Usage (Cabinet Historical)

/api/v1/usage/cabinet

GET
Request generation of power usage data (kilowatts) for a cabinet over time. The return values are in 5 minute increments for the given date range. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

The date range specified must be 100 days or less.

Request
Parameters

Name Located in Required Description Default Schema

inventoryid

query

yes

The inventory id of the cabinet

-

integer (int32)

start

query

yes

The start date in UTC i.e. 1/01/2019 5:20 PM

-

string (date-time)

end

query

yes

The end date in UTC i.e. 1/31/2019 5:20 PM

-

string (date-time)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

integer(int32)

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Power Usage (Cabinets Current)

/api/v1/usage/cabinets/current

GET
Request generation of current power usage data (kilowatts) for cabinets. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all cabinets will be returned.

-

Array[integer] (multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

integer(int32)

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Power Usage (Power Circuit Historical)

/api/v1/usage/powerCircuit

GET
Request generation of power usage data for a power circuit over time. The return values are in 5 minute increments for the given date range. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

When requesting power from a circuit that is a member of a circuit pair, three data points will be returned for each 5 minute interval (one for the primary, one for the redundant, and one for the combined total of the pair).

The date range specified must be 100 days or less.

Request
Parameters

Name Located in Required Description Default Schema

inventoryid

query

yes

The inventory id of the power circuit

-

integer (int32)

powerType

query

yes

The type of power to return.

Allowable values: AMPS, KW

AMPS

string

start

query

yes

The start date in UTC i.e. 1/01/2019 5:20 PM

-

string (date-time)

end

query

yes

The end date in UTC i.e. 1/31/2019 5:20 PM

-

string (date-time)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

integer(int32)

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Power Usage (Power Circuits Current)

/api/v1/usage/powerCircuits/current

GET
Request generation of current power usage data for power circuits. If the call is successful, the response is a results id, which must be used as a parameter for a subsequent call /api/v1/usage/results to obtain the usage data.

Request
Parameters

Name Located in Required Description Default Schema

inventoryids

query

no

Optional list of inventory ids. If not provided all power circuits will be returned.

-

Array[integer] (multi)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

integer(int32)

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Power and Bandwidth Usage Results

/api/v1/usage/results

GET
Retrieve power and bandwidth usage data whose generation was previously requested by bandwidth usage or power usage API calls. Data must be retrieved by the same API user that requested data generation.

Data may not be available immediately: status code in the response should be checked, and if a code of 102 (Processing) is returned, further attempts should be made, until a code of 200 (Success) is returned.

Data may only be retrieved once: after a successful data retrieval with a results id, further attempts to retrieve data for the same results id will return a response status code of 410 (Already Retrieved).

Information may be retrieved up to 24 hours after the call that requested the data.

Request
Parameters

Name Located in Required Description Default Schema

id

query

yes

Results Id returned from bandwidth usage or power usage API call.

-

integer (int32)

 

Response
Content-Type: application/json

Status Code Reason Response Model

102

Processing

-

200

Success

Array[Power and Bandwidth Usage Information]

400

Bad Request

-

401

Unauthorized

-

404

Not Found

-

410

Already retrieved

 

500

Failure

-

Power Notifications

/api/v1/notifications/power

GET
Retrieve power notifications

Request
Parameters

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Power Notification]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Ticket

/api/v1/ticket

GET
Retrieve single ticket details

Request
Parameters

Name Located in Required Description Default Schema

ticketId

query

yes

Id of the ticket to retrieve

-

integer (int32)

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Ticket Details

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

 

PUT
Update single ticket

Request
Parameters

Name Located in Required Description Default Schema

ticket

body

yes

See Ticket Details to determine which fields are used for each service type.

Examples:

{application/json=[{ "id": 123, "contactId": 12345, "datacenter":
"CA01", "expectedDeliveryDate": "10/21/2016", "newMessage":
"Another comment about ticket processing", "serviceType":
"SHIPPING", "shipmentDirection": "TO_VXCHNGE",
"shippingAccountNumber": "SH12345", "shippingCarrier": "USPS",
"shippingQuantity": 5, "shippingRecipient": "John Doe", "subject":
"Ship Cables, Power and Network", "trackingNumber": "123456"
}}

-

Ticket Details

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Ticket Details

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

 

POST
Create a new ticket

Request
Parameters

Name Located in Required Description Default Schema

ticket

body

yes

See Ticket Details to determine which fields are used for each
service type.
Examples:
{application/json={ "contactId": 12345, "datacenterId": "CA01",
"expectedDeliveryDate": "10/21/2016", "newMessage": "A
comment about ticket processing", "otherCarrierName":
"Lasership", "serviceType": "SHIPPING", "shipmentDirectionId":
"TO_VXCHNGE", "shippingAccountNumber": "SH12345",
"shippingCarrier": "OTHER", "shippingQuantity": 5,
"shippingRecipient": "John Doe", "subject": "Ship Cables, Power
and Network", "trackingNumber": "123456" }}

-

Ticket Details

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Ticket Details

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Tickets

/api/v1/tickets

GET
Retrieve tickets that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

type

query

yes

Type of tickets to return.

Allowable values: ALL, SHIPPING, SUPPORT

ALL

string

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Ticket Information]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

 

Transactions

/api/v1/transactions

GET
Retrieve transactions that belong to the customer

Request
Parameters

Name Located in Required Description Default Schema

type

query

yes

Type of transactions to return. ORDERS returns Sales and Service Orders

Allowable values: ALL, INVOICES, ORDERS

ALL

string

 

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[Transaction Information]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

 

Users

/api/v1/users

GET
Retrieve users that belong to the customer

Request
Parameters

Response
Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[User Information]

400

Bad Request

-

401

Unauthorized

-

500

Failure

-

Definitions

in\site API
https://insite.vxchnge.com:8443/insite
in\site API to communicate with external applications.

API Support
Version 1.0

Asset Details

 

name type required description example

assetName

string

read-only

Asset name

CGD01N03

datacenter

string

read-only

Data center

CA01 - Santa Clara

cabinetName

string

read-only

Cabinet name

CA01:F01:Dh0001::P01:CAB01

lastSeenDate

string (date-time)

read-only

Last seen date/time in UTC

9/12/2016 03:10 AM

addedDate

string (date-time)

read-only

Date added date/time in UTC

8/24/2016 11:05 PM

lastModifiedDate

string (date-time)

read-only

Last modified date/time in UTC

9/12/2016 03:10 AM

status

string

read-only

Status

Development

tagNumber

string

read-only

Tag number

A00000411002820160612110

position

number (float)

read-only

Position

17,0

description

string

read-only

Description

HP Proliant server for DB

serialNumber

string

read-only

Serial number

USB744LCFG

manufacturer

string

read-only

Manufacturer

HP

modelNumber

string

read-only

Model number

DL580 G7

modelDescription

string

read-only

Model description

HP PROLIANT DL580 G7

assetStatus

string

read-only

Asset Status

Verified

userDefinedFields

array[User Defined Field]

read-only

User-Defined Fields

[{"name":"Next Refresh Date","value":"02/07/2018"},{"name":"LOB","value";"construction"}]

Bandwidth Notification

 

name type required description example

notificationDate

string (date-time)

read-only

Notification date/time in UTC

8/24/2016 11:05 PM

notificationId

integer (int32)

read-only

Notification Id

 

threshold

integer (int32)

read-only

Set Threshold %

 

thresholdExceededCount

integer (int32)

read-only

# Times threshold exceeded

 

maxValuePercents

integer (int32)

read-only

Max %

 

maxValueDate

string (date-time)

read-only

Max threshold date/time in UTC

8/24/2016 11:05 PM

maxValue

number (float)

read-only

Max Value

 

ipService

string

read-only

IP service

 

commitRate

integer (int32)

read-only

Commit rate

 

attribute

string

read-only

Attribute

 

Cabinet

 

name type required description example

inventoryid

integer(int32)

read-only

Inventory id

12345

companyName

string

read-only

Company Name

Nakatomi Trading Co

datacenter

string

read-only

Data center

CA01 - Santa Clara

name

string

read-only

Name

CA01:F01:DH0001::P01:CAB01

legacyid

string

read-only

Legacy Id

C1-D1-P11-C01

customerTag

string

read-only

Customer Tag

A183854

status

string

read-only

Status

Assigned

lockType

string

read-only

Lock Type

Combination Lock

type

string

read-only

Cabinet Type

47U43D19F

floor

string

read-only

Floor

F01

cage

string

read-only

Cage

C001

pod

string

read-only

Pod

P16

row

string

read-only

Row

R53

room

string

read-only

Room

DH0001

cabinetName

string

read-only

Cabinet Name

CAB_BI59

cabinetIdentifier

string

read-only

Cabinet Identifier

CA01:F01:DH0001::P16:CAB_BI59

Cross Connect

 

name type required description example

inventoryid

integer(int32)

read-only

Inventory id

12345

companyName

string

read-only

Company Name

Nakatomi Trading Co

datacenter

string

read-only

Data center

CA01 - Santa Clara

name

string

read-only

Name

CA01:F01:DH0001::P01:CAB01

legacyid

string

read-only

Legacy Id

C1-D1-P11-C01

customerTag

string

read-only

Customer Tag

A183854

status

string

read-only

Status

Assigned

providerCircuitId

string

read-only

Provider circuit Id

P11-C5 (7 xconnects, readOnly = true)

mediaType

string

read-only

Media type

Single-Mode Fiber

a_SideName

string

read-only

A-side cabinet, panel, and port information

P11:CAB01:P011:001

z_SideName

string

read-only

Z-side cabinet, panel, and port information

CA01:F01:DH0001:P01:CAB01:P002:003:004

z_SideCompany

string

read-only

Z-side company name

Nakatomi Terminators Ltd

crossConnectIdentifier

string

read-only

Cross connect Id

MN01-NET-1111-194237

Data Center Access Log Entry

 

name type required description example

id

integer(int32) read-only internal Id of the Entry 123456

companyId

integer(int32) read-only Internal Id of the Company 2345

contactId

integer(int32) read-only Internal Id of the Contact 1234
datacenter

string

read-only Data Center CA01 - Santa Clara
companyName

string

read-only Company Name Nakatomi Trading Co
eventTime string(date-time) read-only Event date/time in UTC 1/31/2016 5:20 PM
firstName

string

read-only Contact's Firstname Terrance
lastName

string

read-only Contact's Lastname Foght
authorizedName

string

read-only Authorized Name Muriel Stoffay
eventDescription

string

read-only Event Description Main Entrance
readerResponse

string

read-only Reader Response Accepted
guestAccess

boolean

read-only Guest Access true
authorizedBy

string

read-only Authorized By Dexter Snexoot

ticketId

string

read-only

Internal Id of the Ticket Associated with Access

9876

guestCompany

string

read-only

Guest's Company Name

Acme Corp.

IP Bandwidth Service

 

name type required description example
inventoryId integer(int32) read-only inventory id 12345
companyName string read-only Company Name Nakatomi Trading Co
datacenter string read-only Data Center CA01 - Santa Clara
name

string

read-only Name CA01:F01:DH0001::P01:CAB01
legacyId

string

read-only Legacy Id C1-D1-P11-C01
customerTag string read-only Customer Tag A183854
type

string

read-only Type VRP2
commitRate

string

read-only Commit Rate 40
peakRate

string

read-only Peak Rate 20
crossConnects

string

read-only Cross Connects TN01-NET-19695:73-89686,TN01-NET-19695:73-89688
interfaces

string

read-only Interfaces TN01-NDI-19695:73-CAS1-ge-0/0/6,TN01-NDI-19695:73-CAS2-ge-0/0/6
ipBlocks

string

read-only IP Blocks 66.179.211.192 / 27,66.45.81.200 / 29

Power Circuit

 

name type required description example
inventoryId integer(int32) read-only inventory id 12345
companyName string read-only Company Name Nakatomi Trading Co
datacenter string read-only Data Center CA01 - Santa Clara
name

string

read-only Name CA01-PWR-9876:5-43210
legacyId

string

read-only Legacy Id C1-D1-P11-C01
customerTag string read-only Customer Tag A183854
status

string

read-only Status Assigned
volts

string

read-only Volts 208
usableKW

string

read-only Usable kW 8.64
ratedAmps

string

read-only Rated Amps 30
plugType

string

read-only Plug Type L21-30
cabinet

string

read-only Cabinet Assignment CA01:F01:DH0001::P01:CAB01
isPairedCircuit

string

read-only Is Paired Circuit T
pairedCircuitId

integer(int32)

read-only Paired Circuit ID 2179
pairedCircuit

string

read-only Paired Circuit CA01-PWR-12345:6-7890
polePosition1

string

read-only Pole Position 1 PA01:F05:EL0510:::LP U1A1:P001:32
polePosition2

string

read-only Pole Position 2 PA01:F05:EL0510:::LP U1A1:P001:34
polePosition3

string

read-only Pole Position 3 PA01:F05:EL0510:::LP U1A1:P001:36
powerCircuitIdentifer

string

read-only Power Circuit Identifier MN01-NET-1111-194237

 

Power Notification

 

name type required description example
notificationDate string(date-time) read-only Notification date/time in UTC 8/24/2016 11:05 PM
notificationId integer(int32) read-only Notification id 12345
threshold integer(int32) read-only Set Threshold % 100
thresholdExceeededCount

integer(int32)

read-only # Times threshold exceeded 5
maxValuePercents

integer(int32)

read-only Max % 105
maxValueDate string(date-time) read-only Max threshold date/time in UTC 8/24/2016 11:05 PM
maxValue

number(float)

read-only Max Value 25.2
cabinetName

string

read-only Cabinet name CA01:F01:DH0001::P01:CAB01
powerCircuit

string

read-only Power circuit CA01-PWR-12345:6-7890
usableAmps

number(float)

read-only Usable amps 24

 

Power and Bandwidth Usage Information

 

name type required description example
inventoryIds array[integer] read-only If power is requested, the inventory Id(s) of the cabinet/power circuit(s) measured. If bandwidth is requested, the inventory id of the bandwidth service measured. [288219]
cabinetId integer(int32) read-only The cabinet id of the power item measured. Only applicable if power is requested. 2882
down number(double) read-only Download rate in bits/sec. Only applicable if bandwidth is requested. 11.2
up number(double) read-only Upload rate in bits/sec. Only applicable if bandwidth is requested. 12.8
amps number(double) read-only Amps used. Only applicable if power is requested. 5.2
kW number(double) read-only Kilowatts used. Only applicable if power is requested. 1.8
date string(date-time) read-only The date/time of the measurement. 1/31/2016 5:20 PM

 

Ticket Details

 

* Shipping Tickets Only

** Site Access Tickets Only

name type required description example
Id integer(int32) required

Internal id of the ticket;

Will be auto-generated on create, required for update

12345
ticketNumber string read-only

Ticket number;

Will be auto-generated on create

ST234567
internalId string optional Customer Internal ID Number ID-1234567
companyName string read-only Company Name Nakatomi Trading Co
serviceType

string

Allowable values: SITE_ACCESS, STANDARD_SUPPORT, SERVICE_TROUBLE, SHIPPING

required Support Type STANDARD_SUPPORT
serviceDescriptionId

string

Allowable values: CIRCUIT_TESTING, CONNECTIVITY_ISSUE, COURTESY_CART, DATA_CENTER_TOUR, EQUIPMENT_CONFIGURATION, EQUIPMENT_INSTALLATION, EQUIPMENT_REBOOT, EQUIPMENT_RELOCATION, EQUIPMENT_REMOVAL, EQUIPMENT_TROUBLESHOOTING, INFORMATION-REQUEST, INVENTORY_REQUEST, POWER_SUPPLY, EQUIPMENT_REPLACEMENT, TAPE_MANAGEMENT, VXCHNGE_INTERNET_ACCESS, DNS_ZONE_MANAGEMENT

required

Service Description Id;

Required on create for STANDARD_SUPPORT and SERVICE_TROUBLE tickets, read-only for other tickets, read-only or tickets on update

INFORMATION_REQUEST
serviceDescription string read-only Service Description Information Request
shipmentDirectionId*

string

Allowable values: TO_VXCHNGE, FROM_VXCHNGE

required Shipping Direction Id; Required for SHIPPING tickets, read-only for other tickets TO_VXCHNGE
shipmentDirection* string read-only Shipping Direction to vXchnge
datacenterId

string

Allowable values: CA01, MN01, MN02, MO01, NC01, NJ01, NY01, NY02, OH01, PA01, PA02, OR01, TN01, TX01

required Datacenter Id: Required on create, read-only on update CA01
datacenter string read-only Data Center CA01 - Santa Clara
shippingCarrier*

string

Allowable values: UPS, FEDEX, USPS, DHL, OTHER

required Shipping carrier; Requred for SHIPPING tickets, read-only for other tickets USPS
otherCarrierName* string required Name of the carrier if different from pre-defined; Required only if shippingCarrier is OTHER Lasership
trackingNumber* string required Tracking number: Required for SHIPPING tickets with shipmentDirectionId TO_VXCHNGE, optional for SHIPPING tickets with shipmentDirectionId FROM_VXCHNGE, read-only for non SHIPPING tickets 123456
subject string required Ticket subject Visually inspect cables, power and network
createdDate string(date-time) read-only Created date/time in UTC 10/21/2018 2:39 PM
closedDate string(date-time) read-only Closed date/time in UTC 10/21/2018 2:39 PM
updatedDate string(date-time) read-only Updated date/time in UTC 10/21/2018 2:39 PM
status string read-only Ticket status Open
contactId integer(int32) required Contact Id 123
contactName string read-only Contact name John Doe
accessStartDate** string(date-time) required Access start date 10/21/2018 2:39 PM
accessEndDate** string(date-time) required Access end date 10/21/2018 2:39 PM
authorizedNames** string required Authorized names John Doe; Jane Doe
shippingAccountNumber* string required Shipping account number; Required for SHIPPING tickets with shipmentDirectionId FROM_VXCHNGE, optional for SHIPPING tickets with shipmentDirectionId TO_VXCHNGE, read-only for non SHIPPING tickets SH12345
shippingRecipient* string required Shipping recipient John Doe
shippingQuantity* integer(int32) optional Shipping quantity 5
expectedDeliveryDate* string(date-time) required Expected delivery date; Required for SHIPPING tickets with shipmentDirectionId TO_VXCHNGE, optional for SHIPPING tickets with shipmentDirectionId FROM_VXCHNGE, read-only for non SHIPPING tickets. 10/21/2018
rqeuestedShipDate* string(date-time) required Requested ship date; Required for SHIPPING tickets with shipmentDirectionId FROM_VXCHNGE, optional for SHIPPING tickets with shipmentDirectionId TO_VXCHNGE, read-only for non SHIPPING tickets. 10/21/2018
loadingDockRequired* boolean optional Loading dock required true
hazardousMaterial* boolean optional Hazardous material true
messages array[Ticket Message] read-only Ticket messages  
newMessage string optional A new ticket message A comment about ticket processing

 

Ticket Information

 

name type required description example
Id integer(int32) read-only

Internal id of the ticket;

12345
ticketNumber string read-only

Ticket number;

ST234567
subject string read-only Ticket subject Visually inspect cables, power and network
status string read-only Ticket status Open
serviceType

string

Allowable values: SITE_ACCESS, STANDARD_SUPPORT, SERVICE_TROUBLE, SHIPPING

required Support Type STANDARD_SUPPORT
serviceDescriptionId

string

Allowable values: CIRCUIT_TESTING, CONNECTIVITY_ISSUE, COURTESY_CART, DATA_CENTER_TOUR, EQUIPMENT_CONFIGURATION, EQUIPMENT_INSTALLATION, EQUIPMENT_REBOOT, EQUIPMENT_RELOCATION, EQUIPMENT_REMOVAL, EQUIPMENT_TROUBLESHOOTING, INFORMATION-REQUEST, INVENTORY_REQUEST, POWER_SUPPLY, EQUIPMENT_REPLACEMENT, TAPE_MANAGEMENT, VXCHNGE_INTERNET_ACCESS, DNS_ZONE_MANAGEMENT

 read-only

Service Description Id

INFORMATION_REQUEST
serviceDescription string read-only Service Description Information Request
datacenterId

string

Allowable values: CA01, MN01, MN02, MO01, NC01, NJ01, NY01, NY02, OH01, PA01, PA02, OR01, TN01, TX01

read-only Datacenter Id CA01
datacenter string read-only Data Center CA01 - Santa Clara
shipmentDirectionId*

string

Allowable values: TO_VXCHNGE, FROM_VXCHNGE

read-only Shipping Direction Id TO_VXCHNGE
shipmentDirection* string read-only Shipping Direction to vXchnge
trackingNumber* string read-only Tracking number 123456
createdDate string(date-time) read-only Created date/time in UTC 10/21/2018 2:39 PM
closedDate string(date-time) read-only Closed date/time in UTC 10/21/2018 2:39 PM
updatedDate string(date-time) read-only Updated date/time in UTC 10/21/2018 2:39 PM
contactId integer(int32) read-only Contact Id 123
contactName string read-only Contact name John Doe
companyName string read-only Company Name Nakatomi Trading Co

 

Ticket Message

 

name type required description example
authorName string read-only

Author of the message

John Doe
date string(date-time) read-only

Message date/time in UTC

10/21/2018 2:39 PM
text string read-only Text of the message A comment about ticket processing

 

Transaction Information

 

name type required description example
number string read-only Transaction Number SVC1234
location string read-only Data Center CA01 - Santa Clara
id integer(int32) read-only Internal id of the transaction 299332
type string read-only Transaction Type Service Order
status string read-only Transaction Status In Progress
created string(date-time) read-only Created date/time in UTC 1/31/2019
companyName string read-only Company Name Nakatomi Trading Co
total number read-only Transaction Total 337.35
poCheckNumber string read-only Transaction Purchase Order/Check Number 4502973884
orderDate string read-only Order date/time in UTC 1/31/2019 1:30 PM
svcOrderCompleted string read-only Service Order Completed date/time in UTC 2/24/2019 12:30 AM
svcOrderExpectedCompletion string read-only Service Order Expected Completion date/time in UTC 2/23/2019 2:45 PM

 

User Defined Field

 

name type required description example
name string read-only Field name Next Refresh Date
value string read-only Field value 02/07/2018

 

User Information

 

name type required description example
id integer(int32) read-only internal id of the user 12345
createDate string (date-time) read-only Create date/time in UTC 10/21/2016 2:39 pm
lastModifiedDate string (date-time) read-only Last Modified date/time in UTC 10/21/2016 2:39 pm
lastLogonDate string (date-time) read-only Last Logon date/time in UTC 10/21/2016 2:39 pm
name string read-only Name John Doe
title string read-only Title Mr
mobilePhone string read-only Mobile Phone 123-456-7890
email string read-only Email john@doe.com
altEmail string read-only Alternative Email doe@john.com
role string read-only Role admin
shipping string read-only Shipping Tickets none
support string read-only Support Tickets view
orders string read-only Order Transactions modify
billing string read-only Billing Transactions view
assetCompliance string read-only Asset Compliance modify
onlineAccess boolean read-only in\site Access true
complianceReports boolean read-only Compliance Reports true
accessLog boolean read-only DC Access Log true
platformAuditLog boolean read-only in\site Access Log false
bandwidthGraph boolean read-only Bandwidth Grpah true
powerGraph boolean read-only Power Graph false
datacenterFloorplan boolean read-only Data Center Floorplan true
createPublicGridViews boolean read-only Create Public Grid Views false
activityNotification boolean read-only Activity Notification true
smsNotifications boolean read-only SMS Notifications true
datacenters string read-only Data Centers CA01 - Santa Clara
onsiteAccessEnabled boolean read-only Data Center Access Enabled true
onsiteAccessEnableDate string read-only Data Center Access Enable Date 4/5/2017
onsiteAccessExpirationDate string read-only Data Center Access Expiration Date 4/21/2017
lastDatacenterAccessDate string read-only Last Data Center Access Date 4/15/2017
userAdmin boolean read-only Can Manage User Accounts true

 

in\site Access Log Entry

 

name type required description example
fullName string read-only User's Fullname John Doe
id integer (int32) read-only Internal Id of the Access Entry 1234
email string read-only User's Email Address johnd@company.com
userId integer (int32) read-only Internal Id of the User 2345
companyId integer (int32) read-only Internal Id of the Company 3456
companyName string read-only Company Name Nakatomi Trading Co
loginDate string (date-time) read-only Login date/time in UTC 1/31/2016 5:20 PM