3GPP

3GPP TS 28.623 Subscription Control Nrm API

OAS 3.0.1 definition of the Subscription Control NRM fragment. An OpenAPI 3.0.1 data-model-only document (no paths; it defines the schemas/Network Resource Model consumed by the Provisioning and Performance management services), API version 19.4.0, published verbatim by 3GPP in 3GPP TS 28.623 as part of the Management Services (SA5 OAM) suite and mirrored in the public 3GPP Forge GitLab repository.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://www.3gpp.org/ftp/Specs/archive/28_series/28.623/

📖

APIReference

https://forge.3gpp.org/rep/sa5/MnS/-/raw/Rel-19/OpenAPI/TS28623_SubscriptionControlNrm.yaml

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/3gpp/refs/heads/main/openapi/3gpp-ts28623-subscriptioncontrolnrm.yml

OpenAPI Specification

openapi: 3.0.1
info:
  title: Subscription Control NRM
  version: 19.4.0
  description: OAS 3.0.1 definition of the Subscription Control NRM fragment © 2025, 3GPP Organizational
    Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
externalDocs:
  description: 3GPP TS 28.623; Generic NRM, Subscription Control NRM
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
paths: {}
components:
  schemas:
    SubNetwork-ncO-SubscriptionControlNrm:
      type: object
      properties:
        NtfSubscriptionControl:
          $ref: '#/components/schemas/NtfSubscriptionControl-Multiple'
    ManagedElement-ncO-SubscriptionControlNrm:
      type: object
      properties:
        NtfSubscriptionControl:
          $ref: '#/components/schemas/NtfSubscriptionControl-Multiple'
    Scope:
      oneOf:
      - type: object
        properties:
          scopeType:
            type: string
            enum:
            - BASE_ONLY
            - BASE_ALL
            - BASE_NTH_LEVEL
            - BASE_SUBTREE
          scopeLevel:
            type: integer
      - type: object
        properties:
          dataNodeSelector:
            oneOf:
            - $ref: TS28623_ComDefs.yaml#/components/schemas/JexNodeSelectionBasic
            - $ref: TS28623_ComDefs.yaml#/components/schemas/JexNodeSelectionAdvanced
    NtfSubscriptionControl-Single:
      allOf:
      - $ref: TS28623_GenericNrm.yaml#/components/schemas/Top
      - type: object
        properties:
          attributes:
            type: object
            properties:
              notificationRecipientAddress:
                $ref: TS28623_ComDefs.yaml#/components/schemas/Uri
              notificationTypes:
                type: array
                uniqueItems: true
                items:
                  $ref: TS28623_ComDefs.yaml#/components/schemas/NotificationType
              scope:
                $ref: '#/components/schemas/Scope'
              notificationFilter:
                $ref: TS28623_ComDefs.yaml#/components/schemas/JexConditions
          HeartbeatControl:
            $ref: '#/components/schemas/HeartbeatControl-Single'
    HeartbeatControl-Single:
      allOf:
      - $ref: TS28623_GenericNrm.yaml#/components/schemas/Top
      - type: object
        properties:
          attributes:
            type: object
            properties:
              heartbeatNtfPeriod:
                type: integer
                minimum: 0
                default: 0
              triggerHeartbeatNtf:
                type: boolean
                default: false
                writeOnly: true
    NtfSubscriptionControl-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/NtfSubscriptionControl-Single'
    resources-subscriptionControlNrm:
      oneOf:
      - $ref: '#/components/schemas/NtfSubscriptionControl-Single'
      - $ref: '#/components/schemas/HeartbeatControl-Single'
servers:
- url: https://forge.3gpp.org/rep/api/v4
  description: Base URL reconciled from apis.yml