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: TS 29.122 Common Data Types
Version: "1.0.0"
schemas:
SponsorInformation:
Type: object
Properties:
sponsorId:
Type: string
Description: It indicates Sponsor ID.
aspId:
Type: string
Description: It indicates Application Service Provider ID.
Required:
- sponsorId
- aspId
UsageThreshold:
Type: object
Properties:
duration:
Reference: '#/components/schemas/DurationSec'
totalVolume:
Reference: '#/components/schemas/Volume'
downlinkVolume:
Reference: '#/components/schemas/Volume'
uplinkVolume:
Reference: '#/components/schemas/Volume'
UsageThresholdRm:
Type: object
Properties:
duration:
Reference: '#/components/schemas/DurationSecRm'
totalVolume:
Reference: '#/components/schemas/VolumeRm'
downlinkVolume:
Reference: '#/components/schemas/VolumeRm'
uplinkVolume:
Reference: '#/components/schemas/VolumeRm'
nullable: true
TimeWindow:
Type: object
Properties:
startTime:
Reference: '#/components/schemas/DateTime'
stopTime:
Reference: '#/components/schemas/DateTime'
Required:
- startTime
- stopTime
Acknowledgement:
Type: object
Properties:
details:
Type: string
Description: A human-readable explanation specific to this successful acknowledgement
Required:
- details
NotificationData:
Type: object
Properties:
transaction:
Reference: '#/components/schemas/Link'
eventReports:
Type: array
Items:
Reference: '#/components/schemas/EventReport'
minItems: 1
Description: Contains the reported event and applicable information
Required:
- transaction
- eventReports
EventReport:
Type: object
Properties:
event:
Reference: '#/components/schemas/Event'
accumulatedUsage:
Reference: '#/components/schemas/AccumulatedUsage'
flowIds:
Type: array
Items:
Type: integer
minItems: 1
Description: Identifies the IP flows that were sent during event subscription
Required:
- event
AccumulatedUsage:
Type: object
Properties:
duration:
Reference: '#/components/schemas/DurationSec'
totalVolume:
Reference: '#/components/schemas/Volume'
downlinkVolume:
Reference: '#/components/schemas/Volume'
uplinkVolume:
Reference: '#/components/schemas/Volume'
FlowInfo:
Type: object
Properties:
flowId:
Type: integer
Description: Indicates the IP flow.
flowDescriptions:
Type: array
Items:
Type: string
Description: Indicates the packet filters of the IP flow. Refer to subclause 5.3.8 of 3GPP TS 29.214 for encoding. It shall contain UL and/or DL IP flow description.
minItems: 1
maxItems: 2
Required:
- flowId
TestNotification:
Type: object
Properties:
subscription:
Reference: '#/components/schemas/Link'
Required:
- subscription
WebsockNotifConfig:
Type: object
Properties:
websocketUri:
Reference: '#/components/schemas/Link'
requestWebsocketUri:
Type: boolean
Description: Set by the SCS/AS to indicate that the Websocket delivery is requested.
LocationArea:
Type: object
Properties:
cellIds:
Type: array
Items:
Type: string
minItems: 1
Description: Indicates a list of Cell Global Identities of the user which identifies the cell the UE is registered.
enodeBIds:
Type: array
Items:
Type: string
minItems: 1
Description: Indicates a list of eNodeB identities in which the UE is currently located.
routingAreaIds:
Type: array
Items:
Type: string
minItems: 1
Description: Identifies a list of Routing Area Identities of the user where the UE is located.
trackingAreaIds:
Type: array
Items:
Type: string
minItems: 1
Description: Identifies a list of Tracking Area Identities of the user where the UE is located.
geographicAreas:
Type: array
Items:
Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
minItems: 1
Description: Identifies a list of geographic area of the user where the UE is located.
civicAddresses:
Type: array
Items:
Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress'
minItems: 1
Description: Identifies a list of civic addresses of the user where the UE is located.
LocationArea5G:
Type: object
Properties:
geographicAreas:
Type: array
Items:
Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
minItems: 0
Description: Identifies a list of geographic area of the user where the UE is located.
civicAddresses:
Type: array
Items:
Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress'
minItems: 0
Description: Identifies a list of civic addresses of the user where the UE is located.
nwAreaInfo:
Reference: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
ProblemDetails:
Type: object
Properties:
Type:
Reference: '#/components/schemas/Uri'
title:
Type: string
Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.
status:
Type: integer
Description: The HTTP status code for this occurrence of the problem.
detail:
Type: string
Description: A human-readable explanation specific to this occurrence of the problem.
instance:
Reference: '#/components/schemas/Uri'
cause:
Type: string
Description: A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.
invalidParams:
Type: array
Items:
Reference: '#/components/schemas/InvalidParam'
minItems: 1
Description: Description of invalid parameters, for a request rejected due to invalid parameters.
InvalidParam:
Type: object
Properties:
param:
Type: string
Description: Attribute's name encoded as a JSON Pointer, or header's name.
reason:
Type: string
Description: A human-readable reason, e.g. "must be a positive integer".
Required:
- param
PlmnId:
Type: object
Properties:
mcc:
Reference: '#/components/schemas/Mcc'
mnc:
Reference: '#/components/schemas/Mnc'
Required:
- mcc
- mnc
ConfigResult:
Type: object
Properties:
externalIds:
Type: array
Items:
Reference: '#/components/schemas/ExternalId'
minItems: 1
Description: Each element indicates an external identifier of the UE.
msisdns:
Type: array
Items:
Reference: '#/components/schemas/Msisdn'
minItems: 1
Description: Each element identifies the MS internal PSTN/ISDN number allocated for the UE.
resultReason:
Reference: '#/components/schemas/ResultReason'
Required:
- resultReason
oneOf:
- required: [externalIds]
- required: [Msisdns]
Bandwidth:
Type: integer
Minimum: 0
Description: integer indicating a bandwidth in bits per second.
BdtReferenceId:
Type: string
Description: string identifying a BDT Reference ID as defined in subclause 5.3.3 of 3GPP TS 29.154.
Binary:
Type: string
Description: string with format "binary" as defined in OpenAPI Specification.
Bytes:
Type: string
Description: String with format "byte" as defined in OpenAPI Specification, i.e, base64-encoded characters.
DayOfWeek:
Type: integer
Minimum: 1
Maximum: 7
Description: integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, and the subsequent weekdays shall be indicated with the next higher numbers. 7 shall indicate Sunday.
DateTime:
Type: string
Description: string with format "date-time" as defined in OpenAPI.
DateTimeRm:
Type: string
Description: string with format "date-time" as defined in OpenAPI with "nullable=true" property.
nullable: true
DateTimeRo:
Type: string
Description: string with format "date-time" as defined in OpenAPI with "readOnly=true" property.
readOnly: true
DurationSec:
Type: integer
Minimum: 0
Description: Unsigned integer identifying a period of time in units of seconds.
DurationSecRm:
Type: integer
Minimum: 0
Description: Unsigned integer identifying a period of time in units of seconds with "nullable=true" property.
nullable: true
DurationSecRo:
Type: integer
Minimum: 0
Description: Unsigned integer identifying a period of time in units of seconds with "readOnly=true" property.
readOnly: true
DurationMin:
Type: integer
format: int32
Minimum: 0
Description: Unsigned integer identifying a period of time in units of minutes.
ExternalId:
Type: string
Description: string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clause 4.6.2 of 3GPP TS 23.682 for more information.
ExternalGroupId:
Type: string
Description: string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 for more information.
Ipv4Addr:
Type: string
Description: string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166.
Ipv6Addr:
Type: string
Description: string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.
Ipv4AddrRo:
Type: string
Description: string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166, with "readOnly=true" property.
readOnly: true
Ipv6AddrRo:
Type: string
Description: string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952, with "readOnly=true" property. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.
readOnly: true
Link:
Type: string
Description: string formatted according to IETF RFC 3986 identifying a referenced resource.
Mcc:
Type: string
Description: String encoding a Mobile Country Code part of the PLMN, comprising 3 digits, as defined in 3GPP TS 38.413.
Mnc:
Type: string
Description: String encoding a Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in 3GPP TS 38.413.
Msisdn:
Type: string
Description: string formatted according to subclause 3.3 of 3GPP TS 23.003 that describes an MSISDN.
Port:
Type: integer
Description: Unsigned integer with valid values between 0 and 65535.
Minimum: 0
Maximum: 65535
PortRo:
Type: integer
Description: Unsigned integer with valid values between 0 and 65535, with "readOnly=true" property.
Minimum: 0
Maximum: 65535
readOnly: true
ResourceId:
Type: string
Description: string chosen by the SCEF to serve as identifier in a resource URI.
ScsAsId:
Type: string
Description: string that identifies an SCS/AS.
TimeOfDay:
Type: string
Description: String with format partial-time or full-time as defined in subclause 5.6 of IETF RFC 3339. Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC).
Uri:
Type: string
Description: string providing an URI formatted according to IETF RFC 3986.
Volume:
Type: integer
format: int64
Minimum: 0
Description: Unsigned integer identifying a volume in units of bytes.
VolumeRm:
Type: integer
format: int64
Minimum: 0
Description: Unsigned integer identifying a volume in units of bytes with "nullable=true" property.
nullable: true
Event:
anyOf:
- type: string
enum:
- SESSION_TERMINATION
- LOSS_OF_BEARER
- RECOVERY_OF_BEARER
- RELEASE_OF_BEARER
- USAGE_REPORT
- type: string
Description:
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.
Description:
Possible values are
- SESSION_TERMINATION: Indicates that Rx session is terminated.
- LOSS_OF_BEARER : Indicates a loss of a bearer.
- RECOVERY_OF_BEARER: Indicates a recovery of a bearer.
- RELEASE_OF_BEARER: Indicates a release of a bearer.
- USAGE_REPORT: Indicates the usage report event.
ResultReason:
anyOf:
- type: string
enum:
- ROAMING_NOT_ALLOWED
- OTHER_REASON
- type: string
Description:
This string provides a failure reason.
Description:
Possible values are
- ROAMING_NOT_ALLOWED: Identifies the configuration parameters are not allowed by roaming agreement.
- OTHER_REASON: Identifies the configuration parameters are not configured due to other reason.
# HTTP responses
responses:
'400':
Description: Bad request
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'401':
Description: Unauthorized
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'403':
Description: Forbidden
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'404':
Description: Not Found
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'406':
Description: Not Acceptable
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'409':
Description: Conflict
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'411':
Description: Length Required
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'412':
Description: Precondition Failed
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'413':
Description: Payload Too Large
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'414':
Description: URI Too Long
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'415':
Description: Unsupported Media Type
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'429':
Description: Too Many Requests
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'500':
Description: Internal Server Error
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
'503':
Description: Service Unavailable
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Default:
Description: Generic Error