3GPP Individual NIDD configuration API

openapi: 3.2.0
info:
  title: 3gpp-nidd Individual NIDD configuration API
  version: 1.3.0
  description: "API for non IP data delivery.  \n© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-nidd/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 NIDD configuration
paths:
  /{scsAsId}/configurations/{configurationId}:
    parameters:
    - name: scsAsId
      description: String identifying the SCS/AS.
      in: path
      required: true
      schema:
        type: string
    - name: configurationId
      description: String identifying the individual NIDD configuration resource in the SCEF.
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Read an NIDD configuration resource.
      operationId: FetchIndNIDDConfiguration
      tags:
      - Individual NIDD configuration
      responses:
        '200':
          description: The individual NIDD configuration is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NiddConfiguration'
        '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
    patch:
      summary: Modify an existing NIDD configuration resource.
      operationId: ModifyNIDDConfiguration
      tags:
      - Individual NIDD configuration
      requestBody:
        description: Contains information to be applied to the individual NIDD configuration.
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/NiddConfigurationPatch'
      responses:
        '200':
          description: 'The Individual NIDD configuration is modified successfully and a representation of that resource is returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NiddConfiguration'
        '204':
          description: 'The Individual NIDD configuration is 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
        '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':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    delete:
      summary: Delete an existing NIDD configuration resource.
      operationId: DeleteNIDDConfiguration
      tags:
      - Individual NIDD configuration
      responses:
        '204':
          description: The Individual NIDD configuration is deleted.
        '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:
    NiddDownlinkDataTransfer:
      description: Represents the received NIDD downlink data from the SCS/AS.
      type: object
      properties:
        externalId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        msisdn:
          $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        data:
          $ref: TS29122_CommonData.yaml#/components/schemas/Bytes
        reliableDataService:
          type: boolean
          description: 'Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682) acknowledgement is requested (true) or not (false). Default value is false.

            '
        rdsPort:
          $ref: '#/components/schemas/RdsPort'
        maximumLatency:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        priority:
          type: integer
          description: 'It is used to indicate the priority of the non-IP data packet relative to other non-IP data packets.

            '
        pdnEstablishmentOption:
          $ref: '#/components/schemas/PdnEstablishmentOptions'
        deliveryStatus:
          $ref: '#/components/schemas/DeliveryStatus'
        requestedRetransmissionTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
      required:
      - data
      oneOf:
      - required:
        - externalId
      - required:
        - msisdn
      - required:
        - externalGroupId
    NiddConfiguration:
      description: Represents the configuration for NIDD.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        mtcProviderId:
          type: string
          description: Identifies the MTC Service Provider and/or MTC Application.
        externalId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
        msisdn:
          $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        duration:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        reliableDataService:
          type: boolean
          description: 'Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS  23.682) acknowledgement is requested (true) or not (false). Default value is false.

            '
        rdsPorts:
          type: array
          items:
            $ref: '#/components/schemas/RdsPort'
          minItems: 1
          description: 'Indicates the static port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250).

            '
        pdnEstablishmentOption:
          $ref: '#/components/schemas/PdnEstablishmentOptions'
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        requestTestNotification:
          type: boolean
          description: 'Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.

            '
        websockNotifConfig:
          $ref: TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig
        maximumPacketSize:
          type: integer
          minimum: 1
          description: 'The Maximum Packet Size is the maximum NIDD packet size that was transferred to the UE by the SCEF in the PCO, see clause 4.5.14.1 of 3GPP TS 23.682. If no maximum packet size was provided to the UE by the SCEF, the SCEF sends a default configured max packet size to SCS/AS. Unit  bit.

            '
          readOnly: true
        niddDownlinkDataTransfers:
          type: array
          items:
            $ref: '#/components/schemas/NiddDownlinkDataTransfer'
          minItems: 1
          description: "The downlink data deliveries that needed to be executed by the SCEF. The cardinality of the property shall be 0..1 in the request and 0..N in the response (i.e. response may\n contain multiple buffered MT NIDD).\n"
        status:
          $ref: '#/components/schemas/NiddStatus'
      required:
      - notificationDestination
      oneOf:
      - required:
        - externalId
      - required:
        - msisdn
      - required:
        - externalGroupId
    DeliveryStatus:
      anyOf:
      - type: string
        enum:
        - SUCCESS
        - SUCCESS_NEXT_HOP_ACKNOWLEDGED
        - SUCCESS_NEXT_HOP_UNACKNOWLEDGED
        - SUCCESS_ACKNOWLEDGED
        - SUCCESS_UNACKNOWLEDGED
        - TRIGGERED
        - BUFFERING
        - BUFFERING_TEMPORARILY_NOT_REACHABLE
        - SENDING
        - FAILURE
        - FAILURE_RDS_DISABLED
        - FAILURE_NEXT_HOP
        - FAILURE_TIMEOUT
        - FAILURE_TEMPORARILY_NOT_REACHABLE
      - 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 status of a downlink NIDD data delivery resource.  \nPossible values are:\n- SUCCESS: Success but details not provided\n- SUCCESS_NEXT_HOP_ACKNOWLEDGED: Successful delivery to the next hop with acknowledgment.\n- SUCCESS_NEXT_HOP_UNACKNOWLEDGED: Successful delivery to the next hop without\n  acknowledgment\n- SUCCESS_ACKNOWLEDGED: Reliable delivery was acknowledged by the UE\n- SUCCESS_UNACKNOWLEDGED: Reliable delivery was not acknowledged by the UE\n- TRIGGERED: The SCEF triggered the device and is buffering the data.\n- BUFFERING: The SCEF is buffering the data due to no PDN connection established.\n- BUFFERING_TEMPORARILY_NOT_REACHABLE: The SCEF has been informed that the UE is temporarily\n  not reachable but is buffering the data\n- SENDING: The SCEF has forwarded the data, but they may be stored elsewhere\n- FAILURE: Delivery failure but details not provided\n- FAILURE_RDS_DISABLED: RDS was disabled\n- FAILURE_NEXT_HOP: Unsuccessful delivery to the next hop.\n- FAILURE_TIMEOUT: Unsuccessful delivery due to timeout. \n- FAILURE_TEMPORARILY_NOT_REACHABLE: The SCEF has been informed that the UE is temporarily\n  not reachable without buffering the data.\n"
      readOnly: true
    NiddStatus:
      anyOf:
      - type: string
        enum:
        - ACTIVE
        - TERMINATED_UE_NOT_AUTHORIZED
        - TERMINATED
        - RDS_PORT_UNKNOWN
      - 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 status of a NIDD configuration.  \nPossible values are:\n- ACTIVE: The NIDD configuration is active.\n- TERMINATED_UE_NOT_AUTHORIZED: The NIDD configuration was terminated because the UE´s\n  authorisation was revoked.\n- TERMINATED: The NIDD configuration was terminated.\n- RDS_PORT_UNKNOWN: The RDS port is unknown.\n"
      readOnly: true
    PdnEstablishmentOptions:
      anyOf:
      - type: string
        enum:
        - WAIT_FOR_UE
        - INDICATE_ERROR
        - SEND_TRIGGER
      - 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 PDN establishment options that describe the network behaviour when\nthere is no PDN connection towards the addressed UE.  \nPossible values are:\n- WAIT_FOR_UE: wait for the UE to establish the PDN connection \n- INDICATE_ERROR: respond with an error cause\n- SEND_TRIGGER: send a device trigger\n"
    NiddConfigurationPatch:
      description: Represents the parameters to update a NIDD configuration.
      type: object
      properties:
        duration:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTimeRm
        reliableDataService:
          type:
          - boolean
          - 'null'
          description: 'Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS  23.682) acknowledgement is requested (true) or not (false).

            '
        rdsPorts:
          type: array
          items:
            $ref: '#/components/schemas/RdsPort'
          minItems: 1
          description: 'Indicates the static port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250).

            '
        pdnEstablishmentOption:
          $ref: '#/components/schemas/PdnEstablishmentOptionsRm'
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
    PdnEstablishmentOptionsRm:
      description: 'Represents the same information as the PdnEstablishmentOptions data type with the difference that it allows also the null value.

        '
      anyOf:
      - $ref: '#/components/schemas/PdnEstablishmentOptions'
      - $ref: TS29571_CommonData.yaml#/components/schemas/NullValue
    RdsPort:
      description: Represents the port configuration for Reliable Data Transfer.
      type: object
      properties:
        portUE:
          $ref: TS29122_CommonData.yaml#/components/schemas/Port
        portSCEF:
          $ref: TS29122_CommonData.yaml#/components/schemas/Port
      required:
      - portUE
      - portSCEF
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.122 V18.6.0 T8 reference point for Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/