Ticket details
GET
/api/v1/noc/tickets/{ticket_id}NOCExpressReturns the ticket details for the specified ticket_id.
Auth Scope
urn:grt:nocexpressContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ticket_id | integer | Yes | Ticket ID for the NOC ticket (for example returned from Create Ticket). |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
granted_tenant_macnum | string | No | The company macnum on whose behalf the action is performed. |
Response
Success response (200 OK)
Response fields
| Field | Type | Description |
|---|---|---|
id | integer | A unique identifier for the NOC ticket. |
summary | string | A brief summary of the ticket issue. |
city | string | The city associated with the ticket's primary location. |
state | string | The state associated with the ticket's primary location. |
zip | string | The postal code or ZIP code associated with the ticket's primary location. |
company_identifier | string, optional | A unique identifier for the company associated with the ticket. |
issue | string, optional | The specific issue for the ticket. |
status_name | string | The current status of the ticket. |
last_updated | string | The timestamp indicating when the ticket was last updated. |
date_entered | string | The timestamp indicating when the ticket was initially created or entered. |
company_name | string | The name of the company associated with the ticket. |
site_name | string, optional | The name of the site associated with the ticket. |
address_1 | string | The first line of the street address associated with the ticket. |
address_2 | string | The second line of the street address associated with the ticket. |
service_name | string, optional | The name of the service related to the ticket. |
service_id | string, optional | The unique identifier of the service, if applicable. |
service_id_label | string, optional | A human-readable label for the service ID, if applicable. |
configurations | list of objects | A list of nested objects detailing configurations related to the ticket (e.g. `id`, `name`, `type` per item). |
g360_escalated | boolean, optional | Indicates if the ticket has been escalated in G360 (default false). |
g360_status | string, optional | G360 workflow status for the ticket, when present. |
is_followed | boolean | Indicates whether the current user is following this ticket. |
impacted_site_count | integer | The total number of sites impacted by this ticket. |
customer_ticket_number | string, optional | The ticket number provided by the customer, if available. |
prior_ticket | integer, optional | The ID of a prior related ticket, if applicable. |
initial_description | string, optional | The initial description provided when the ticket was created. |
type_name | string | The type name of the ticket. |
sub_type | string | The sub-type of the ticket. |
technician_name | string, optional | The name of the technician assigned to the ticket. |
local_contact_name | string, optional | The name of the local contact person for the site related to the ticket. |
local_contact_number | string, optional | The phone number of the local contact person. |
additional_contacts | list of objects, optional | A list of nested objects detailing additional contacts for the ticket. |
attachments | list, optional | A list of raw data representing attachments associated with the ticket. |
automatic_email_contact | boolean, optional | Indicates if automatic email notifications are enabled for the primary contact. |
contact_email_address | string, optional | The email address for automatic email notifications to the primary contact. |
automatic_email_cc | boolean, optional | Indicates if automatic email CC notifications are enabled. |
automatic_email_cc_address | string, optional | The email address for automatic email CC notifications. |
sites | list of objects, optional | A list of nested objects detailing sites related to the ticket. |
chronic_flag | boolean, optional | Indicates if the ticket is flagged as chronic (recurring issue). |
priority | string | The priority level of the ticket. |
rca_requested | boolean | Indicates if a Root Cause Analysis (RCA) has been requested for this ticket. |
access_hours | string, optional | Information regarding access hours for the site related to the ticket. |
technician_dispatch_approved | boolean, optional | Indicates if a technician dispatch has been approved for this ticket. |
tns_impacted | string, optional | Information about impacted TNS (Telecommunication Network Service) elements, if applicable. |
escalation_status | string | The current escalation status of the ticket. |
sites[] object (example shape)
| Field | Type | Description |
|---|---|---|
id | integer | Site identifier. |
account_name | string | Account name for the site. |
name | string | Display name for the site. |
site_name | string | Site name / code. |
address_line_1 | string | Street address line 1. |
city | string | City. |
state | string | State. |
zip | string | Postal code. |
parent_account | string | Parent account identifier. |
parent_macnum | string | Parent MAC / company label. |
parent_name | string | Parent name. |
maintenance_window | string | Maintenance window preference. |
is_chronic | boolean | Whether the site is flagged chronic. |
Code examples
Last updated on