3GPP

3GPP TS 28.623 Management Data Collection Nrm API

OAS 3.0.1 definition of the Management Data Collection 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.5.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_ManagementDataCollectionNrm.yaml

Specifications

⚙

OpenAPI

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

OpenAPI Specification

openapi: 3.0.1
info:
  title: Management Data Collection NRM
  version: 19.5.0
  description: OAS 3.0.1 definition of the Management Data Collection NRM fragment © 2025, 3GPP Organizational
    Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
externalDocs:
  description: 3GPP TS 28.623; Generic NRM, Management Data Collection NRM
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
paths: {}
components:
  schemas:
    SubNetwork-ncO-ManagementDataCollectionNrm:
      type: object
      properties:
        ManagementDataCollection:
          $ref: '#/components/schemas/ManagementDataCollection-Multiple'
    ManagementData:
      oneOf:
      - type: array
        items:
          type: string
          enum:
          - COVERAGE
          - CAPACITY
          - ENERGY_EFFICIENCY
          - MOBILITY
          - ACCESSIBILITY
      - type: array
        items:
          type: string
    NodeFilter:
      type: object
      properties:
        areaOfInterest:
          $ref: TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest
        networkDomain:
          type: string
          enum:
          - CN
          - RAN
        cpUpType:
          type: string
          enum:
          - CP
          - UP
        sst:
          type: integer
        objectInstances:
          type: array
          uniqueItems: true
          items:
            $ref: TS28623_ComDefs.yaml#/components/schemas/Dn
    ManagementDataCollection-Single:
      allOf:
      - $ref: TS28623_GenericNrm.yaml#/components/schemas/Top
      - type: object
        properties:
          attributes:
            type: object
            properties:
              managementData:
                $ref: '#/components/schemas/ManagementData'
              targetNodeFilter:
                $ref: '#/components/schemas/NodeFilter'
              collectionTimeWindow:
                $ref: TS28623_ComDefs.yaml#/components/schemas/TimeWindow
              reportingCtrl:
                $ref: TS28623_GenericNrm.yaml#/components/schemas/ReportingCtrl
              dataScope:
                type: string
                enum:
                - SNSSAI
                - 5QI
                - PLMN
              condition:
                type: string
              processMonitor:
                $ref: TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor
              consolidateOutput:
                type: boolean
              jobId:
                type: string
    ManagementDataCollection-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/ManagementDataCollection-Single'
    resources-mgmtDataCollectionNrm:
      oneOf:
      - $ref: '#/components/schemas/ManagementDataCollection-Single'
servers:
- url: https://forge.3gpp.org/rep/api/v4
  description: Base URL reconciled from apis.yml