3GPP

3GPP TS 28.623 File Management Nrm API

OAS 3.0.1 definition of the File Management 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.3.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.

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_FileManagementNrm.yaml

Specifications

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

OpenAPI Specification

3gpp-ts28623-filemanagementnrm.yml Raw ↑ 
openapi: 3.0.1
info:
  title: File Management NRM
  version: 19.3.0
  description: OAS 3.0.1 definition of the File Management NRM fragment © 2024, 3GPP Organizational Partners
    (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
externalDocs:
  description: 3GPP TS 28.623; Generic NRM, File Management NRM
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
paths: {}
components:
  schemas:
    SubNetwork-ncO-FileManagementNrm:
      type: object
      properties:
        FileDownloadJob:
          $ref: '#/components/schemas/FileDownloadJob-Multiple'
        Files:
          $ref: '#/components/schemas/Files-Multiple'
    ManagedElement-ncO-FileManagementNrm:
      type: object
      properties:
        FileDownloadJob:
          $ref: '#/components/schemas/FileDownloadJob-Multiple'
        Files:
          $ref: '#/components/schemas/Files-Multiple'
    FileDownloadJobProcessMonitor:
      description: This data type is the "ProcessMonitor" data type with specialisations for usage in
        the "FileDownloadJob".
      type: object
      properties:
        id:
          type: string
          readOnly: true
        status:
          type: string
          readOnly: true
          enum:
          - NOT_STARTED
          - RUNNING
          - FINSHED
          - FAILED
          - CANCELLING
          - CANCELLED
        progressPercentage:
          type: integer
          readOnly: true
          minimum: 0
          maximum: 100
        progressStateInfo:
          readOnly: true
          type: string
        resultStateInfo:
          oneOf:
          - type: string
            readOnly: true
            enum:
            - null
            - UNKNOWN
            - NO_STORAGE
            - LOW_MEMROY
            - NO_CONNECTION_TO_REMOTE_SERVER
            - FILE_NOT_AVAILABLE
            - DNS_CANNOT_BE_RESOLVED
            - TIMER_EXPIRED
            - OTHER
          - type: string
            readOnly: true
        startTime:
          $ref: TS28623_ComDefs.yaml#/components/schemas/DateTimeRo
        endTime:
          $ref: TS28623_ComDefs.yaml#/components/schemas/DateTimeRo
        timer:
          type: integer
    FileDownloadJob-Single:
      allOf:
      - $ref: TS28623_GenericNrm.yaml#/components/schemas/Top
      - type: object
        properties:
          attributes:
            type: object
            properties:
              fileLocation:
                $ref: '#/components/schemas/FileLocation'
              notificationRecipientAddress:
                $ref: TS28623_ComDefs.yaml#/components/schemas/Uri
              cancelJob:
                type: string
                enum:
                - true
                - false
                default: false
              jobMonitor:
                $ref: '#/components/schemas/FileDownloadJobProcessMonitor'
    Files-Single:
      allOf:
      - $ref: TS28623_GenericNrm.yaml#/components/schemas/Top
      - type: object
        properties:
          attributes:
            type: object
            properties:
              numberOfFiles:
                type: integer
                readOnly: true
              jobRef:
                $ref: TS28623_ComDefs.yaml#/components/schemas/DnRo
              jobId:
                type: string
                readOnly: true
              File:
                $ref: '#/components/schemas/File-Multiple'
    File-Single:
      allOf:
      - $ref: TS28623_GenericNrm.yaml#/components/schemas/Top
      - type: object
        properties:
          attributes:
            type: object
            properties:
              file:
                oneOf:
                - $ref: '#/components/schemas/FileLocation'
                - $ref: '#/components/schemas/FileContent'
              fileCompression:
                type: string
                readOnly: true
              fileSize:
                type: integer
                readOnly: true
              fileDataType:
                type: string
                readOnly: true
                enum:
                - PERFORMANCE
                - TRACE
                - ANALYTICS
                - PROPRIETARY
              fileFormat:
                type: string
                readOnly: true
              fileReadyTime:
                $ref: TS28623_ComDefs.yaml#/components/schemas/DateTimeRo
              fileExpirationTime:
                $ref: TS28623_ComDefs.yaml#/components/schemas/DateTimeRo
              jobRef:
                $ref: TS28623_ComDefs.yaml#/components/schemas/DnRo
              jobId:
                type: string
                readOnly: true
    FileLocation:
      $ref: TS28623_ComDefs.yaml#/components/schemas/UriRo
    FileContent:
      type: string
      readOnly: true
    FileDownloadJob-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/FileDownloadJob-Single'
    Files-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/Files-Single'
    File-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/File-Single'
    resources-fileMgmtNrm:
      oneOf:
      - $ref: '#/components/schemas/FileDownloadJob-Single'
      - $ref: '#/components/schemas/Files-Single'
      - $ref: '#/components/schemas/File-Single'
servers:
- url: https://forge.3gpp.org/rep/api/v4
  description: Base URL reconciled from apis.yml