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-chargeable-party
Version: "1.0.0"
URL: '{apiRoot}/3gpp-chargeable-party/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
- {}
- oAuth2ClientCredentials: []
get:
Summary: Read all chargeable party transaction resources for a given SCS/AS
Tags:
- Chargeable Party Transaction Operation
Parameters:
- Name: scsAsId
In: path
Description: Identifier of SCS/AS
Required/Optional: true
Schema:
Type: string
Responses:
'200':
Description: OK (successful query of Chargeable Party resource)
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/ChargeableParty'
Min Items: 0
Description: individual BDT policy subscription.
'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 chargeable party transaction resource
Tags:
- Chargeable Party Transaction Operation
Parameters:
- Name: scsAsId
In: path
Description: Identifier of SCS/AS
Required/Optional: true
Schema:
Type: string
Request Body:
Description: representation of the Chargeable Party resource to be Created in the SCEF
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ChargeableParty'
Callbacks:
eventNotification:
'{$request.body#/notificationDestination}':
Method: Post
Request Body: # contents of the callback message
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/NotificationData'
Responses:
'200':
Description: OK (The successful acknowledgement of the notification with a body)
'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':
Description: successful creation of a chargeable party resource
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ChargeableParty'
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'
get:
Summary: read a chargeable party resource for a given SCS/AS and a transaction Id
Tags:
- Individual chargeable party resource Operation
Parameters:
- Name: scsAsId
In: path
Description: Identifier of SCS/AS
Required/Optional: true
Schema:
Type: string
- Name: transactionId
In: path
Description: Identifier of transaction
Required/Optional: true
Schema:
Type: string
Responses:
'200':
Description: OK (successful query of a chargeable party resource)
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ChargeableParty'
'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'
patch:
Summary: Updates a existing chargeable party resource for a given SCS/AS and transaction Id.
Tags:
- Individual chargeable party resource Operation
Parameters:
- Name: scsAsId
In: path
Description: Identifier of SCS/AS
Required/Optional: true
Schema:
Type: string
- Name: transactionId
In: path
Description: Identifier of transaction
Required/Optional: true
Schema:
Type: string
Request Body:
Description: representation of the chargeable party resource to be udpated in the SCEF
Required/Optional: true
Content:
application/merge-patch+json:
Schema:
Reference: '#/components/schemas/ChargeablePartyPatch'
Responses:
'200':
Description: successful update of a chargeable party resource
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ChargeableParty'
'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: deletes a chargeable party resource for a given SCS/AS and a transcation Id.
Tags:
- Individual chargeable party resource Operation
Parameters:
- Name: scsAsId
In: path
Description: Identifier of SCS/AS
Required/Optional: true
Schema:
Type: string
- Name: transactionId
In: path
Description: Identifier of transaction
Required/Optional: true
Schema:
Type: string
Responses:
'200':
Description: successful deletion of an resouce of chargeable party
'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'
securitySchemes:
oAuth2ClientCredentials:
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
ChargeableParty:
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'
ipv4Addr:
Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr :
Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr'
macAddr:
Reference: 'TS29571_CommonData.yaml#/components/schemas/macAddr48'
flowInfo:
Type: array
Items:
Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
minItems: 1
Description: Describes the application flows.
ethFlowInfo:
Type: array
Items:
Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
Description: Identifies Ethernet packet flows.
sponsorInformation:
Reference: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'
sponsoringEnabled:
Type: boolean
Description: Indicates sponsoring status.
referenceId:
Reference: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'
usageThreshold:
Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'
Required:
- notificationDestination
- sponsorInformation
- sponsoringEnabled
ChargeablePartyPatch:
Type: object
Properties:
flowInfo:
Type: array
Items:
Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
minItems: 1
Description: Describes the application flows.
ethFlowInfo:
Type: array
Items:
Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
Description: Identifies Ethernet packet flows.
sponsoringEnabled:
Type: boolean
Description: Indicates sponsoring status.
referenceId:
Reference: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'
usageThreshold:
Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'