CpProvisioning

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-cp-parameter-provisioning

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-cp-parameter-provisioning/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

get:

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. The subscription information related to the request URI is returned.

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/CpInfo'

minItems: 0

'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

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

Request Body:

Description: create new subscriptions for a given SCS/AS and the provisioning CP parameter sets.

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpInfo'

Responses:

'201' Created. The subscription was created successfully. The SCEF shall return the created subscription in the response payload body.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpInfo'

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'

'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' The CP parameters for all sets were not created successfully. CpReport may be included with detailed information.

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/CpReport'

minItems: 1

application/problem+json:

Schema:

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

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

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

/{scsAsId}/subscriptions/{subscriptionId}

get:

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Subscription ID

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. The subscription information related to the request URI is returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpInfo'

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

put:

Request Body:

Description: Modify a CP parameter provisioning subscription resource.

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpInfo'

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Subscription ID

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. The subscription was modified successfully. The SCEF shall return an updated subscription in the response payload body.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpInfo'

'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' The CP parameters for all sets were not updated successfully. CpReport may be included with detailed information.

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/CpReport'

minItems: 1

application/problem+json:

Schema:

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

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

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

delete:

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Subscription ID

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content. The subscription was deleted successfully. The payload body shall be empty.

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

/{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId}

get:

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Subscription ID

Required/Optional: true

Schema:

Type: string

- name: setId

In: path

Description: Identifier of the CP parameter set

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. The subscription information related to the request URI is returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpParameterSet'

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

put:

Request Body:

Description: Change information for a CP parameter set.

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpParameterSet'

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Subscription ID

Required/Optional: true

Schema:

Type: string

- name: setId

In: path

Description: Identifier of the CP parameter set

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. The CP parameter set resource was modified successfully. The SCEF shall return an updated CP parameter set resource in the response payload body.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpParameterSet'

'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' The CP parameters for the CP set were not updated successfully.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpReport'

application/problem+json:

Schema:

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

'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' The CP parameters for the CP set were not updated successfully.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CpReport'

application/problem+json:

Schema:

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

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

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

delete:

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Subscription ID

Required/Optional: true

Schema:

Type: string

- name: setId

In: path

Description: Identifier of the CP parameter set

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content. The subscription was deleted successfully. The payload body shall be empty.

'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

CpInfo

Type: object

Properties:

self:

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

supportedFeatures:

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

externalId:

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

msisdn:

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

externalGroupId:

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

cpParameterSets:

Type: object

additionalProperties:

Reference: '#/components/schemas/CpParameterSet'

minProperties: 1

Description: Identifies a set of CP parameter information that may be part of this CpInfo structure.

cpReports:

Type: object

additionalProperties:

Reference: '#/components/schemas/CpReport'

minProperties: 1

Description: Supplied by the SCEF and contains the CP set identifiers for which CP parameter(s) are not added or modified successfully. The failure reason is also included. Each element provides the related information for one or more CP set identifier(s) and is identified in the map via the failure identifier as key.

readOnly: true

Required: cpParameterSets

oneOf:

  • required: [externalId]

  • required: [msisdn]

  • required: [externalGroupId]

CpParameterSet

Type: object

Properties:

setId:

Type: string

Description: SCS/AS-chosen correlator provided by the SCS/AS in the request to create a resource fo CP parameter set(s).

self:

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

validityTime:

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

periodicCommunicationIndicator:

Reference: '#/components/schemas/CommunicationIndicator'

communicationDurationTime:

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

periodicTime:

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

scheduledCommunicationTime:

Reference: '#/components/schemas/ScheduledCommunicationTime'

stationaryIndication:

Reference: '#/components/schemas/StationaryIndication'

expectedUmts:

Type: array

Items:

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

minItems: 1

Description: Identifies the UE's expected geographical movement. The attribute is only applicable in 5G.

Required: setId

ScheduledCommunicationTime

Type: object

Properties:

daysOfWeek:

Type: array

Items:

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

minItems: 1

maxItems: 6

Description: Identifies the day(s) of the week. If absent, it indicates every day of the week.

timeOfDayStart:

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

timeOfDayEnd:

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

CpReport

Type: object

Properties:

setIds:

Type: array

Items:

Type: string

minItems: 1

Description: Identifies the CP set identifier(s) which CP parameter(s) are not added or modified successfully

failureCode:

Reference: '#/components/schemas/CpFailureCode'

Required: failureCode

CommunicationIndicator

anyOf: type: string

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.

Possible values are:

  • PERIODICALLY: Identifies the UE communicates periodically

  • ON_DEMAND: Identifies the UE communicates on demand

StationaryIndication

anyOf: type: string

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.

Possible values are:

  • STATIONARY: Identifies the UE is stationary

  • MOBILE: Identifies the UE is mobile

CpFailureCode

anyOf: type: string

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.

Possible values are

  • MALFUNCTION: This value indicates that something functions wrongly in CP parameter provisioning or the CP parameter provisioning does not function at all.

  • SET_ID_DUPLICATED: The received CP set identifier(s) are already provisioned.

  • OTHER_REASON: Other reason unspecified.