Eclipse FA³ST Client

The Eclipse FA³ST Client is a Java-based client library for version 3.0.1 of the AAS API and aims to simplify development of AAS client applications. See also the OpenAPI Documentation. For detailed API documentation see JavaDoc.

Tip

For more details on FA³ST Client see the 📘 full documenation.

Usage

Maven

<dependency>
	<groupId>org.eclipse.digitaltwin.fa3st.client</groupId>
	<artifactId>fa3st-client</artifactId>
	<version>1.0.0-SNAPSHOT</version>
</dependency>

Gradle

implementation 'org.eclipse.digitaltwin.fa3st.client:fa3st-client:1.0.0-SNAPSHOT'

Quick start

URI serviceUri = new URI("https://www.example.org/api/v3.0");
AASRepositoryInterface aasRepository = new AASRepositoryInterface(serviceUri);
// Retrieve the AAS from the server.
AssetAdministrationShell aas = aasRepository.getAASInterface("globalUniqueId").get();
// Add a specific asset id to the asset information.
List<SpecificAssetId> specificAssetIds = new ArrayList<>();
specificAssetIds.add(new DefaultSpecificAssetId.Builder().name("specificAssetId").value("serialNumber").build());
AssetInformation updatedAssetInformation = aas.getAssetInformation();
updatedAssetInformation.setSpecificAssetIds(specificAssetIds);
aas.setAssetInformation(updatedAssetInformation);
// Update the AAS on the server.
aasRepository.getAASInterface("globalUniqueId").put(aas);

Supported Features

• CRUD operations for the major interfaces:
  • Asset Administration Shell API, Submodel API
  • Asset Administration Shell Repository API, Submodel Repository API, Concept Description Repository API
  • Asset Administration Shell Registry API, Submodel Registry API
  • Description API
• Searching for specific identifiables in repositories
• Paging
• Synchronous Operations
• Basic Authentication

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions are greatly appreciated. You can find our contribution guidelines here

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Copyright (C) 2025 the Eclipse FA³ST Authors.

You should have received a copy of the Apache 2.0 License along with this program. If not, see https://www.apache.org/licenses/LICENSE-2.0.html.