Support for API
This section explains how all the microservice APIs supports retrieval and saves the extension data along with the product data.
All the product API's payload contains extension data JSON node to support retrieval and persistence of data into the extension table along with the product data.
- POST or PUT APIs - It supports creating or updating extension data
- GET APIs - Product Select queries, by default, extended to retrieve extension data (as a part of a select clause) along with the product data
Swagger Support for API Extension
Microservice APIs can have a dedicated placeholder for the extensionData by default. Add an empty custom JSON file. This file can be replaced by L2/L3 extension team.
A sample extension data screenshot is given below.
Alternate Key Support for API Extension
Alternate key support is applicable only for GET APIs.
Microservice framework allows GET APIs to query based on the alternate key. It provides support to store the mapping between product key and the alternate key in a separate table as part of the data ingestion.
Alternate key based query functionality can be enabled in the product for the GET APIs based on the business requirement.
In the runtime, you can use the product inquiry APIs by passing AlternateKey ID in the place of product entity ID and pass the product api field name as AlternateKey.
The below example explains the support of alternate key-based inquiry using an arrangement API.
- Operation: GetArrangementInformation:
- URL: http://localhost:8095/party/{partyId}/arrangements?
If the client application wants to fetch arrangement details based on an alternate key (for example, OSPIType_Ref1), then the client can send URL as shown below.
http://localhost:8095/party/ Ref1/arrangements? alternateKey= partyId
Where,
- Ref1 is the alternative key for the party.
- partyId is the identifier that helps framework to identify the resource ID for which alternate key is provided. The identifier is available as a part of the Open API specification provided for this inquiry API.
In this topic
