Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ paths:
operationId: GetAssetAdministrationShellById
x-semanticIds:
- https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/2
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Asset Administration Shell
Expand Down Expand Up @@ -505,6 +507,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -700,6 +703,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ paths:
operationId: GetAssetAdministrationShellById
x-semanticIds:
- https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/2
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Asset Administration Shell
Expand Down Expand Up @@ -244,6 +246,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -307,6 +310,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down
8 changes: 8 additions & 0 deletions Entire-API-Collection/V3.2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -548,6 +549,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -2956,6 +2958,8 @@ paths:
operationId: GetAssetAdministrationShellById
x-semanticIds:
- https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/2
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Asset Administration Shell
Expand Down Expand Up @@ -3331,6 +3335,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -3527,6 +3532,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -4852,6 +4858,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -5053,6 +5060,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down
10 changes: 9 additions & 1 deletion Part2-API-Schemas/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ info:
description: >-
The schemas implementing the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).

Copyright: Industrial Digital Twin Association (IDTA) 2025
Copyright: Industrial Digital Twin Association (IDTA) 2026
contact:
name: Industrial Digital Twin Association (IDTA)
email: info@idtwin.org
Expand Down Expand Up @@ -60,6 +60,14 @@ components:
required: false
schema:
type: string
Date:
name: date
in: query
description: Date and time of the requested version of the Asset Administration Shell in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If not provided, the latest version is returned.
required: false
schema:
type: string
format: date-time
Extent:
name: extent
in: query
Expand Down
2 changes: 2 additions & 0 deletions SubmodelRepositoryServiceSpecification/V3.2_SSP-001.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -447,6 +448,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down
2 changes: 2 additions & 0 deletions SubmodelRepositoryServiceSpecification/V3.2_SSP-002.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down Expand Up @@ -269,6 +270,7 @@ paths:
parameters:
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Level'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Extent'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Date'
responses:
'200':
description: Requested Submodel
Expand Down
12 changes: 12 additions & 0 deletions documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Note: Changes in Metamodel (IDTA-01001) will not be listed here, although they h
Major Changes:

* ...
* Add new operations GetAssetAdministrationShellVersionByIdAndDate and GetSubmodelVersionByIdAndDate to retrieve a specific version of an AAS or Submodel from a given point in time.


