CT#110

openapi: 3.0.0

info:

  title: AIMLES_MLModelRetrieval

  version: 1.0.0

  description: |

    API for AIMLES ML Model Retrieval Service.  

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

    All rights reserved.

externalDocs:

  description: >

    3GPP TS 29.482 v19.0.0; Artificial Intelligence Machine Learning Enablement

    (AIMLE) Services; Stage 3.

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

servers:

  - url: '{apiRoot}/aimles-mlmr/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549

security:

  - {}

  - oAuth2ClientCredentials: []

paths:

  /retrieve:

    post:

      summary: Enables a service consumer to send AIMLE ML Model retrieval request to the AIMLE server.

      operationId: RetrieveMLModel

      tags:

        - Retrieve ML Model

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (The requested location information)

          content:

            application/json:

              schema:

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

        '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'

  /subscriptions:

    post:

      summary: Request the creation of a Individual AIMLE ML Model Retrieval Subscription.

      operationId: CreateAimleMLModelRetrievalSubscription

      tags:

        - AIMLE ML Model Retrieval Subscriptions (Collection)

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '201':

          description: >

            The requested Individual AIMLE ML Model Retrieval Subscription is successfully

            created and a representation of the created resource is returned in the response body.

          content:

            application/json:

              schema:

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

          headers:

            Location:

              description: Contains the URI of the newly created resource.

              required: true

              schema:

                type: string

        '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'

      callbacks:

        myNotification:

          '{$request.body#/notifUri}': 

            post:

              summary: Notify on the requested data.

              requestBody:

                required: true

                content:

                  application/json:

                    schema:

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

              responses:

                '204':

                  description: The notification is successfully received.

                '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'

  /subscriptions/{subscriptionId}:

    parameters:

      - name: subscriptionId

        in: path

        description: >

          Represents the Individual AIMLE ML Model Retrieval Subscription resource.

        required: true

        schema:

          type: string

    get:

      summary: Retrieve an existing the Individual AIMLE ML Model Retrieval Subscription resource.

      operationId: GetIndAimleMLModelRetrievalSubscription

      tags:

        - Individual AIMLE ML Model Retrieval Subscription (Document)

      responses:

        '200':

          description: >

            OK. The requested Individual AIMLE ML Model Retrieval Subscription resource

            shall be returned.

          content:

            application/json:

              schema:

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

        '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'

    put:

      summary: Request the update of an existing Individual AIMLE ML Model Retrieval Subscription resource.

      operationId: UpdateIndAimleMLModelRetrievalSubscription

      tags:

        - Individual AIMLE ML Model Retrieval Subscription (Document)

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: >

            OK. The Individual AIMLE ML Model Retrieval Subscription resource is

            successfully updated and a representation of the updated resource shall be returned in

            the response body.

          content:

            application/json:

              schema:

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

        '204':

          description: >

            No Content. The Individual AIMLE ML Model Retrieval Subscription resource is

            successfully updated and no content is returned in the response 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'

    patch:

      summary: Request the modification of an existing Individual AIMLE ML Model Retrieval Subscription resource.

      operationId: ModifyIndAimleMLModelRetrievalSubscription

      tags:

        - Individual AIMLE ML Model Retrieval Subscription (Document)

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: >

            OK. The Individual AIMLE ML Model Retrieval Subscription resource is

            successfully modified and a representation of the updated resource shall be returned in

            the response body.

          content:

            application/json:

              schema:

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

        '204':

          description: >

            No Content. The Individual AIMLE ML Model Retrieval Subscription resource is

            successfully modified and no content is returned in the response 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: Remove the Individual AIMLE ML Model Retrieval Subscription.

      operationId: UnsubscribeAimleMLModelRetrievalSubscription

      tags:

        - Individual AIMLE ML Model Retrieval Subscription (Document).

      responses:

        '204':

          description: >

            The individual AIMLE ML Model Retrieval Subscription resource matching the

            subscriptionId 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:

  securitySchemes:

    oAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}

  schemas:

    MLMdlRetSub:

      description: Represents the AIMLE ML Model Retrieval subscription information.

      type: object

      properties:

        notifUri:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'

        modelSelCrit:

          $ref: 'TS29482_MLR_MLModelManagement.yaml#/components/schemas/MLModel'

        expTime:

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

        suppFeat:

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

      required:

        - notifUri

    MLMdlRetSubPatch:

      description: Represents the requested modifications to the AIMLE ML Model Retrieval subscription information.

      type: object

      properties:

        notifUri:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'

        modelSelCrit:

          $ref: 'TS29482_MLR_MLModelManagement.yaml#/components/schemas/MLModel'

        expTime:

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

    MlMdlRetNotif:

      description: Represents the AIMLE ML Model Retrieval notification.

      type: object

      properties:

        subId:

          type: string

        mlModels:

          type: array

          items:

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

          minItems: 1

      required:

        - subId

    MLMdlRetReq:

      description: Represents the AIMLE ML Model Retrieval request information.

      type: object

      properties:

        modelSelCrit:

          $ref: 'TS29482_MLR_MLModelManagement.yaml#/components/schemas/MLModel'

        suppFeat:

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

    MLMdlRetRsp:

      description: Represents the AIMLE ML Model Retrieval response information.

      type: object

      properties:

        mlModels:

          type: array

          items:

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

          minItems: 1

        suppFeat:

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

      required:

        - mlModels

    MLModelDetail:

      description: Represents the ML Model information.

      type: object

      properties:

        mlModelId:

          type: string

        mlMdlEndpoint:

          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'

        mlModel:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes'

      required:

        - mlModelId

      anyOf:

        - required: [mlMdlEndpoint]

        - required: [mlModel]

# SIMPLE DATA TYPES

#

#

# ENUMERATIONS

#