3GPP Individual CP set Provisioning API

openapi: 3.2.0
info:
  title: 3gpp-cp-parameter-provisioning Individual CP set Provisioning API
  version: 1.4.0
  description: "API for provisioning communication pattern parameters.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-cp-parameter-provisioning/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Individual CP set Provisioning
paths:
  /{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId}:
    get:
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Subscription ID
        required: true
        schema:
          type: string
      - name: setId
        in: path
        description: Identifier of the CP parameter set
        required: true
        schema:
          type: string
      summary: Read CP at individual CP set(s) level associated with a CP parameter set Id.
      operationId: FetchIndCPSetProvisioning
      tags:
      - Individual CP set Provisioning
      responses:
        '200':
          description: OK. The subscription information related to the request URI is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CpParameterSet'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    put:
      summary: Update CP at individual CP set(s) level associated with a CP parameter set Id.
      operationId: UpdateIndCPSetProvisioning
      tags:
      - Individual CP set Provisioning
      requestBody:
        description: Change information for a CP parameter set.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CpParameterSet'
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Subscription ID
        required: true
        schema:
          type: string
      - name: setId
        in: path
        description: Identifier of the CP parameter set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'OK. The CP parameter set resource was modified successfully. The SCEF shall return an updated CP parameter set resource in the response content.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CpParameterSet'
        '204':
          description: 'No Content. The CP parameter set resource was modified successfully and no content is to be sent in the response message body.

            '
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '409':
          description: The CP parameters for the CP set were not updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CpReport'
            application/problem+json:
              schema:
                $ref: TS29122_CommonData.yaml#/components/schemas/ProblemDetails
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          description: The CP parameters for the CP set were not updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CpReport'
            application/problem+json:
              schema:
                $ref: TS29122_CommonData.yaml#/components/schemas/ProblemDetails
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    delete:
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Subscription ID
        required: true
        schema:
          type: string
      - name: setId
        in: path
        description: Identifier of the CP parameter set
        required: true
        schema:
          type: string
      summary: Delete CP at individual CP set(s) level associated with a CP parameter set Id.
      operationId: DeleteIndCPSetProvisioning
      tags:
      - Individual CP set Provisioning
      responses:
        '204':
          description: 'No Content. The subscription was deleted successfully. The content shall be empty.

            '
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  schemas:
    ScheduledCommunicationType:
      anyOf:
      - type: string
        enum:
        - DOWNLINK
        - UPLINK
        - BIDIRECTIONAL
      - 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: "Represents the type of scheduled communication.  \nPossible values are:\n- DOWNLINK: Downlink only.\n- UPLINK: Uplink only.\n- BIDIRECTIONAL: Bi-directional.\n"
    ScheduledCommunicationTime:
      description: Represents an offered scheduled communication time.
      type: object
      properties:
        daysOfWeek:
          type: array
          items:
            $ref: 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:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeOfDay
        timeOfDayEnd:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeOfDay
    CpParameterSet:
      description: Represents an offered communication pattern parameter set.
      type: object
      properties:
        setId:
          type: string
          description: "SCS/AS-chosen correlator provided by the SCS/AS in the request to create a resource for CP parameter set(s). \n"
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        validityTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        periodicCommunicationIndicator:
          $ref: '#/components/schemas/CommunicationIndicator'
        communicationDurationTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        periodicTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        scheduledCommunicationTime:
          $ref: '#/components/schemas/ScheduledCommunicationTime'
        scheduledCommunicationType:
          $ref: '#/components/schemas/ScheduledCommunicationType'
        stationaryIndication:
          $ref: '#/components/schemas/StationaryIndication'
        batteryInds:
          type: array
          items:
            $ref: '#/components/schemas/BatteryIndication'
          minItems: 1
        trafficProfile:
          $ref: '#/components/schemas/TrafficProfile'
        expectedUmts:
          type: array
          items:
            $ref: '#/components/schemas/UmtLocationArea5G'
          minItems: 1
          description: 'Identifies the UE''s expected geographical movement. The attribute is only applicable in 5G.

            '
        expectedUmtDays:
          $ref: TS29122_CommonData.yaml#/components/schemas/DayOfWeek
        expectedUmtDaysAdd:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/DayOfWeek
          minItems: 1
          maxItems: 5
          description: Identifies the additional day(s) of the week.
        appExpUeBehv:
          $ref: '#/components/schemas/AppExpUeBehaviour'
        confidenceLevel:
          type: string
          pattern: ^[0]\.[0-9]{2}|[1.00]$
        accuracyLevel:
          type: string
          pattern: ^[0]\.[0-9]{2}|[1.00]$
      required:
      - setId
    UmtLocationArea5G:
      description: Represents the user location area describing the UE moving trajectory.
      allOf:
      - $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea5G
      - type: object
        properties:
          umtTime:
            $ref: TS29122_CommonData.yaml#/components/schemas/TimeOfDay
          umtDuration:
            $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
    CpReport:
      description: 'Represents a CP report indicating the CP set identifier(s) which CP parameter(s) are not added or modified successfully and the corresponding failure cause(s).

        '
      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:
          $ref: '#/components/schemas/CpFailureCode'
      required:
      - failureCode
    CpFailureCode:
      anyOf:
      - type: string
        enum:
        - MALFUNCTION
        - SET_ID_DUPLICATED
        - OTHER_REASON
        - CONFIDENCE_LEVEL_NOT_SUFFICIENT
        - ACCURACY_LEVEL_NOT_SUFFICIENT
      - 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: "Represents the failure reason of the CP parameter provisioning.  \nPossible values are\n- MALFUNCTION: This value indicates that something functions wrongly in CP parameter\n  provisioning or the CP parameter provisioning does not function at all.\n- SET_ID_DUPLICATED: The received CP set identifier(s) are already provisioned.\n- OTHER_REASON: Other reason unspecified.\n- CONFIDENCE_LEVEL_NOT_SUFFICIENT: The received confidence level for the expected UE\n  parameter is not sufficient.\n- ACCURACY_LEVEL_NOT_SUFFICIENT: The received accuracy level for the expected UE parameter\n  is not sufficient.\n"
    BatteryIndication:
      anyOf:
      - type: string
        enum:
        - BATTERY_RECHARGE
        - BATTERY_REPLACE
        - BATTERY_NO_RECHARGE
        - BATTERY_NO_REPLACE
        - NO_BATTERY
      - 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: "Represents the type of power consumption.  \nPossible values are:\n- BATTERY_RECHARGE: UE powered with rechargeable battery.\n- BATTERY_REPLACE: UE powered with replaceable battery.\n- BATTERY_NO_RECHARGE: UE powered with no rechargeable battery.\n- BATTERY_NO_REPLACE: UE powered with no replaceable battery.\n- NO_BATTERY: UE not battery powered.\n"
    CommunicationIndicator:
      anyOf:
      - type: string
        enum:
        - PERIODICALLY
        - ON_DEMAND
      - 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: "Represents the type of the communication.  \nPossible values are:\n- PERIODICALLY: Identifies the UE communicates periodically\n- ON_DEMAND: Identifies the UE communicates on demand\n"
    TrafficProfile:
      anyOf:
      - type: string
        enum:
        - SINGLE_TRANS_UL
        - SINGLE_TRANS_DL
        - DUAL_TRANS_UL_FIRST
        - DUAL_TRANS_DL_FIRST
        - MULTI_TRANS
      - 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: "Represents the type of data transmission.  \nPossible values are:\n- SINGLE_TRANS_UL: Uplink single packet transmission.\n- SINGLE_TRANS_DL: Downlink single packet transmission.\n- DUAL_TRANS_UL_FIRST: Dual packet transmission, firstly uplink packet transmission with\n  subsequent downlink packet transmission.\n- DUAL_TRANS_DL_FIRST: Dual packet transmission, firstly downlink packet transmission with\n  subsequent uplink packet transmission.\n- MULTI_TRANS: Multiple packet transmission.\n"
    StationaryIndication:
      anyOf:
      - type: string
        enum:
        - STATIONARY
        - MOBILE
      - 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: "Represents the stationarity of the UE.  \nPossible values are:\n- STATIONARY: Identifies the UE is stationary\n- MOBILE: Identifies the UE is mobile\n"
    AppExpUeBehaviour:
      description: Contains the Application Specificf Expected UE Behaviour parameters.
      type: object
      properties:
        appId:
          type: string
          description: Indicates the Application Identifier.
        expPduSesInacTm:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeWindow
        flowDescriptions:
          type: array
          items:
            type: string
          minItems: 1
          description: 'Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733.

            '
        confidenceLevel:
          type: string
          pattern: ^[0]\.[0-9]{2}|[1.00]$
        accuracyLevel:
          type: string
          pattern: ^[0]\.[0-9]{2}|[1.00]$
        failureCode:
          $ref: '#/components/schemas/CpFailureCode'
        validityTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
      oneOf:
      - required:
        - appId
      - required:
        - flowDescriptions
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.122 V19.5.0 T8 reference point for Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/