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 |