3GPP NIDD downlink data deliveries API

openapi: 3.2.0
info:
  title: 3gpp-nidd NIDD downlink data deliveries 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: NIDD downlink data deliveries
paths:
  /{scsAsId}/configurations/{configurationId}/downlink-data-deliveries:
    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 all pending NIDD downlink data delivery resources related to a particular NIDD configuration resource.
      operationId: FetchAllDownlinkDataDeliveries
      tags:
      - NIDD downlink data deliveries
      responses:
        '200':
          description: all NIDD downlink data deliveries.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NiddDownlinkDataTransfer'
                minItems: 0
                description: individual NIDD downlink data delivery.
        '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
    post:
      summary: Create an NIDD downlink data delivery resource related to a particular NIDD configuration resource.
      operationId: CreateDownlinkDataDelivery
      tags:
      - NIDD downlink data deliveries
      requestBody:
        description: Contains the data to create a NIDD downlink data delivery.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NiddDownlinkDataTransfer'
      responses:
        '200':
          description: NIDD downlink data delivery is successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NiddDownlinkDataTransfer'
        '201':
          description: NIDD downlink data delivery is pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NiddDownlinkDataTransfer'
          headers:
            Location:
              description: Contains the URI of the newly created resource
              required: true
              schema:
                type: string
        '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':
          description: The NIDD downlink data delivery request was not successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NiddDownlinkDataDeliveryFailure'
        '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
    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
    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"
    NiddDownlinkDataDeliveryFailure:
      description: Represents information related to a failure delivery result.
      type: object
      properties:
        problemDetail:
          $ref: TS29122_CommonData.yaml#/components/schemas/ProblemDetails
        requestedRetransmissionTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
      required:
      - problemDetail
    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/