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
31 changes: 31 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Industry Core Hub Api Collection
Different API Collection for the Industry Core Hub Project.

All the API Collection have been develop with the [Bruno](https://www.usebruno.com/) open source tool.

## Backend API
The Backend API is divided in seven different folders.
* **Part Management**: Management of part metadata - including catalog parts, serialized parts, JIS parts and batches.
* **Partner Management**: Management of master data around business partners - including business partners, data exchange agreements and contracts.
* **Twin Management**: Management of how product information can be managed and shared.
* **Submodel Dispatcher**: Internal API called by EDC Data Planes or Admins in order the deliver data of of the internal used Submodel Service.
* **Sharing Functionality**: Sharing functionality for catalog part twins - including sharing of parts with business partners and automatic generation of digital twins and submodels.
* **Open Connection Management**: Handles the connections from the consumer modules, for specific services like digital twin registry and data endpoints.
* **Part Discovery Management**: Management of the discovery of parts, searching for digital twins and digital twins registries.

> **Note**
>
> The baseUrl is set to "_http://localhost:8000/_", you can change it if you have a different one in the variable on the root folder.

## Licenses

- [Apache-2.0](https://raw.githubusercontent.com/eclipse-tractusx/industry-core-hub/main/LICENSE) for code
- [CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html) for non-code

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/industry-core-hub
11 changes: 11 additions & 0 deletions docs/api/bruno/Industry Core Hub Backend API/Check Health.bru
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Check Health
type: http
seq: 1
}

get {
url: {{baseUrl}}/health
body: none
auth: inherit
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
meta {
name: Data Get
type: http
seq: 1
}

post {
url: {{baseUrl}}/v1/connection/data/get
body: json
auth: inherit
}

body:json {
{
"counter_party_id": "",
"counter_party_address": "",
"filter_expression": [
{}
],
"path": "",
"policies": [],
"verify": "",
"headers": "",
"timeout": "",
"params": "",
"allow_redirects": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
meta {
name: Data Post
type: http
seq: 2
}

post {
url: {{baseUrl}}/v1/connection/data/post
body: json
auth: inherit
}

body:json {
{
"counter_party_id": "",
"counter_party_address": "",
"body": "",
"filter_expression": [
{}
],
"path": "",
"content_type": "",
"policies": "",
"verify": false,
"headers": "",
"timeout": "",
"allow_redirects": false
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
meta {
name: Open Connection Management
}

auth {
mode: inherit
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
meta {
name: Discover Registries
type: http
seq: 1
}

post {
url: {{baseUrl}}/v1/discover/registries
body: json
auth: inherit
}

body:json {
{
"counterPartyId": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
meta {
name: Discover Shell
type: http
seq: 3
}

post {
url: {{baseUrl}}/v1/discover/shell
body: json
auth: inherit
}

body:json {
{
"counterPartyId": "",
"id": "",
"dtrGovernance": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
meta {
name: Discover Shells
type: http
seq: 2
}

post {
url: {{baseUrl}}/v1/discover/shells
body: json
auth: inherit
}

body:json {
{
"counterPartyId": "",
"limit": "",
"cursor": "",
"querySpec": [
{
"name": "",
"value": ""
}
],
"dtrGovernance": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
meta {
name: Discover Submodel
type: http
seq: 5
}

post {
url: {{baseUrl}}/v1/discover/shell/submodel
body: json
auth: inherit
}

body:json {
{
"counterPartyId": "",
"id": "",
"dtrGovernance": "",
"submodelId": "",
"governance": [
{}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
meta {
name: Discover Submodels By Semantic Id
type: http
seq: 6
}

post {
url: {{baseUrl}}/v1/discover/shell/submodels/semanticId
body: json
auth: inherit
}

body:json {
{
"counterPartyId": "",
"id": "",
"dtrGovernance": "",
"semanticIds": "",
"semanticId": "",
"governance": [
{}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
meta {
name: Discover Submodels
type: http
seq: 4
}

post {
url: {{baseUrl}}/v1/discover/shell/submodels
body: json
auth: inherit
}

body:json {
{
"counterPartyId": "",
"id": "",
"dtrGovernance": "",
"governance": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
meta {
name: Part Discovery Management
}

auth {
mode: inherit
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
meta {
name: Part Management Create Catalog Part
type: http
seq: 3
}

post {
url: {{baseUrl}}/v1/part-management/catalog-part
body: json
auth: inherit
}

body:json {
{
"manufacturerId": "",
"manufacturerPartId": "",
"name": "",
"category": "",
"bpns": "",
"description": "",
"materials": "",
"width": "",
"height": "",
"length": "",
"weight": "",
"customerPartIds": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
meta {
name: Part Management Create Partner Mapping
type: http
seq: 4
}

post {
url: {{baseUrl}}/v1/part-management/catalog-part/create-partner-mapping
body: json
auth: inherit
}

body:json {
{
"customerPartId": "",
"businessPartnerNumber": "",
"manufacturerId": "",
"manufacturerPartId": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
meta {
name: Part Management Create Serialized Part
type: http
seq: 6
}

post {
url: {{baseUrl}}/v1/part-management/serialized-part
body: json
auth: inherit
}

body:json {
{
"businessPartnerNumber": "",
"manufacturerId": "",
"manufacturerPartId": "",
"partInstanceId": "",
"van": "",
"customerPartId": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
meta {
name: Part Management Get Catalog Part Details
type: http
seq: 1
}

get {
url: {{baseUrl}}/v1/part-management/catalog-part/:manufacturer_id/:manufacturer_part_id
body: none
auth: inherit
}

params:path {
manufacturer_id:
manufacturer_part_id:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Part Management Get Catalog Parts
type: http
seq: 2
}

get {
url: {{baseUrl}}/v1/part-management/catalog-part
body: none
auth: inherit
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Part Management Get Serialized Parts
type: http
seq: 5
}

get {
url: {{baseUrl}}/v1/part-management/serialized-part
body: none
auth: inherit
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
meta {
name: Part Management Query Serialized Parts
type: http
seq: 7
}

post {
url: {{baseUrl}}/v1/part-management/serialized-part/query
body: json
auth: inherit
}

body:json {
{
"manufacturerId": "",
"manufacturerPartId": "",
"businessPartnerNumber": "",
"customerPartId": "",
"partInstanceId": "",
"van": ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
meta {
name: Part Management
}

auth {
mode: inherit
}
Loading
Loading