The services field accepts the following options (comma-delimited for multiple values): Broadband, DIA, Private IP, Granite Switched Ethernet, MPLS, GRID, Rebill - DIA, Rebill - Broadband, Hosted PBX, ePOTS, SIP, Toll-Free Number, RCF, Mobility Access / M2M, EPIK, Wireless Voice, Proactive Ticketing, Advanced Monitoring, Managed SD-WAN, Managed Switch, Managed Wi-Fi, Managed Starlink, edgeboot.
Ticket Configurations
GET
/api/v1/noc/configurations/externalNOCExpressReturns the list of available ticket configurations by macnums.
Auth Scope
urn:grt:nocexpressContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
macnums | string | Yes | Macnums to look configurations for. Multiple macnums should be comma delimited |
services | string | Yes | Parameter for configurations lookup by service name. Multiple services should be comma delimited. Available options: Broadband, DIA, Private IP, Granite Switched Ethernet, MPLS, GRID, Rebill - DIA, Rebill - Broadband, Hosted PBX, ePOTS, SIP, Toll-Free Number, RCF, Mobility Access / M2M, EPIK, Wireless Voice, Proactive Ticketing, Advanced Monitoring, Managed SD-WAN, Managed Switch, Managed Wi-Fi, Managed Starlink, edgeboot |
search_service_id | string | No | Parameter for configurations lookup by service id |
search_serial_number | string | No | Parameter for configurations lookup by serial number |
page_size | integer | No | Desired page size |
granted_tenant_macnum | string | No | The company macnum on whose behalf the action is performed |
Available Service Options
Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
id | integer | A unique identifier for the NOC configuration |
name | string | The name of the NOC configuration |
type | string | The type of the NOC configuration |
status | string | The current status of the NOC configuration |
company | dictionary | A dictionary containing details about the associated company. Contains id (integer), identifier (string), name (string), and _info (object with company_href) |
company_id | integer | The unique identifier of the associated company |
company_name | string | The name of the associated company |
site | dictionary | A dictionary containing details about the associated site. Contains id (integer), name (string), account_name (string), address_line_1 (string), city (string), state (string), zip (string), site_name (string), parent_account (string), parent_macnum (string), parent_name (string) |
site_id | integer | The unique identifier of the associated site |
site_name | string | The name of the associated site |
serial_number | string | The serial number of the configured device or service |
model_number | string | The model number of the configured device or service |
ticket_type | string, optional | The type of ticket that can be created under this configuration |
ticket_subtype | string, optional | The subtype of ticket that can be created under this configuration |
product_offering | string, optional | The product offering related to this configuration, if any |
device_identifier | string, optional | A unique identifier for the device in this configuration, if applicable |
service | string, optional | Service representation of this configuration in G360 |
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 |
Code Examples
Errors
| HTTP Status | Error Description | Resolution |
|---|---|---|
400 | Bad Request | Review the error response body for specific validation errors. Common issues: missing required parameters (macnums or services), invalid service name, or invalid parameter format. |
401 | Authentication Failed | Verify your access token is valid and included in the Authorization header with the "Bearer " prefix. |
403 | Permission Denied | Your access token does not have the required scope (urn:grt:nocexpress). Contact your administrator to request the appropriate permissions. |
Last updated on