Upload the TS29506_Aiot_Data.yaml file.

openapi: 3.0.0

info:

  version: '-'

  title: Unified Data Repository Service API file for Ambient IoT data

  description: |

    The API version is defined in 3GPP TS 29.504  

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  

    All rights reserved.

externalDocs:

  description: >

    3GPP TS 29.506 V0.0.0; 5G System; Usage of the Unified Data Repository Service for AIoT Data

  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.506/'

paths:

  /aiot-data/aiot-device-profile-data/{aiotDevPermId}:

    parameters:

     - name: aiotDevPermId

       in: path

       required: true

       schema:

         $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'

    get:

      summary: Retrieves the AIoT device profile data for an AIoT device permanent identifier

      operationId: ReadAiotDeviceProfileData

      tags:

        - AiotDeviceProfileData (Document)

      security:

        - {}

        - oAuth2ClientCredentials:

          - nudr-dr

          - nudr-dr:aiot-data:aiot-device-profile-data

          - nudr-dr:aiot-data:aiot-device-profile-data:aiotDevPermId:read

      responses:

        '200':

          description: >

            Upon success, a response body containing AIoT device profile data shall be returned.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/AiotDeviceProfileData'

        '400':

          $ref: 'TS29571_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29571_CommonData.yaml#/components/responses/401'

        '403':

          $ref: 'TS29571_CommonData.yaml#/components/responses/403'

        '404':

          description: Not Found

          content:

            application/problem+json:

              schema:

                $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'

        '406':

          $ref: 'TS29571_CommonData.yaml#/components/responses/406'

        '429':

          $ref: 'TS29571_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29571_CommonData.yaml#/components/responses/500'

        '502':

          $ref: 'TS29571_CommonData.yaml#/components/responses/502'

        '503':

          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

    patch:

      summary: Modify the AIoT device profile data for an AIoT device permanent identifier.

      operationId: UpdateAiotDeviceProfileData

      tags:

        - AiotDeviceProfileData (Document)

      security:

        - {}

        - oAuth2ClientCredentials:

          - nudr-dr

          - nudr-dr:aiot-data:aiot-device-profile-data

          - nudr-dr:aiot-data:aiot-device-profile-data:aiotDevPermId:modify

      parameters:

        - name: supported-features

          in: query

          description: Supported Features

          required: false

          schema:

             $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

      requestBody:

        required: true

        content:

          application/merge-patch+json:

            schema:

              $ref: '#/components/schemas/AiotDeviceProfileDataPatch'

      responses:

        '200':

          description: Expected response to a valid request.

          content:

            application/json:

              schema:

                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'

        '204':

          description: No content. Response to successful modification.

        '400':

          $ref: 'TS29571_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29571_CommonData.yaml#/components/responses/401'

        '403':

          $ref: 'TS29571_CommonData.yaml#/components/responses/403'

        '404':

          description: Not Found

          content:

            application/problem+json:

              schema:

                $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'

        '411':

          $ref: 'TS29571_CommonData.yaml#/components/responses/411'

        '413':

          $ref: 'TS29571_CommonData.yaml#/components/responses/413'

        '415':

          $ref: 'TS29571_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29571_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29571_CommonData.yaml#/components/responses/500'

        '502':

          $ref: 'TS29571_CommonData.yaml#/components/responses/502'

        '503':

          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /aiot-data/af-authorization-data:

    get:

      summary: get AF Authorization Data

      operationId: Get AF Authorization Data

      tags:

        - AF Authorization Data Retrieval

      security:

        - {}

        - oAuth2ClientCredentials:

          - nudr-dr:aiot-data:af-authorization-data

          - nudr-dr:aiot-data:af-authorization-data:AfId

      parameters:

        - name: af-id

          in: query

          description: AF ID

          required: false

          schema:

            $ref: 'TS29369_Nadm_DM.yaml#/components/schemas/AfId'

      responses:

        '200':

          description: Expected response to a valid request

          content:

            application/json:

              schema:

                $ref: 'TS29369_Nadm_DM.yaml#/components/schemas/AfAuthorizationData'

        '400':

          $ref: 'TS29571_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29571_CommonData.yaml#/components/responses/401'

        '403':

          $ref: 'TS29571_CommonData.yaml#/components/responses/403'

        '404':

          $ref: 'TS29571_CommonData.yaml#/components/responses/404'

        '406':

          $ref: 'TS29571_CommonData.yaml#/components/responses/406'

        '429':

          $ref: 'TS29571_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29571_CommonData.yaml#/components/responses/500'

        '502':

          $ref: 'TS29571_CommonData.yaml#/components/responses/502'

        '503':

          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

          description: Unexpected error

components:

  schemas:

# STRUCTURED TYPES

    AiotDeviceProfileData:

      description: Contains the AIoT device profile data for a given AIoT device permanent id.

      type: object

      properties:

        aiotDevPermId:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'

          description: >

            Contains an AIoT device permanent identifier.

        lastKnownAiotfInfo:

          $ref: 'TS29369_Nadm_DM.yaml#/components/schemas/LastKnownAiotfInfo'

          description: >

            Contains Last known AIOTF that serves the AIoT device, or unknown.

      required:

        - aiotDevPermId

        - lastKnownAiotfInfo

    AiotDeviceProfileDataPatch:

      description: Contains the modifiable AIoT device profile data for a given AIoT device permanent Id.

      type: object

      properties:

        lastKnownAiotfInfo:

          $ref: 'TS29369_Nadm_DM.yaml#/components/schemas/LastKnownAiotfInfo'

          description: >

            Contains Last known AIOTF that serves the AIoT device, or unknown.

# ENUMS: