1 Star 0 Fork 2

yuxi-o / 5GC_APIs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
TS29519_Application_Data.yaml 74.25 KB
一键复制 编辑 原始数据 按行查看 历史
Jesus de Gregorio 提交于 2020-04-05 16:19 . Rel-16 Mar'20
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001
openapi: 3.0.0
info:
version: '-'
title: Unified Data Repository Service API file for Application Data
description: |
The API version is defined in 3GPP TS 29.504
© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.519 V16.3.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:
/application-data/pfds:
get:
summary: Retrieve PFDs for application identifier(s)
operationId: ReadPFDData
tags:
- PFD Data (Store)
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: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
minItems: 1
responses:
'200':
description: A representation of PFDs for request applications is returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdDataForAppExt'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/pfds/{appId}:
get:
summary: Retrieve the corresponding PFDs of the specified application identifier
operationId: ReadIndividualPFDData
tags:
- Individual PFD Data (Document)
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: true
schema:
type: string
responses:
'200':
description: A representation of PFDs for the request application identified by the application identifier is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdDataForAppExt'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete the corresponding PFDs of the specified application identifier
operationId: DeleteIndividualPFDData
tags:
- Individual PFD Data (Document)
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: true
schema:
type: string
responses:
'204':
description: Successful case. The Individual PFD Data resource related to the application identifier was deleted.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
put:
summary: Create or update the corresponding PFDs for the specified application identifier
operationId: CreateOrReplaceIndividualPFDData
tags:
- Individual PFD Data (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdDataForAppExt'
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: true
schema:
type: string
responses:
'201':
description: 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:
$ref: '#/components/schemas/PfdDataForAppExt'
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/{apiVersion}/application-data/pfds/{appId}'
required: true
schema:
type: string
'200':
description: 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:
$ref: '#/components/schemas/PfdDataForAppExt'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/influenceData:
get:
summary: Retrieve Traffic Influence Data
operationId: ReadInfluenceData
tags:
- Influence Data (Store)
parameters:
- name: influence-Ids
in: query
description: Each element identifies a service.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: dnns
in: query
description: Each element identifies a DNN.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
- name: snssais
in: query
description: Each element identifies a slice.
required: false
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
- name: internal-Group-Ids
in: query
description: Each element identifies a group of users.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: supis
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
- name: supp-feat
in: query
description: Supported Features
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
responses:
'200':
description: The Traffic Influence Data stored in the UDR are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrafficInfluData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/influenceData/{influenceId}:
put:
summary: Create or update an individual Influence Data resource
operationId: CreateOrReplaceIndividualInfluenceData
tags:
- Individual Influence Data (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/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: true
schema:
type: string
responses:
'201':
description: The creation of an Individual Traffic Influence Data resource is confirmed and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficInfluData'
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/{apiVersion}/application-data/influenceData/{influenceId}'
required: true
schema:
type: string
'200':
description: 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:
$ref: '#/components/schemas/TrafficInfluData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
patch:
summary: Modify part of the properties of an individual Influence Data resource
operationId: UpdateIndividualInfluenceData
tags:
- Individual Influence Data (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/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: true
schema:
type: string
responses:
'200':
description: 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:
$ref: '#/components/schemas/TrafficInfluData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an individual Influence Data resource
operationId: DeleteIndividualInfluenceData
tags:
- Individual Influence Data (Document)
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: true
schema:
type: string
responses:
'204':
description: The Individual Influence Data was deleted successfully.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/influenceData/subs-to-notify:
post:
summary: Create a new Individual Influence Data Subscription resource
operationId: CreateIndividualInfluenceDataSubscription
tags:
- Influence Data Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficInfluSub'
responses:
'201':
description: The subscription was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficInfluSub'
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
trafficInfluenceDataChangeNotification:
'{$request.body#/notificationUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TrafficInfluData'
- $ref: '#/components/schemas/TrafficInfluDataNotif'
minItems: 1
responses:
'204':
description: No Content, Notification was successful
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
get:
summary: Read Influence Data Subscriptions
operationId: ReadInfluenceDataSubscriptions
tags:
- Influence Data Subscriptions (Collection)
parameters:
- name: dnn
in: query
description: Identifies a DNN.
required: false
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
- name: snssai
in: query
description: Identifies a slice.
required: false
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
- name: internal-Group-Id
in: query
description: Identifies a group of users.
required: false
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
- name: supi
in: query
description: Identifies a user.
required: false
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
responses:
'200':
description: The subscription information as request in the request URI query parameter(s) are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrafficInfluSub'
minItems: 0
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/influenceData/subs-to-notify/{subscriptionId}:
get:
summary: Get an existing individual Influence Data Subscription resource
operationId: ReadIndividualInfluenceDataSubscription
tags:
- Individual Influence Data Subscription (Document)
parameters:
- name: subscriptionId
in: path
description: String identifying a subscription to the Individual Influence Data Subscription
required: true
schema:
type: string
responses:
'200':
description: The subscription information is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficInfluSub'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
put:
summary: Modify an existing individual Influence Data Subscription resource
operationId: ReplaceIndividualInfluenceDataSubscription
tags:
- Individual Influence Data Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficInfluSub'
parameters:
- name: subscriptionId
in: path
description: String identifying a subscription to the Individual Influence Data Subscription
required: true
schema:
type: string
responses:
'200':
description: The subscription was updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficInfluSub'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an individual Influence Data Subscription resource
operationId: DeleteIndividualInfluenceDataSubscription
tags:
- Individual Influence Data Subscription (Document)
parameters:
- name: subscriptionId
in: path
description: String identifying a subscription to the Individual Influence Data Subscription
required: true
schema:
type: string
responses:
'204':
description: The subscription was terminated successfully.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/bdtPolicyData:
get:
summary: Retrieve applied BDT Policy Data
operationId: ReadBdtPolicyData
tags:
- BdtPolicy Data (Store)
parameters:
- name: bdt-policy-ids
in: query
description: Each element identifies a service.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: internal-group-ids
in: query
description: Each element identifies a group of users.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: supis
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
responses:
'200':
description: The applied BDT policy Data stored in the UDR are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BdtPolicyData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/bdtPolicyData/{bdtPolicyId}:
put:
summary: Create an individual applied BDT Policy Data resource
operationId: CreateIndividualAppliedBdtPolicyData
tags:
- Individual BDT Policy Data (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BdtPolicyData'
parameters:
- name: bdtPolicyId
in: path
description: The Identifier of an Individual Applied BDT Policy Data to be created or updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'201':
description: The creation of an Individual Applied BDT Policy Data resource is confirmed and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/BdtPolicyData'
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/{apiVersion}/application-data/bdtPolicyData/{bdtPolicyId}'
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
patch:
summary: Modify part of the properties of an individual Applied BDT Policy Data resource
operationId: UpdateIndividualAppliedBdtPolicyData
tags:
- Individual Applied BDT Policy Data (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/BdtPolicyDataPatch'
parameters:
- name: bdtPolicyId
in: path
description: The Identifier of an Individual Applied BDT Policy Data to be updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'200':
description: The update of an Individual Applied BDT Policy Data resource is confirmed and a response body containing Applied BDT Policy Data shall be returned.
content:
application/json:
schema:
$ref: '#/components/schemas/BdtPolicyData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an individual Applied BDT Policy Data resource
operationId: DeleteIndividualAppliedBdtPolicyData
tags:
- Individual Applied BDT Policy Data (Document)
parameters:
- name: bdtPolicyId
in: path
description: The Identifier of an Individual Applied BDT Policy Data to be updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'204':
description: The Individual Applied BDT Policy Data was deleted successfully.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/iptvConfigData:
get:
summary: Retrieve IPTV configuration Data
operationId: ReadIPTVCongifurationData
tags:
- IPTV Configuration Data (Store)
parameters:
- name: config-ids
in: query
description: Each element identifies a configuration.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: dnns
in: query
description: Each element identifies a DNN.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
- name: snssais
in: query
description: Each element identifies a slice.
required: false
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
- name: supis
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
- name: inter-group-ids
in: query
description: Each element identifies a group of users.
required: false
schema:
type: array
items:
type: string
minItems: 1
responses:
'200':
description: The IPTV configuration data stored in the UDR are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IptvConfigData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/iptvConfigData/{configurationId}:
put:
summary: Create or update an individual IPTV configuration resource
operationId: CreateOrReplaceIndividualIPTVConfigurationData
tags:
- Individual IPTV Configuration Data (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IptvConfigData'
parameters:
- name: configurationId
in: path
description: The Identifier of an Individual IPTV Configuration Data to be created or updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'201':
description: The creation of an Individual IPTV Configuration Data resource is confirmed and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/IptvConfigData'
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
'200':
description: The update of an Individual IPTV configuration resource.
content:
application/json:
schema:
$ref: '#/components/schemas/IptvConfigData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
patch:
summary: Partial update an individual IPTV configuration resource
operationId: PartialReplaceIndividualIPTVConfigurationData
tags:
- Individual IPTV Configuration Data
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/IptvConfigDataPatch'
parameters:
- name: configurationId
in: path
description: The Identifier of an Individual IPTV Configuration Data to be updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'200':
description: The update of an Individual IPTV configuration resource.
content:
application/json:
schema:
$ref: '#/components/schemas/IptvConfigData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an individual IPTV configuration resource
operationId: DeleteIndividualIPTVConfigurationData
tags:
- Individual IPTV Configuration Data (Document)
parameters:
- name: configurationId
in: path
description: The Identifier of an Individual IPTV Configuration to be updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'204':
description: The resource was deleted successfully.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/serviceParamData:
get:
summary: Retrieve Service Parameter Data
operationId: ReadServiceParameterData
tags:
- Service Parameter Data (Store)
parameters:
- name: service-param-ids
in: query
description: Each element identifies a service.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: dnns
in: query
description: Each element identifies a DNN.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
- name: snssais
in: query
description: Each element identifies a slice.
required: false
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
- name: internal-group-ids
in: query
description: Each element identifies a group of users.
required: false
schema:
type: array
items:
type: string
minItems: 1
- name: supis
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
- name: ue-ipv4s
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems: 1
- name: ue-ipv6s
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems: 1
- name: ue-mac
in: query
description: Each element identifies the user.
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
minItems: 1
- name: supp-feat
in: query
description: Supported Features
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
responses:
'200':
description: The Service Parameter Data stored in the UDR are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceParameterData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/serviceParamData/{serviceParamId}:
put:
summary: Create or update an individual Service Parameter Data resource
operationId: CreateOrReplaceServiceParameterData
tags:
- Individual Service Parameter Data (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceParameterData'
parameters:
- name: serviceParamId
in: path
description: The Identifier of an Individual Service Parameter Data to be created or updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'201':
description: The creation of an Individual Service Parameter Data resource is confirmed and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceParameterData'
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/{apiVersion}/application-data/serviceParamData/{serviceParamId}'
required: true
schema:
type: string
'200':
description: The update of an Individual Service Parameter Data resource is confirmed and a response body containing Service Parameter Data shall be returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceParameterData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
patch:
summary: Modify part of the properties of an individual Service Parameter Data resource
operationId: UpdateIndividualServiceParameterData
tags:
- Individual Service Parameter Data (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ServiceParameterDataPatch'
parameters:
- name: serviceParamId
in: path
description: The Identifier of an Individual Service Parameter Data to be updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'200':
description: The update of an Individual Service Parameter Data resource is confirmed and a response body containing Service Parameter Data shall be returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceParameterData'
'204':
description: No content
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an individual Service Parameter Data resource
operationId: DeleteIndividualServiceParameterData
tags:
- Individual Service Parameter Data (Document)
parameters:
- name: serviceParamId
in: path
description: The Identifier of an Individual Service Parameter Data to be updated. It shall apply the format of Data type string.
required: true
schema:
type: string
responses:
'204':
description: The Individual Service Parameter Data was deleted successfully.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/subs-to-notify:
post:
summary: Create a subscription to receive notification of application data changes
operationId: CreateIndividualApplicationDataSubscription
tags:
- ApplicationDataSubscriptions (Collection)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDataSubs'
responses:
'201':
description: Upon success, a response body containing a representation of each Individual subscription resource shall be returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDataSubs'
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
applicationDataChangeNotif:
'{$request.body#/notificationUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApplicationDataChangeNotif'
minItems: 1
responses:
'204':
description: No Content, Notification was successful
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
get:
summary: Read Application Data change Subscriptions
operationId: ReadApplicationDataChangeSubscriptions
tags:
- ApplicationDataSubscriptions (Collection)
parameters:
- name: data-filter
in: query
description: The data filter for the query.
required: false
schema:
$ref: '#/components/schemas/DataFilter'
responses:
'200':
description: The subscription information as request in the request URI query parameter(s) are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApplicationDataSubs'
minItems: 0
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/application-data/subs-to-notify/{subsId}:
parameters:
- name: subsId
in: path
required: true
schema:
type: string
put:
summary: Modify a subscription to receive notification of application data changes
operationId: ReplaceIndividualApplicationDataSubscription
tags:
- IndividualApplicationDataSubscription (Document)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDataSubs'
responses:
'200':
description: The individual subscription resource was updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDataSubs'
'204':
description: The individual subscription resource was updated successfully and no additional content is to be sent in the response message.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: Delete the individual Application Data subscription
operationId: DeleteIndividualApplicationDataSubscription
tags:
- IndividualApplicationDataSubscription (Document)
responses:
'204':
description: Upon success, an empty response body shall be returned.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
get:
summary: Get an existing individual Application Data Subscription resource
operationId: ReadIndividualApplicationDataSubscription
tags:
- IndividualApplicationDataSubscription (Document)
parameters:
- name: subsId
in: path
description: String identifying a subscription to the Individual Application Data Subscription
required: true
schema:
type: string
responses:
'200':
description: The subscription information is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDataSubs'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
schemas:
TrafficInfluData:
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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
ethTrafficFilters:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
description: Identifies Ethernet packet filters. Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
interGroupId:
type: string
description: Identifies a group of users.
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
trafficFilters:
type: array
items:
$ref: '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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
minItems: 1
description: Identifies the N6 traffic routing requirement.
traffCorreInd:
type: boolean
validStartTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
validEndTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
tempValidities:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity'
minItems: 1
description: Identifies the temporal validities for the N6 traffic routing requirement.
nwAreaInfo:
$ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
upPathChgNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
subscribedEvents:
type: array
items:
$ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/SubscribedEvent'
minItems: 1
dnaiChgType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType'
afAckInd:
type: boolean
addrPreserInd:
type: boolean
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
allOf:
- oneOf:
- required: [afAppId]
- required: [trafficFilters]
- required: [ethTrafficFilters]
- oneOf:
- required: [supi]
- required: [interGroupId]
TrafficInfluDataPatch:
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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
ethTrafficFilters:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
description: Identifies Ethernet packet filters. Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
internalGroupId:
type: string
description: Identifies a group of users.
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
trafficFilters:
type: array
items:
$ref: '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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
minItems: 1
description: Identifies the N6 traffic routing requirement.
traffCorreInd:
type: boolean
validStartTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
validEndTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
tempValidities:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity'
minItems: 1
nullable: true
description: Identifies the temporal validities for the N6 traffic routing requirement.
nwAreaInfo:
$ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
upPathChgNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
afAckInd:
type: boolean
addrPreserInd:
type: boolean
TrafficInfluSub:
type: object
properties:
dnns:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
description: Each element identifies a DNN.
snssais:
type: array
items:
$ref: '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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
description: Each element identifies the user.
notificationUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- notificationUri
oneOf:
- required: [dnns]
- required: [snssais]
- required: [internalGroupIds]
- required: [supis]
TrafficInfluDataNotif:
type: object
properties:
resUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
trafficInfluData:
$ref: '#/components/schemas/TrafficInfluData'
required:
- resourceId
PfdDataForAppExt:
allOf:
- $ref: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdDataForApp'
- type: object
properties:
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
BdtPolicyData:
type: object
properties:
interGroupId:
type: string
description: Identifies a group of users.
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
bdtRefId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- bdtRefId
BdtPolicyDataPatch:
type: object
properties:
bdtRefId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'
required:
- bdtRefId
IptvConfigData:
type: object
properties:
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
interGroupId:
type: string
description: Identifies a group of users.
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
afAppId:
type: string
multiAccCtrls:
type: object
additionalProperties:
$ref: 'TS29522_IPTVConfiguration.yaml#/components/schemas/MulticastAccessControl'
minProperties: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- afAppId
- multiAccCtrls
- suppFeat
oneOf:
- required: [interGroupId]
- required: [supi]
IptvConfigDataPatch:
type: object
properties:
multiAccCtrls:
type: object
additionalProperties:
$ref: 'TS29522_IPTVConfiguration.yaml#/components/schemas/MulticastAccessControl'
minProperties: 1
ServiceParameterData:
type: object
properties:
appId:
type: string
description: Identifies an application.
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
interGroupId:
type: string
description: Identifies a group of users.
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
ipv4Addr:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr'
macAddr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
paramOverPc5:
$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5'
paramOverUu:
$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverUu'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
ApplicationDataSubs:
description: Identifies a subscription to application data change notification.
type: object
properties:
notificationUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
dataFilters:
type: array
items:
$ref: '#/components/schemas/DataFilter'
minItems: 1
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- notificationUri
ApplicationDataChangeNotif:
description: Contains changed application data for which notification was requested.
type: object
properties:
iptvConfigData:
$ref: '#/components/schemas/IptvConfigData'
pfdData:
$ref: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdChangeNotification'
bdtPolicyData:
$ref: '#/components/schemas/BdtPolicyData'
resUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
serParamData:
$ref: '#/components/schemas/ServiceParameterData'
required:
- resUri
DataFilter:
description: Identifies a data filter.
type: object
properties:
dataInd:
$ref: '#/components/schemas/DataInd'
dnns:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
snssais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
internalGroupIds:
type: array
items:
type: string
minItems: 1
supis:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
appIds:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
minItems: 1
ueIpv4s:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems: 1
ueIpv6s:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems: 1
ueMacs:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
minItems: 1
required:
- dataInd
oneOf:
- required: [dnns]
- required: [snssais]
- required: [internalGroupIds]
- required: [supis]
- required: [ueIpv4s]
- required: [ueIpv6s]
- required: [ueMacs]
DataInd:
anyOf:
- type: string
enum:
- PFD
- IPTV
- BDT
- SVC_PARAM
- 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
- PFD
- IPTV
- BDT
- SVC_PARAM
1
https://gitee.com/yuxio/v5GC_APIs.git
git@gitee.com:yuxio/v5GC_APIs.git
yuxio
v5GC_APIs
5GC_APIs
master

搜索帮助