OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
OpenAPI Version: 3.0.0
Title: 3gpp-network-status-reporting
Version: "1.0.0"
Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
- {}
- oAuth2ClientCredentials: []
URL: '{apiRoot}/3gpp-net-stat-report/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
Parameters:
- name: scsAsId
In: path
Description: Identifier of the SCS/AS
Required/Optional: true
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'
get:
Summary: Read all network status reporting subscription resources for a given SCS/AS.
Responses:
'200' The requested information was returned successfully.
Content:
Application/JSON:
Schema:
Type: array
items:
Reference: '#/components/schemas/NetworkStatusReportingSubscription'
minItems: 0
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
Method: Post
Summary: Create a new network status reporting subscription resource.
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/NetworkStatusReportingSubscription'
Callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
Method: Post
Request Body: # contents of the callback message
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/NetworkStatusReportingNotification'
Responses:
'204' No Content (successful notification)
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
Responses:
'201' The subscription was created successfully. The URI of the created resource shall be returned in the "Location" HTTP header.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/NetworkStatusReportingSubscription'
Headers:
Location:
Description: 'Contains the URI of the newly created resource'
Required/Optional: true
Schema:
Type: string
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
Parameters:
- name: scsAsId
In: path
Description: Identifier of the SCS/AS
Required/Optional: true
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'
- name: subscriptionId
In: path
Description: Identifier of the subscription resource of type string
Required/Optional: true
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/ResourceId'
get:
Summary: Read an active network status reporting subscription resource.
Responses:
'200' The requested information was returned successfully.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/NetworkStatusReportingSubscription'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
put:
Summary: Modify an existing subscription resource to update a subscription.
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/NetworkStatusReportingSubscription'
Responses:
'200' The subscription was updated successfully.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/NetworkStatusReportingSubscription'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
delete:
Summary: Delete an existing continuous network status reporting subscription resource.
Responses:
'204' The subscription was updated successfully.
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
Type: object
Properties:
self:
Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
notificationDestination:
Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'
requestTestNotification:
Type: boolean
Description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.
websockNotifConfig:
Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
locationArea:
Reference: 'TS29122_CommonData.yaml#/components/schemas/LocationArea'
timeDuration:
Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
thresholdValues:
Type: array
Items:
Reference: '#/components/schemas/CongestionValue'
minItems: 1
Description: Identifies a list of congestion level(s) with exact value that the SCS/AS requests to be informed of when reached.
thresholdTypes:
Type: array
Items:
Reference: '#/components/schemas/CongestionType'
minItems: 1
Description: Identifies a list of congestion level(s) with abstracted value that the SCS/AS requests to be informed of when reached.
Required:
- notificationDestination
- locationArea
not:
Required: [thresholdValues, thresholdTypes]
Type: object
Properties:
subscription:
Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'
nsiValue:
Reference: '#/components/schemas/CongestionValue'
nsiType:
Reference: '#/components/schemas/CongestionType'
Required:
- subscription
not:
Required: [nsiValue, nsiType]
Type: integer
Minimum: 0
Maximum: 31
Description: Unsigned integer with valid values between 0 and 31. The value 0 indicates that there is no congestion. The value 1 is the lowest congestion level and value 31 is the highest congestion level.
anyOf: type: string
This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
Possible values are
HIGH: The congestion status is high.
MEDIUM: The congestion status is medium.
LOW: The congestion status is low.