What is the IRS?

Within the Catena-X network, the so-called Item Relationship Service (IRS) forms an essential foundation for various services and products. Within the Catena-X use cases, the IRS serves to increase business value. For example, the IRS provides functionalities to serve requirements, such as occasion-based Traceability, from the Supply Chain Act. In doing so, IDSA and Gaia-X principles, such as data interoperability and sovereignty, are maintained on the Catena-X network and access to dispersed data is enabled. Data chains are established as a common asset.

With the help of the IRS, data chains are to be provided ad-hoc across n-tiers within the Catena-X network. To realize these data chains, the IRS relies on data models of the Traceability use case and provides the federated data chains to customers or applications. Furthermore, the target picture of the IRS includes the enablement of new business areas by means of data chains along the value chain in the automotive industry.

Usage

Local deployment

The following subsection provides instructions for running the infrastructure on docker-compose and the application in the IDE.

Docker-compose + IDE

• Start the necessary infrastructure by running docker-compose up

• Start the application from your favorite IDE. For IntelliJ, a run configuration is available in the .run folder.

Local IRS API

• Swagger UI: http://localhost:8080/api/swagger-ui
• API docs: http://localhost:8080/api/api-docs
• API docs in yaml: http://localhost:8080/api/api-docs.yaml

Helm deployment

see INSTALL.md

Sample calls

Start a job for a globalAssetId:

curl -X 'POST' \
  'http://localhost:8080/irs/jobs' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <token_value>' \
  -d '{
  "aspects": [
    "SerialPart"
  ],
  "bomLifecycle": "asBuilt",
  "depth": 1,
  "direction": "downward",
  "globalAssetId": "urn:uuid:8a61c8db-561e-4db0-84ec-a693fc5ffdf6"
}'

Retrieve the job results by using the jobId returned by the previous call:

curl -X 'GET' 'http://localhost:8080/irs/jobs/<jobID>' -H 'accept: application/json' -H 'Authorization: Bearer <token_value>'

Documentation

• Item Relationship Service Documentation

Licenses

For used licenses, please see the NOTICE.

Notice for Docker image

This application provides container images for demonstration purposes.

DockerHub: https://hub.docker.com/r/tractusx/irs-api

Eclipse Tractus-X product(s) installed within the image:

• GitHub: https://github.com/eclipse-tractusx/item-relationship-service
• Project home: https://projects.eclipse.org/projects/automotive.tractusx
• Dockerfile: https://github.com/eclipse-tractusx/item-relationship-service/blob/main/Dockerfile
• Project license: Apache License, Version 2.0

Used base image

• eclipse-temurin:20-jre-alpine
• Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin
• Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
• Additional information about the Eclipse Temurin images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.