Loading TS24560_Aimlec_AIMLEClientParticipation.yaml +11 −11 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_AIMLEClientParticipation version: 1.0.1 version: 1.0.2 description: | API for Client Participation Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading @@ -29,12 +29,12 @@ paths: /participation: post: summary: > Used by AIMLE server to manage the participation of AIMLE clients in AIML operations. Used by AIMLE server to manage the participation of AIMLE clients in AI/ML operations. operationId: ClientParticipation tags: - AIMLE client for participation of the AIML operations request - AIMLE client for participation of the AI/ML operations request (Collection) requestBody: description: Contains information of the AIMLE client participates the AIML operations. description: Contains information of the AIMLE client participates the AI/ML operations. required: true content: application/json: Loading Loading @@ -89,7 +89,7 @@ components: # Structured data types AimlecParticipationReq: description: Represents the participation request for the AIML operations. description: Represents the participation request for the AI/ML operations. type: object required: - requesterId Loading @@ -109,7 +109,7 @@ components: clientSetPart: $ref: '#/components/schemas/ClientSetPart' mlModelId: description: Identifies the identity of the ML model for AIML operation. description: Identifies the identity of the ML model for AI/ML operation. type: string schedAimlOperations: type: array Loading @@ -122,7 +122,7 @@ components: $ref: 'TS29482_AIMLES_AIMLEClientDiscovery.yaml#/components/schemas/ServiceRequirement' AimlecParticipationResp: description: Represents the participation response for the AIML operations. description: Represents the participation response for the AI/ML operations. type: object required: - clientStatus Loading @@ -132,7 +132,7 @@ components: type: boolean SchedAimlOperation: description: Represents the scheduled AIML participation type. description: Represents the scheduled AI/ML participation type. type: object required: - aimlOperation Loading TS24560_Aimlec_AIMLEClientServiceOperations.yaml +10 −10 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_AIMLEClientServiceOperations version: 1.0.1 version: 1.0.2 description: | API for AIMLE Client Service Operations Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading Loading @@ -104,7 +104,7 @@ components: description: Represents the VAL service identifier. type: string servOpId: description: Represents the AIML service operation identifier. description: Represents the AI/ML service operation identifier. type: string servOpMode: $ref: '#/components/schemas/ServiceOperationMode' Loading @@ -126,17 +126,17 @@ components: description: Represents the VAL service identifier. type: string servOpId: description: Represents the AIML service operation identifier. description: Represents the AI/ML service operation identifier. type: string servOpModeStatus: $ref: '#/components/schemas/ServiceOperationMode' ServiceOperationInfo: description: Contains the AIML service operation information. description: Contains the AI/ML service operation information. type: object properties: mlMdlContainer: description: Represents the AIML service model container. description: Represents the AI/ML service model container. type: string mlMdlUri: $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' Loading @@ -146,19 +146,19 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' ServiceOpModeConfiguration: description: Contains the AIML service operation mode configuration. description: Contains the AI/ML service operation mode configuration. type: object properties: maxLatency: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' maxDurHour: description: > Indicates the maximum duration time of the AIML service operation expressed in hours. Indicates the maximum duration time of the AI/ML service operation expressed in hours. type: integer modelAccuracy: description: > Indicates the threshold value of the model accuracy expressed as a percentage to stop the AIML service operation. stop the AI/ML service operation. type: integer # Simple data types Loading TS24560_Aimlec_AimlTaskTransfer.yaml +20 −17 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_AimlTaskTransfer version: 1.0.1 version: 1.0.2 description: | API for AIMLE Client AIML Task Transfer Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). API for AIMLE Client AI/ML Task Transfer Service. © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading @@ -28,10 +28,10 @@ security: paths: /request: post: summary: Enables the AIMLE server to request the AIMLE client to perform AIML task transfer. summary: Enables the AIMLE server to request the AIMLE client to perform AI/ML task transfer. operationId: AimlTaskTransf tags: - AIML task transfer - AI/ML task transfer requestBody: description: Contains the AIMLE client task transfer request information. required: true Loading @@ -47,7 +47,7 @@ paths: schema: $ref: '#/components/schemas/AimleClientTaskTransferRes' '204': description: No Content. The AIMLE client AIML task transfer is performed. description: No Content. The AIMLE client AI/ML task transfer is performed. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': Loading Loading @@ -78,10 +78,10 @@ paths: /request-direct: post: summary: > Enables the AIMLE client to request the target AIMLE client to perform AIML task transfer. Enables the AIMLE client to request the target AIMLE client to perform AI/ML task transfer. operationId: DirAimlTaskTransf tags: - Direct AIML task transfer - Direct AI/ML task transfer requestBody: description: Contains the AIMLE client direct task transfer request information. required: true Loading @@ -91,7 +91,7 @@ paths: $ref: '#/components/schemas/AimleClientDirectTransferReq' responses: '204': description: No Content. The AIMLE client direct AIML task transfer is performed. description: No Content. The AIMLE client direct AI/ML task transfer is performed. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': Loading Loading @@ -157,7 +157,10 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' AimleClientTaskTransferRes: description: Contains the AIMLE client task transfer response information. description: > Contains the AIMLE client task transfer response information. The aimlTaskTransferTime shall be present, although they are not specified as a mandatory due to backward compatibility reasons. type: object properties: aimlTaskTransferTime: Loading Loading @@ -200,10 +203,10 @@ components: 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 type of the AIML Information. Represents the type of the AI/ML Information. Possible values are: - INTERMEDIATE_AIML_OP_RESULTS: Indicates the intermediate AIML operation results type of the AIML information. - INTERMEDIATE_AIML_OP_STATUS: Indicates the intermediate AIML operation status type of the AIML information. - OTHER_AIML_INFO_TYPE: Indicates other types of the AIML information. - INTERMEDIATE_AIML_OP_RESULTS: Indicates the intermediate AI/ML operation results type of the AI/ML information. - INTERMEDIATE_AIML_OP_STATUS: Indicates the intermediate AI/ML operation status type of the AI/ML information. - FIRST_MATCH: Indicates other types of the AI/ML information. TS24560_Aimlec_ClientDataProcessing.yaml +7 −4 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_ClientDataProcessing version: 1.0.1 version: 1.0.2 description: | API for Transfer Learning (TL) Enablement Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading Loading @@ -89,7 +89,10 @@ components: # Structured data types CltDataProcReq: description: Contains information to trigger client data processing procedure. description: > Contains information to trigger client data processing procedure. At least one of dataPrepReqs and dataAnalysisReqs shall be present, although they are not specified as a conditional due to backward compatibility reasons. type: object required: - requesterId Loading TS24560_Aimlec_FLGroupIndication.yaml +14 −11 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_FLGroupIndication version: 1.0.1 version: 1.0.2 description: | API for AIMLE Client Federated Learning Group Indication Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service enabler Architecture Layer for Verticals (SEAL) Protocol Specification; Stage 3. url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.560/ Loading Loading @@ -131,7 +131,10 @@ components: description: Contains FL member data. FlMemberData: description: Represents the FL group member data e.g. FL member identifier, address. description: > Represents the FL group member data e.g. FL member identifier, address. At least one of the flMemberId and flMemberAddr shall be present, although they are not specified as a conditional due to backward compatibility reasons. type: object properties: flMemberId: Loading Loading @@ -178,7 +181,7 @@ components: - type: string enum: - AVAILABLE - STOP - NOT_AVAILABLE - type: string description: > This string provides forward-compatibility with future extensions to the enumeration Loading Loading @@ -235,8 +238,8 @@ components: description: > This string provides information on the FL group deletion cause. description: | Represents the information regarding FL group deletion cause as AIML service termination or Represents the information regarding FL group deletion cause as AI/ML service termination or UE has moved out of the service area. Possible values are: - SRV_TERMINATION: Indicates the AIML service termination. - SRV_TERMINATION: Indicates the AI/ML service termination. - OUT_OF_SRV_AREA: Indicates the UE has moved out of the service area. Loading
TS24560_Aimlec_AIMLEClientParticipation.yaml +11 −11 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_AIMLEClientParticipation version: 1.0.1 version: 1.0.2 description: | API for Client Participation Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading @@ -29,12 +29,12 @@ paths: /participation: post: summary: > Used by AIMLE server to manage the participation of AIMLE clients in AIML operations. Used by AIMLE server to manage the participation of AIMLE clients in AI/ML operations. operationId: ClientParticipation tags: - AIMLE client for participation of the AIML operations request - AIMLE client for participation of the AI/ML operations request (Collection) requestBody: description: Contains information of the AIMLE client participates the AIML operations. description: Contains information of the AIMLE client participates the AI/ML operations. required: true content: application/json: Loading Loading @@ -89,7 +89,7 @@ components: # Structured data types AimlecParticipationReq: description: Represents the participation request for the AIML operations. description: Represents the participation request for the AI/ML operations. type: object required: - requesterId Loading @@ -109,7 +109,7 @@ components: clientSetPart: $ref: '#/components/schemas/ClientSetPart' mlModelId: description: Identifies the identity of the ML model for AIML operation. description: Identifies the identity of the ML model for AI/ML operation. type: string schedAimlOperations: type: array Loading @@ -122,7 +122,7 @@ components: $ref: 'TS29482_AIMLES_AIMLEClientDiscovery.yaml#/components/schemas/ServiceRequirement' AimlecParticipationResp: description: Represents the participation response for the AIML operations. description: Represents the participation response for the AI/ML operations. type: object required: - clientStatus Loading @@ -132,7 +132,7 @@ components: type: boolean SchedAimlOperation: description: Represents the scheduled AIML participation type. description: Represents the scheduled AI/ML participation type. type: object required: - aimlOperation Loading
TS24560_Aimlec_AIMLEClientServiceOperations.yaml +10 −10 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_AIMLEClientServiceOperations version: 1.0.1 version: 1.0.2 description: | API for AIMLE Client Service Operations Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading Loading @@ -104,7 +104,7 @@ components: description: Represents the VAL service identifier. type: string servOpId: description: Represents the AIML service operation identifier. description: Represents the AI/ML service operation identifier. type: string servOpMode: $ref: '#/components/schemas/ServiceOperationMode' Loading @@ -126,17 +126,17 @@ components: description: Represents the VAL service identifier. type: string servOpId: description: Represents the AIML service operation identifier. description: Represents the AI/ML service operation identifier. type: string servOpModeStatus: $ref: '#/components/schemas/ServiceOperationMode' ServiceOperationInfo: description: Contains the AIML service operation information. description: Contains the AI/ML service operation information. type: object properties: mlMdlContainer: description: Represents the AIML service model container. description: Represents the AI/ML service model container. type: string mlMdlUri: $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' Loading @@ -146,19 +146,19 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' ServiceOpModeConfiguration: description: Contains the AIML service operation mode configuration. description: Contains the AI/ML service operation mode configuration. type: object properties: maxLatency: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' maxDurHour: description: > Indicates the maximum duration time of the AIML service operation expressed in hours. Indicates the maximum duration time of the AI/ML service operation expressed in hours. type: integer modelAccuracy: description: > Indicates the threshold value of the model accuracy expressed as a percentage to stop the AIML service operation. stop the AI/ML service operation. type: integer # Simple data types Loading
TS24560_Aimlec_AimlTaskTransfer.yaml +20 −17 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_AimlTaskTransfer version: 1.0.1 version: 1.0.2 description: | API for AIMLE Client AIML Task Transfer Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). API for AIMLE Client AI/ML Task Transfer Service. © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading @@ -28,10 +28,10 @@ security: paths: /request: post: summary: Enables the AIMLE server to request the AIMLE client to perform AIML task transfer. summary: Enables the AIMLE server to request the AIMLE client to perform AI/ML task transfer. operationId: AimlTaskTransf tags: - AIML task transfer - AI/ML task transfer requestBody: description: Contains the AIMLE client task transfer request information. required: true Loading @@ -47,7 +47,7 @@ paths: schema: $ref: '#/components/schemas/AimleClientTaskTransferRes' '204': description: No Content. The AIMLE client AIML task transfer is performed. description: No Content. The AIMLE client AI/ML task transfer is performed. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': Loading Loading @@ -78,10 +78,10 @@ paths: /request-direct: post: summary: > Enables the AIMLE client to request the target AIMLE client to perform AIML task transfer. Enables the AIMLE client to request the target AIMLE client to perform AI/ML task transfer. operationId: DirAimlTaskTransf tags: - Direct AIML task transfer - Direct AI/ML task transfer requestBody: description: Contains the AIMLE client direct task transfer request information. required: true Loading @@ -91,7 +91,7 @@ paths: $ref: '#/components/schemas/AimleClientDirectTransferReq' responses: '204': description: No Content. The AIMLE client direct AIML task transfer is performed. description: No Content. The AIMLE client direct AI/ML task transfer is performed. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': Loading Loading @@ -157,7 +157,10 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' AimleClientTaskTransferRes: description: Contains the AIMLE client task transfer response information. description: > Contains the AIMLE client task transfer response information. The aimlTaskTransferTime shall be present, although they are not specified as a mandatory due to backward compatibility reasons. type: object properties: aimlTaskTransferTime: Loading Loading @@ -200,10 +203,10 @@ components: 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 type of the AIML Information. Represents the type of the AI/ML Information. Possible values are: - INTERMEDIATE_AIML_OP_RESULTS: Indicates the intermediate AIML operation results type of the AIML information. - INTERMEDIATE_AIML_OP_STATUS: Indicates the intermediate AIML operation status type of the AIML information. - OTHER_AIML_INFO_TYPE: Indicates other types of the AIML information. - INTERMEDIATE_AIML_OP_RESULTS: Indicates the intermediate AI/ML operation results type of the AI/ML information. - INTERMEDIATE_AIML_OP_STATUS: Indicates the intermediate AI/ML operation status type of the AI/ML information. - FIRST_MATCH: Indicates other types of the AI/ML information.
TS24560_Aimlec_ClientDataProcessing.yaml +7 −4 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_ClientDataProcessing version: 1.0.1 version: 1.0.2 description: | API for Transfer Learning (TL) Enablement Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/' Loading Loading @@ -89,7 +89,10 @@ components: # Structured data types CltDataProcReq: description: Contains information to trigger client data processing procedure. description: > Contains information to trigger client data processing procedure. At least one of dataPrepReqs and dataAnalysisReqs shall be present, although they are not specified as a conditional due to backward compatibility reasons. type: object required: - requesterId Loading
TS24560_Aimlec_FLGroupIndication.yaml +14 −11 Original line number Diff line number Diff line Loading @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: Aimlec_FLGroupIndication version: 1.0.1 version: 1.0.2 description: | API for AIMLE Client Federated Learning Group Indication Service. © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > 3GPP TS 24.560 V19.0.0; Artificial Intelligence Machine Learning (AIML) Services – 3GPP TS 24.560 V19.1.0; Artificial Intelligence / Machine Learning (AIML) Services – Service enabler Architecture Layer for Verticals (SEAL) Protocol Specification; Stage 3. url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.560/ Loading Loading @@ -131,7 +131,10 @@ components: description: Contains FL member data. FlMemberData: description: Represents the FL group member data e.g. FL member identifier, address. description: > Represents the FL group member data e.g. FL member identifier, address. At least one of the flMemberId and flMemberAddr shall be present, although they are not specified as a conditional due to backward compatibility reasons. type: object properties: flMemberId: Loading Loading @@ -178,7 +181,7 @@ components: - type: string enum: - AVAILABLE - STOP - NOT_AVAILABLE - type: string description: > This string provides forward-compatibility with future extensions to the enumeration Loading Loading @@ -235,8 +238,8 @@ components: description: > This string provides information on the FL group deletion cause. description: | Represents the information regarding FL group deletion cause as AIML service termination or Represents the information regarding FL group deletion cause as AI/ML service termination or UE has moved out of the service area. Possible values are: - SRV_TERMINATION: Indicates the AIML service termination. - SRV_TERMINATION: Indicates the AI/ML service termination. - OUT_OF_SRV_AREA: Indicates the UE has moved out of the service area.
