Specification
Business Partner KIT
API Reference
The BPDM is comprised of two primary services: BPDM Pool and BPDM Gate. The Swagger UI interface, which is an interactive tool for exploring and testing RESTful APIs. Swagger UI provides a user-friendly interface for interacting with APIs, allowing you to make requests, view responses, and explore different API endpoints and operations, allowing you to drill down into specific endpoints and view the associated request parameters, response schemas, and sample responses.
The Business Partner Data Management includes the services that manages and shares business partner data with other Catena-X services. In the following sections, the available methods and different controllers of the API are explained. More Information to the open-source repository can be found on GitHub
BPDM Pool Api reference
The Business Partner Data Management Pool includes the services that manages and shares business partner data with other Catena-X services. In the following sections, the available methods and different controllers of the API are explained.
Available Methods
| Request Method | Request Description |
|---|---|
| PUT | Update. The endpoint expects to receive the full updated record, including values that didn't change. |
| POST | Search |
| GET | Search for the best match |
| DELETE | Deletes all the records in the controller, resets the timestamp |
1. Site Controller
The Site Controller is the controller that creates, updates, or retrieves business partners of type site (referenced via BPNS). There are PUT, POST and GET requests possible and api those are availble under site controller are clustered in table below. Hyperlink in each record gives you more information about api endpoint.
| Site Controller Apis |
|---|
| Update existing site business partners |
| Create new site business partners |
| Search site partners by BPNs and/or parent BPNs |
| Search Main Addresses |
| Get site partners by bpn |
2. Legal Entity Controller
The Legal Entity Controller calls, searches, creates or updates existing business partners of type legal entity (referenced via BPNL). There are PUT, POST and GET requests possible. The endpoint expects a perfect match or looks for the highest relevancy, depending on the request made. Some of the requests need a obligatory parameter, like business partner number or id value. Hyperlink in each record gives you more information about api endpoint.
3. Address Controller
The Address Controller is the controller that updates, creates, or retrieves business partner records of type address via BPNA. There are PUT, POST and GET requests possible. Hyperlink in each record gives you more information about api endpoint.
4. Open Search Controller
The Open Search Controller is only used by the developers on the backend of the API. They are not relevant for the API end-users. Hyperlink in each record gives you more information about api endpoint.
5. Metadata Controller
The Metadata Controller can retrieve and create legal forms, new issuing bodies, identifier types and identifier statuses. There are POST and GET requests possible. Hyperlink in each record gives you more information about api endpoint.
| Metadata Controller |
|---|
| Get page of legal forms |
| Create new legal form |
| Get page of identifier types |
| Create new identifier type |
| Get all field quality rules filtered by country |
6. Changelog Controller
The changelog Controller can retrieve business partner changelog entries from time, by BPN and/or LSA type. The hyperlink in below record gives you more information about api endpoint.
| Changelog Controller Api |
|---|
| Get business partner changelog entries from time, by BPN and/or LSA type |
7. BPN Controller
The BPN Controller retrieves business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries. The hyperlink in below record gives you more information about api endpoint.
| BPN Controller Api |
|---|
| Find business partner numbers by identifiers |
BPDM Gate Api reference
The Business Partner Data Management Gate includes the services that managesto share business partner data with Catena-X.In the following sections, the available methods and different controllers of the API are explained.
Available Methods
| Request Method | Request Description |
|---|---|
| PUT | Update. The endpoint expects to receive the full updated record, including values that didn't change. |
| POST | Search |
| GET | Search for the best match |
| DELETE | Deletes all the records in the controller, resets the timestamp |
Gate service consist of five major controllers which are listed below.
1. Sharing-state Controller
The Sharing-state Controller is the controller that updates, or retrieves business partners of any type (referenced via LSA Type or External identifiers). There are PUT and GET requests possible.
| Sharing-state Controller Api |
|---|
| Get sharing states |
| Insert/update sharing state |
2. Site Controller
The Site Controller is the controller that creates, updates, or retrieves business partners of type site (referenced via BPNS). There are PUT, POST and GET requests possible.
3. legal Entity Controller
The Legal Entity Controller calls, searches, creates or updates existing business partners of type legal entity (referenced via BPNL). There are PUT, POST and GET requests possible. Some of the requests need a obligatory parameter, like external id.
4. Address Controller
The Address Controller is the controller that updates, creates, or retrieves business partner records of type address via BPNA. There are PUT, POST and GET requests possible.
5. Changelog controller
The changelog controller is controller that gets business partner changelog entries by list of external id from timestamp. Only two POST api's available for search of business partner changelog details for input and output respectively.
| Changelog Controller |
|---|
| Get business partner changelog entries for changes to the business partner output data. |
| Get business partner changelog entries for changes to the business partner input data. |
BPDM Bridge Dummy Api reference
The Business Partner Data Management Bridge Dummy includes the services that sync business partner data between Gate and Pool Service. In the following sections, the available methods and different controllers of the API are explained.
Available Methods
| Request Method | Request Description |
|---|---|
| POST | Sync between Gate and Pool |
Bridge Dummy service consist of only one controllers which is listed below.
1. Bridge Controller
Bridge Controller is controller that perfom sync between Gate and Pool. There is only one api end point which is as mentioned below.
| Bridge Controller API |
|---|
| Start sync between Gate and Pool |