Minor Changes:
Expand All @@ -28,11 +29,21 @@ Minor Changes:
[%autowidth,width="100%",cols="40%,15%,45%",options="header",]
|===
h|Operation h|Kind of Change h|Comment
| a| GetAssetAdministrationShellVersionByIdAndDate | New a| new API-Operation for AAS Repository interface to retrieve a specific version of an AAS from a given point in time.
| GetSubmodelVersionByIdAndDate | New a| new API-Operation for Submodel Repository interface to retrieve a specific version of a Submodel from a given point in time.
| GenerateSerializationByIds|change a| Added a note to clarify the intended behavior for transitively referenced concept descriptions. (https://github.com/admin-shell-io/aas-specs-api/issues/510[#510])
| PutAssetAdministrationShellById|change a| Added the missing `id` input parameter and a note explaining the behavior in case the AAS identifier does not match the value of `id`. (https://github.com/admin-shell-io/aas-specs-api/issues/506[#506])
|===


=== Interface Changes w.r.t. V3.1.1 to V3.2

[%autowidth,width="100%",cols="10%,29%,10%,51%",options="header",]
|===
h|BWC h|Interface h|Kind of Change h|Comment
| ===


== Changes w.r.t. V3.1 to V3.1.1

Major Changes:
Expand Down Expand Up @@ -63,6 +74,7 @@ h|Operation h|Kind of Change h|Comment
|===



== Changes w.r.t. V3.0.4 to V3.1

Major Changes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,8 @@ base64url-encoded identifier

path-suffix=$reference or no suffix normal

date=\{dateTime\} is the date and time for which the version of the AAS shall be retrieved, e.g. "2024-01-01T12:00:00Z" for January 1st, 2024 at 12:00:00 UTC.

|PostAssetAdministrationShell |POST |/shells |
|PutAssetAdministrationShellById |PUT |/shells/\{aasIdentifier} |base64url-encoded identifier
|DeleteAssetAdministrationShellById |DELETE |/shells/\{aasIdentifier} |base64url-encoded identifier
Expand Down Expand Up @@ -557,6 +559,8 @@ path-suffix=$metadata or no suffix for normal

base64url-encoded identifier

date=\{dateTime\} is the date and time for which the version of the Submodel shall be retrieved, e.g. "2024-01-01T12:00:00Z" for January 1st, 2024 at 12:00:00 UTC. Only applicable for the 'normal' and 'value' operations.

|PostSubmodel |POST |/submodels |
|PutSubmodelById |PUT |/submodels/\{submodelIdentifier} |base64url-encoded identifier
|PatchSubmodelById |PATCH |/submodels/\{submodelIdentifier} |path-suffix=$metadata/$value or no suffix for normal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The name of the service specification ends with "ServiceSpecification".
The supported service specification or profile can be discovered at the /description endpoint.
This endpoint will return the related profile string.
It is sufficient to only expose the latest service specification identifier in case a server supports different minor versions of a service specification at the same time.
For instance, if both "https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-002" and "https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-002" are supported, the server may only include "https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-002" in its profiles list.
For instance, if both "https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-002" and "https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-002" are supported, the server may only include "https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-002" in its profiles list.

Clients shall understand that lower minor versions of service specifications are supported even if only one service specification identifier is provided.

Expand Down Expand Up @@ -665,18 +665,18 @@ xref:specification/interfaces.adoc#GetSelfDescription[GetDescription]

See: https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.2.0_SSP-002

[#asset-administration-shell-repository-service-specification-service-specification]
[#asset-administration-shell-repository-service-specification]
== Asset Administration Shell Repository Service Specification

[%autowidth,width="100%",cols="42%,58%",options="header",]
|===
h|Service Specification / Profiles h|Description
|<<asset-administration-shell-repository-service-specification-service-specification-ssp-001,AssetAdministrationShellRepositoryServiceSpecification/SSP-001>> |Full feature set
|<<asset-administration-shell-repository-service-specification-service-specification-ssp-002,AssetAdministrationShellRepositoryServiceSpecification/SSP-002>> |Only read operations; is included in the profile AssetAdministrationShellRepositoryServiceSpecification/SSP-001
|<<asset-administration-shell-repository-service-specification-service-specification-ssp-003,AssetAdministrationShellRepositoryServiceSpecification/SSP-003>> |Query operations
|<<asset-administration-shell-repository-service-specification-ssp-001,AssetAdministrationShellRepositoryServiceSpecification/SSP-001>> |Full feature set
|<<asset-administration-shell-repository-service-specification-ssp-002,AssetAdministrationShellRepositoryServiceSpecification/SSP-002>> |Only read operations; is included in the profile AssetAdministrationShellRepositoryServiceSpecification/SSP-001
|<<asset-administration-shell-repository-service-specification-ssp-003,AssetAdministrationShellRepositoryServiceSpecification/SSP-003>> |Query operations
|===

[#asset-administration-shell-repository-service-specification-service-specification-ssp-001]
[#asset-administration-shell-repository-service-specification-ssp-001]
=== Asset Administration Shell Repository Service Specification – Full Profile

[%autowidth,width="100%",cols="30%,70%",options="header",]
Expand All @@ -688,6 +688,7 @@ h|Feature h|Appearance
_AAS Repository API:_ +
xref:specification/interfaces.adoc#GetAllAssetAdministrationShells[GetAllAssetAdministrationShells] +
xref:specification/interfaces.adoc#GetAssetAdministrationShellById[GetAssetAdministrationShellById] +
xref:specification/interfaces.adoc#GetAssetAdministrationShellVersionByIdAndDate[GetAssetAdministrationShellVersionByIdAndDate] +
xref:specification/interfaces.adoc#GetAllAssetAdministrationShellsByAssetId[GetAllAssetAdministrationShellsByAssetId] +
xref:specification/interfaces.adoc#GetAllAssetAdministrationShellsByIdShort[GetAllAssetAdministrationShellsByIdShort] +
xref:specification/interfaces.adoc#PostAssetAdministrationShell[PostAssetAdministrationShell] +
Expand All @@ -707,6 +708,7 @@ xref:specification/interfaces.adoc#DeleteThumbnail[DeleteThumbnail]
__Submodel Repository API by superpath:__ +
xref:specification/interfaces.adoc#GetAllSubmodels[GetAllSubmodels] +
xref:specification/interfaces.adoc#GetSubmodelById[GetSubmodelById] +
xref:specification/interfaces.adoc#GetSubmodelVersionByIdAndDate[GetSubmodelVersionByIdAndDate] +
xref:specification/interfaces.adoc#GetAllSubmodelsBySemanticId[GetAllSubmodelsBySemanticId] +
xref:specification/interfaces.adoc#GetAllSubmodelsByIdShort[GetAllSubmodelsByIdShort] +
xref:specification/interfaces.adoc#PostSubmodel[PostSubmodel] +
Expand Down Expand Up @@ -762,6 +764,7 @@ h|Feature h|Appearance
_AAS Repository API:_ +
xref:specification/interfaces.adoc#GetAllAssetAdministrationShells[GetAllAssetAdministrationShells] +
xref:specification/interfaces.adoc#GetAssetAdministrationShellById[GetAssetAdministrationShellById] +
xref:specification/interfaces.adoc#GetAssetAdministrationShellVersionByIdAndDate[GetAssetAdministrationShellVersionByIdAndDate] +
xref:specification/interfaces.adoc#GetAllAssetAdministrationShellsByAssetId[GetAllAssetAdministrationShellsByAssetId] +
xref:specification/interfaces.adoc#GetAllAssetAdministrationShellsByIdShort[]

Expand Down Expand Up @@ -850,6 +853,7 @@ h|Feature h|Appearance
__Submodel Repository API:__ +
xref:specification/interfaces.adoc#GetAllSubmodels[GetAllSubmodels] +
xref:specification/interfaces.adoc#GetSubmodelById[GetSubmodelById] +
xref:specification/interfaces.adoc#GetSubmodelVersionByIdAndDate[GetSubmodelVersionByIdAndDate] +
xref:specification/interfaces.adoc#GetAllSubmodelsBySemanticId[GetAllSubmodelsBySemanticId] +
xref:specification/interfaces.adoc#GetAllSubmodelsByIdShort[GetAllSubmodelsByIdShort] +
xref:specification/interfaces.adoc#PostSubmodel[PostSubmodel] +
Expand Down Expand Up @@ -904,6 +908,7 @@ h|Feature h|Appearance
_Submodel Repository API:_ +
xref:specification/interfaces.adoc#GetAllSubmodels[GetAllSubmodels] +
xref:specification/interfaces.adoc#GetSubmodelById[GetSubmodelById] +
xref:specification/interfaces.adoc#GetSubmodelVersionByIdAndDate[GetSubmodelVersionByIdAndDate] +
xref:specification/interfaces.adoc#GetAllSubmodelsBySemanticId[GetAllSubmodelsBySemanticId] +
xref:specification/interfaces.adoc#GetAllSubmodelsByIdShort[GetAllSubmodelsByIdShort]

Expand Down Expand Up @@ -1069,17 +1074,17 @@ xref:specification/interfaces.adoc#GetSelfDescription[GetDescription]

See: https://app.swaggerhub.com/apis/Plattform_i40/SubmodelRepositoryServiceSpecification/V3.2.0_SSP-005

[#concept-description-repository-service-specification-service-specification]
[#concept-description-repository-service-specification]
== Concept Description Repository Service Specification

[cols="59%,41%"]
|===
h|Service Specification / Profiles h|Description
|<<concept-description-repository-service-specification-service-specification-ssp-001,ConceptDescriptionRepositoryServiceSpecification/SSP-001>> |Full feature set
|<<concept-description-repository-service-specification-service-specification-ssp-002,ConceptDescriptionRepositoryServiceSpecification/SSP-002>> |Query operations
|<<concept-description-repository-service-specification-ssp-001,ConceptDescriptionRepositoryServiceSpecification/SSP-001>> |Full feature set
|<<concept-description-repository-service-specification-ssp-002,ConceptDescriptionRepositoryServiceSpecification/SSP-002>> |Query operations
|===

[#concept-description-repository-service-specification-service-specification-ssp-001]
[#concept-description-repository-service-specification-ssp-001]
=== Concept Description Repository Service Specification – Full Profile

[%autowidth,width="100%",cols="30%,70%",options="header",]
Expand Down Expand Up @@ -1111,7 +1116,7 @@ xref:specification/interfaces.adoc#GetSelfDescription[GetDescription]

See: https://app.swaggerhub.com/apis/Plattform_i40/ConceptDescriptionRepositoryServiceSpecification/V3.2.0_SSP-001

[#concept-description-repository-service-specification-service-specification-ssp-002]
[#concept-description-repository-service-specification-ssp-002]
=== Concept Description Repository Service Specification – Query Profile

[%autowidth, width="100%", cols="30%,70%",options="header",]
Expand All @@ -1132,4 +1137,3 @@ xref:specification/interfaces.adoc#GetSelfDescription[GetDescription]
|===

See: https://app.swaggerhub.com/apis/Plattform_i40/ConceptDescriptionRepositoryServiceSpecification/V3.2.0_SSP-002

Loading
Loading