ResourceManagementOfBdt

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-bdt

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

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

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-bdt/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths

scsAsId subscriptions

Parameters:

- name: scsAsId

Description: String identifying the SCS/AS.

In: path

Required/Optional: true

Schema:

Type: string

get:

Responses:

'200' all BDT policy subscriptions.

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/Bdt'

minItems: 0

Description: individual BDT policy subscription.

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

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

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Method: Post

Request Body:

Description: Contains the data to create a BDT subscription.

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/Bdt'

Responses:

'201' Background data transfer policies offered to the SCS/AS.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/Bdt'

Headers:

Location:

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

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'409': Reference 'TS29122_CommonData.yaml#/components/responses/409'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

scsAsId subscriptions subscriptionId

Parameters:

- name: scsAsId

Description: String identifying the SCS/AS.

In: path

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

Description: String identifying the individual BDT policy resource in the SCEF.

In: path

Required/Optional: true

Schema:

Type: string

get:

Responses:

'200' Background data transfer policies offered to and selected by the SCEF.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/Bdt'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

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

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

patch:

Request Body:

Description: Contains information to be performed on the Bdt data structure to select a transfer policy.

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/BdtPatch'

Responses:

'200' The Individual BDT Policy resource is modified with a selected policy and a representation of that resource is returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/Bdt'

'204' The Individual BDT Policy resource is modified with a selected policy.

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

delete:

Responses:

'204' The Individual BDT Policy resource is deleted.

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

Bdt

Type: object

Properties:

self:

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

supportedFeatures:

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

volumePerUE:

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

numberOfUEs:

Type: integer

Minimum: 1

Description: Identifies the number of UEs.

desiredTimeWindow:

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

locationArea:

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

LocationArea5G:

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

referenceId:

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

transferPolicies:

Type: array

Items:

Reference: '#/components/schemas/TransferPolicy'

minItems: 1

Description: Identifies an offered transfer policy.

readOnly: true

selectedPolicy:

Type: integer

Description: Identity of the selected background data transfer policy. Shall not be present in initial message exchange, can be provided by NF service consumer in a subsequent message exchange.

Required:

- volumePerUE

- numberOfUEs

- desiredTimeWindow

BdtPatch

Type: object

Properties:

selectedPolicy:

Type: integer

Description: Identity of the selected background data transfer policy.

Required:

- selectedPolicy

TransferPolicy

Type: object

Properties:

bdtPolicyId:

Type: integer

Description: Identifier for the transfer policy

maxUplinkBandwidth:

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

maxDownlinkBandwidth:

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

ratingGroup:

Type: integer

Minimum: 0

Description: Indicates the rating group during the time window.

timeWindow:

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

Required:

- bdtPolicyId

- ratingGroup

- timeWindow