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
Version: "-"
Title: 'Unified Data Repository Service API file for Application Data'
Description: 'The API version is defined in 3GPP TS 29.504'
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/'
get:
Parameters:
- name: appId
In: query
Description: Contains the information of the application identifier(s) for the querying PFD Data resource.If none appId is included in the URI, it applies to all application identifier(s) for the querying PFD Data resource.
Required/Optional: false
Schema:
Type: array
items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
Responses:
'200' A representation of PFDs for request applications is returned.
Content:
Application/JSON:
Schema:
Type: array
items:
Reference: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdDataForApp'
'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'
get:
Parameters:
- name: appId
In: path
Description: Indicate the application identifier for the request pfd(s).It shall apply the format of Data type ApplicationId.
Required/Optional: true
Schema:
Type: string
Responses:
'200' A representation of PFDs for the request application identified by the application identifier is returned.
Content:
Application/JSON:
Schema:
Reference: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdDataForApp'
'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'
delete:
Parameters:
- name: appId
In: path
Description: Indicate the application identifier for the request pfd(s).It shall apply the format of Data type ApplicationId.
Required/Optional: true
Schema:
Type: string
Responses:
'204' Successful case.The Individual PFD Data resource related to the application identifier was 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'
put:
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdDataForApp'
Parameters:
- name: appId
In: path
Description: Indicate the application identifier for the request pfd(s).It shall apply the format of Data type ApplicationId.
Required/Optional: true
Schema:
Type: string
Responses:
'201' The creation of an Individual PFD Data resource related to the application-identifier is confirmed and a representation of that resource is returned.
Content:
Application/JSON:
Schema:
Reference: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdDataForApp'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/v1/application-data/pfds/{application-identifier}'
Required/Optional: true
Schema:
Type: string
'200' Successful case.The upgrade of an Individual PFD Data resource related to the application identifier is confirmed and a representation of that resource is returned.
Content:
Application/JSON:
Schema:
Reference: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdDataForApp'
'204' No content
'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'
get:
Parameters:
- name: influence-Ids
In: query
Description: Each element identifies a service.
Required/Optional: false
Schema:
Type: array
items:
Type: string
- name: dnns
In: query
Description: Each element identifies a DNN.
Required/Optional: false
Schema:
Type: array
items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
- name: snssais
In: query
Description: Each element identifies a slice.
Required/Optional: false
Schema:
Type: array
items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
- name: internal-Group-Ids
In: query
Description: Each element identifies a group of users.
Required/Optional: false
Schema:
Type: array
items:
Type: string
- name: supis
In: query
Description: Each element identifies the user.
Required/Optional: false
Schema:
Type: array
items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Responses:
'200' The Traffic Influence Data stored in the UDR are returned.
Content:
Application/JSON:
Schema:
Type: array
items:
Reference: '#/components/schemas/TrafficInfluData'
'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:
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluData'
Parameters:
- name: influenceId
In: path
Description: The Identifier of an Individual Influence Data to be created or updated.It shall apply the format of Data type string.
Required/Optional: true
Schema:
Type: string
Responses:
'201' The creation of an Individual Traffic Influence Data resource is confirmed and a representation of that resource is returned.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluData'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/v1/application-data/influenceData/{influenceId}'
Required/Optional: true
Schema:
Type: string
'200' The update of an Individual Traffic Influence Data resource is confirmed and a response body containing Traffic Influence Data shall be returned.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluData'
'204' No content
'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'
patch:
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluDataPatch'
Parameters:
- name: influenceId
In: path
Description: The Identifier of an Individual Influence Data to be updated.It shall apply the format of Data type string.
Required/Optional: true
Schema:
Type: string
Responses:
'200' The update of an Individual Traffic Influence Data resource is confirmed and a response body containing Traffic Influence Data shall be returned.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluData'
'204' No content
'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:
Parameters:
- name: influenceId
In: path
Description: The Identifier of an Individual Influence Data to be updated.It shall apply the format of Data type string.
Required/Optional: true
Schema:
Type: string
Responses:
'204' The Individual Influence Data was deleted successfully.
'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'
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluSub'
Responses:
'201' The subscription was created successfully.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluSub'
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:
trafficInfluenceDataChangeNotification:
'{$request.body#/notificationUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Type: array
items:
Reference: '#/components/schemas/TrafficInfluData'
minItems: 1
Responses:
'204' No Content, Notification was succesfull
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_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'
get:
Parameters:
- name: dnn
In: query
Description: Identifies a DNN.
Required/Optional: false
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
- name: snssai
In: query
Description: Identifies a slice.
Required/Optional: false
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
- name: internal-Group-Id
In: query
Description: Identifies a group of users.
Required/Optional: false
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
- name: supi
In: query
Description: Identifies a user.
Required/Optional: false
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Responses:
'200' The subscription information as request in the request URI query parameter(s) are returned.
Content:
Application/JSON:
Schema:
Type: array
items:
Reference: '#/components/schemas/TrafficInfluSub'
minItems: 0
'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'
get:
Parameters:
- name: subscriptionId
In: path
Description: String identifying a subscription to the Individual Influence Data Subscription
Required/Optional: true
Schema:
Type: string
Responses:
'200' The subscription information is returned.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluSub'
'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:
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluSub'
Parameters:
- name: subscriptionId
In: path
Description: String identifying a subscription to the Individual Influence Data Subscription
Required/Optional: true
Schema:
Type: string
Responses:
'200' The subscription was updated successfully.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TrafficInfluSub'
'204' No content
'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:
Parameters:
- name: subscriptionId
In: path
Description: String identifying a subscription to the Individual Influence Data Subscription
Required/Optional: true
Schema:
Type: string
Responses:
'204' The subscription was terminated successfully.
'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'
Type: object
Properties:
upPathChgNotifCorreId:
Type: string
Description: Contains the Notification Correlation Id allocated by the NEF for the UP path change notification.
appReloInd:
Type: boolean
Description: Identifies whether an application can be relocated once a location of the application has been selected.
afAppId:
Type: string
Description: Identifies an application.
dnn:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
ethTrafficFilters:
Type: array
Items:
Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
Description: Identifies Ethernet packet filters.Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.
snssai:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
interGroupId:
Type: string
Description: Identifies a group of users.
supi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
trafficFilters:
Type: array
Items:
Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
minItems: 1
Description: Identifies IP packet filters.Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.
trafficRoutes:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
minItems: 1
Description: Identifies the N6 traffic routing requirement.
validStartTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
validEndTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
nwAreaInfo:
Reference: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
upPathChgNotifUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
Required:
- trafficRoutes
allOf:
- oneOf:
- required: [afAppId]
- required: [trafficFilters]
- required: [ethTrafficFilters]
- oneOf:
- required: [supi]
- required: [interGroupId]
Type: object
Properties:
upPathChgNotifCorreId:
Type: string
Description: Contains the Notification Correlation Id allocated by the NEF for the UP path change notification.
appReloInd:
Type: boolean
Description: Identifies whether an application can be relocated once a location of the application has been selected.
dnn:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
ethTrafficFilters:
Type: array
Items:
Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
Description: Identifies Ethernet packet filters.Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.
snssai:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
internalGroupId:
Type: string
Description: Identifies a group of users.
supi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
trafficFilters:
Type: array
Items:
Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
minItems: 1
Description: Identifies IP packet filters.Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.
trafficRoutes:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
minItems: 1
Description: Identifies the N6 traffic routing requirement.
validStartTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
validEndTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
nwAreaInfo:
Reference: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
upPathChgNotifUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
Type: object
Properties:
dnns:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
Description: Each element identifies a DNN.
snssais:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
Description: Each element identifies a slice.
internalGroupIds:
Type: array
Items:
Type: string
minItems: 1
Description: Each element identifies a group of users.
supis:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
Description: Each element identifies the user.
notificationUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Required:
- notificationUri
oneOf:
- required: [dnns]
- required: [snssais]
- required: [internalGroupIds]
- required: [supis]