Skip to content
Skip to search
Skip to footer

Ultra Cloud Core 5G Session Management Function, Release 2020.02 - 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

Results

Updated:: April 30, 2020

Chapter: ApplicationData

ApplicationData

OpenAPI

OpenAPI Version: 3.0.0

info

Version: '-'

Title: 'Unified Data Repository Service API file for policy data'

Description: 'The API version is defined in 3GPP TS 29.504'

externalDocs

Description: 3GPP TS 29.519 V15.2.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure.

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.519/'

paths

/policy-data/ues/{ueId}/am-data

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

get:

Responses:

'200' Upon success, a response body containing access and mobility policies shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AmPolicyData'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'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'

/policy-data/ues/{ueId}/ue-policy-set

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

get:

Responses:

'200' Upon success, a response body containing UE policies shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UePolicySet'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'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'

put:

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UePolicySet'

Responses:

'201' Successful case. The resource has been successfully created and a response body containing a representation of the created UEPolicySet resource shall be returned.

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'204' Successful case. The resource has been successfully updated and no additional content is to be sent in the response message.

'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'

patch:

Request Body:

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/UePolicySet'

Responses:

'204' Successful case. The resource has been successfully updated and no additional content is to be sent in the response message.

'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'

/policy-data/ues/{ueId}/sm-data

get:

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

- name: snssai

In: query

Required/Optional: false

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

- name: dnn

In: query

Required/Optional: false

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

- name: fields

In: query

Description: attributes to be retrieved

Required/Optional: false

Schema:

Type: array

items:

Type: string

Responses:

'200' Upon success, a response body containing SmPolicyData shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyData'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'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'

patch:

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

Request Body:

Content:

application/merge-patch+json:

Schema:

Type: object

additionalProperties:

Reference: '#/components/schemas/UsageMonData'

Responses:

'204' Successful case. The resource has been successfully uupdated and no additional content is to be sent in the response message.

'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'

/policy-data/ues/{ueId}/sm-data/{usageMonId}

get:

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

- name: usageMonId

In: path

Required/Optional: true

Schema:

Type: string

Responses:

'200' Successful case. The usage monitoring data is returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UsageMonData'

'204' The resource was found but no usage monitoring data is available.

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'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'

put:

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

- name: usageMonId

In: path

Required/Optional: true

Schema:

Type: string

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UsageMonData'

Responses:

'201' Successful case. The resource has been successfully created and a response body is returned containing a representation of the resource.

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'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'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'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'

delete:

Parameters:

- name: ueId

In: path

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

- name: usageMonId

In: path

Required/Optional: true

Schema:

Type: string

Responses:

'204' Successful case. The resource has been successfully deleted.

'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'

'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'

/policy-data/sponsor-connectivity-data/{sponsorId}

Parameters:

- name: sponsorId

In: path

Required/Optional: true

Schema:

Type: string

get:

Responses:

'200' Upon success, a response body containing Sponsor Connectivity Data shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SponsorConnectivityData'

'204' The resource was found but no Sponsor Connectivity Data is available.

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'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'

/policy-data/bdt-data

get:

Responses:

'200' Upon success, a response body containing the BDT data shall be returned.

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/BdtData'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'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'

/policy-data/bdt-data/{bdtReferenceId}

Parameters:

- name: bdtReferenceId

In: path

Required/Optional: true

Schema:

Type: string

get:

Responses:

'200' Upon success, a response body containing the BDT data shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/BdtData'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'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'

put:

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/BdtData'

Responses:

'201' Successful case. The resource has been successfully created.

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'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'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'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'

delete:

Responses:

'204' Successful case. The resource has been successfully deleted.

'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'

'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'

/policy-data/subs-to-notify

Method: Post

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/PolicyDataSubscription'

Responses:

'201' Upon success, a response body containing a representation of each Individual subscription resource shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/PolicyDataSubscription'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'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'

Callbacks:

policyDataChangeNotification:

'{$request.body#/notificationUri}':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/PolicyDataChangeNotification'

minItems: 1

Responses:

'204' 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'

/policy-data/subs-to-notify/{subsId}

Parameters:

- name: subsId

In: path

Required/Optional: true

Schema:

Type: string

put:

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/PolicyDataSubscription'

Responses:

'200' The individual subscription resource was updated successfully.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/PolicyDataSubscription'

'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'

delete:

Responses:

'204' Upon success, an empty response body shall be returned.

'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'

'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'

/policy-data/ues/{ueId}/operator-specific-data

get:

Parameters:

- name: ueId

In: path

Description: UE Id

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

- name: fields

In: query

Description: attributes to be retrieved

Required/Optional: false

Schema:

Type: array

items:

Type: string

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Type: object

additionalProperties:

Reference: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'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'

patch:

Parameters:

- name: ueId

In: path

Description: UE Id

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

Request Body:

Content:

application/json-patch+json:

Schema:

Type: array

items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'

Required/Optional: true

Responses:

'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'

put:

Parameters:

- name: ueId

In: path

Description: UE Id

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Type: object

additionalProperties:

Reference: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer'

Responses:

'200' OK

Content:

Application/JSON:

Schema:

Reference: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer'

'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'

/policy-data/plmns/{plmnId}/ue-policy-set

Parameters:

- name: plmnId

In: path

Required/Optional: true

Schema:

Type: string

get:

Responses:

'200' Upon success, a response body containing UE policies shall be returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UePolicySet'

'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'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'412': Reference 'TS29571_CommonData.yaml#/components/responses/412'

'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

schemas

AmPolicyData

Description: Contains the AM policy data for a given subscriber.

Type: object

Properties:

subscCats:

Type: array

Items:

Type: string

