Ultra Cloud Core 5G Policy Control Function, Release 2023.01 - API Reference

Bias-Free Language

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.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Ultra Cloud Core 5G Policy Control Function, Release 2023.01 - API Reference

Chapter Title

Nchf_SpendingLimitControl_Callbacks

Results

Updated:
January 27, 2023

Chapter: Nchf_SpendingLimitControl_Callbacks

Nchf_SpendingLimitControl_Callbacks

OpenAPI

OpenAPI Version: 3.0.0

Info


Description: Spending Limit Control Service API Callbacks 
Version: "1.0.0" 
Title: Nchf_SpendingLimitControl Callbacks

Servers


  URL: 'http://{apiRoot}/' 
  Variables: 
    API Root: 
      Default: https://example.com 
      Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501

Security


- {} 
- oAuth2ClientCredentials: 
  - nchf-spendinglimitcontrol

Paths

/npcf/callbacks/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}/notify


  Method: Post 
 
    Parameters: 
    - in: path 
      name: subscriptionId 
      Description: Identifies an individual spending limit retrieval subscription. 
      Required/Optional: true 
      Schema: 
        Type: string 
    Request Body: 
      Required/Optional: true 
      Content: 
        Application/JSON: 
          Schema: 
            Reference: './TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/SpendingLimitStatus' 
 
    Responses: 
      '204': 
        Description: No Content, Notification was succesfull 
      '400': 
        Reference: './TS29571_CommonData.yaml#/components/responses/400' 
      '401': 
        Reference: './TS29571_CommonData.yaml#/components/responses/401' 
      '403': 
        Reference: './TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: './TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: './TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: './TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: './TS29571_CommonData.yaml#/components/responses/415' 
      '429': 
        Reference: './TS29571_CommonData.yaml#/components/responses/429' 
      '500': 
        Reference: './TS29571_CommonData.yaml#/components/responses/500' 
      '503': 
        Reference: './TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: './TS29571_CommonData.yaml#/components/responses/default'

/npcf/callbacks/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}/terminate


  Method: Post 
 
    Parameters: 
    - in: path 
      name: subscriptionId 
      Description: Identifies an individual spending limit retrieval subscription. 
      Required/Optional: true 
      Schema: 
        Type: string 
    Request Body: 
      Required/Optional: true 
      Content: 
        Application/JSON: 
          Schema: 
            Reference: './TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/SubscriptionTerminationInfo' 
 
    Responses: 
      '204': 
        Description: No Content, Notification was succesfull 
      '400': 
        Reference: './TS29571_CommonData.yaml#/components/responses/400' 
      '401': 
        Reference: './TS29571_CommonData.yaml#/components/responses/401' 
      '403': 
        Reference: './TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: './TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: './TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: './TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: './TS29571_CommonData.yaml#/components/responses/415' 
      '429': 
        Reference: './TS29571_CommonData.yaml#/components/responses/429' 
      '500': 
        Reference: './TS29571_CommonData.yaml#/components/responses/500' 
      '503': 
        Reference: './TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: './TS29571_CommonData.yaml#/components/responses/default'

Components


securitySchemes: 
  oAuth2ClientCredentials: 
    Type: oauth2 
    Flows: 
      clientCredentials: 
        tokenUrl: '{nrfApiRoot}/oauth2/token' 
        scopes: 
          nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API

Was this Document Helpful?

FeedbackFeedback

Contact Cisco