minItems: 1

UePolicySet

Description: Contains the UE policy data for a given subscriber.

Type: object

Properties:

subscCats:

Type: array

Items:

Type: string

minItems: 1

uePolicySections:

Type: object

additionalProperties:

Reference: '#/components/schemas/UePolicySection'

minProperties: 1

upsis:

Type: array

Items:

Type: string

minItems: 1

UePolicySetPatch

Description: Contains the UE policy set for a given subscriber.

Type: object

Properties:

uePolicySections:

Type: object

additionalProperties:

Reference: '#/components/schemas/UePolicySection'

minProperties: 1

upsis:

Type: array

Items:

Type: string

minItems: 1

UePolicySection

Description: Contains the UE policy section.

Type: object

Properties:

uePolicySectionInfo:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Bytes'

upsi:

Type: string

Required:

- uePolicySectionInfo

- upsi

SmPolicyData

Description: Contains the SM policy data for a given subscriber.

Type: object

Properties:

smPolicySnssaiData:

Type: object

additionalProperties:

Reference: '#/components/schemas/SmPolicySnssaiData'

minProperties: 1

umDataLimits:

Type: object

additionalProperties:

Reference: '#/components/schemas/UsageMonDataLimit'

minProperties: 1

umData:

Type: object

additionalProperties:

Reference: '#/components/schemas/UsageMonData'

minProperties: 1

Required:

- smPolicySnssaiData

SmPolicySnssaiData

Description: Contains the SM policy data for a given subscriber and S-NSSAI.

Type: object

Properties:

snssai:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

smPolicyDnnData:

Type: object

additionalProperties:

Reference: '#/components/schemas/SmPolicyDnnData'

minProperties: 1

Required:

- snssai

SmPolicyDnnData

Description: Contains the SM policy data for a given DNN (and S-NSSAI).

Type: object

Properties:

dnn:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

allowedServices:

Type: array

Items:

Type: string

minItems: 1

subscCats:

Type: array

Items:

Type: string

minItems: 1

gbrUl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRate'

gbrDl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRate'

adcSupport:

Type: boolean

subscSpendingLimits:

Type: boolean

ipv4Index:

Reference: '#/components/schemas/IpIndex'

ipv6Index:

Reference: '#/components/schemas/IpIndex'

offline:

Type: boolean

online:

Type: boolean

chfInfo:

Reference: 'TS29512_CommonData.yaml#/components/schemas/ChargingInformation'

refUmDataLimitIds:

Type: object

additionalProperties:

Reference: '#/components/schemas/LimitIdToMonitoringKey'

minProperties: 1

mpsPriority:

Type: boolean

imsSignallingPrio:

Type: boolean

mpsPriorityLevel:

Type: integer

Required:

- dnn

UsageMonDataLimit

Description: Contains usage monitoring control data for a subscriber.

Type: object

Properties:

limitId:

Type: string

scopes:

Type: object

additionalProperties:

Reference: '#/components/schemas/UsageMonDataScope'

minProperties: 1

umLevel:

Reference: '#/components/schemas/UsageMonLevel'

startDate:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

endDate:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

usageLimit:

Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'

resetPeriod:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

Required:

- limitId

UsageMonData

Description: Contains remain allowed usage data for a subscriber.

Type: object

Properties:

limitId:

Type: string

scopes:

Type: object

additionalProperties:

Reference: '#/components/schemas/UsageMonDataScope'

minProperties: 1

umLevel:

Reference: '#/components/schemas/UsageMonLevel'

allowedUsage:

Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'

resetTime:

Reference: '#/components/schemas/TimePeriod'

Required:

- limitId

LimitIdToMonitoringKey

Description: Contains the limit identifier and the corresponding monitoring key for a given S-NSSAI and DNN.

Type: object

Properties:

limitId:

Type: string

monkey:

Type: array

Items:

Type: string

minItems: 1

Required:

- limitId

UsageMonDataScope

Description: Contains a SNSSAI and DNN combinations to which the UsageMonData instance belongs to.

Type: object

Properties:

snssai:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

dnn:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

minItems: 1

Required:

- snssai

TimePeriod

Description: Contains the periodicity for the defined usage monitoring data limits.

Type: object

Properties:

period:

Reference: '#/components/schemas/Periodicity'

maxNumPeriod:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

Required:

- period

SponsorConnectivityData

Description: Contains the sponsored data connectivity related information for a sponsor identifier.

Type: object

Properties:

aspIds:

Type: array

Items:

Type: string

Required:

- aspIds

BdtData

Description: Contains the background data transfer data.

Type: object

Properties:

aspId:

Type: string

transPolicy:

Reference: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy'

bdtRefId:

Type: string

nwAreaInfo:

Reference: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'

Required:

- aspIds

- transPolicy

PolicyDataSubscription

Description: Identifies a subscription to policy data change notification.

Type: object

Properties:

notificationUri:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

monitoredResourceUris:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Required:

- notificationUri

- monitoredResourceUris

PolicyDataChangeNotification

Description: Contains changed policy data for which notification was requested.

Type: object

Properties:

amPolicyData:

Reference: '#/components/schemas/AmPolicyData'

uePolicySet:

Reference: '#/components/schemas/UePolicySet'

smPolicyData:

Reference: '#/components/schemas/SmPolicyData'

usageMonData:

Reference: '#/components/schemas/UsageMonData'

SponsorConnectivityData:

Reference: '#/components/schemas/SponsorConnectivityData'

bdtData:

Reference: '#/components/schemas/BdtData'

IpIndex

Type: integer

UsageMonLevel

anyOf:

- type: string

Periodicity

anyOf:

- type: string

Was this Document Helpful?

Feedback

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)