Design

Back Next

Execute Data Marketplace API

You can use Data Marketplace APIs to access data assets and data collections through GET, POST, and PUT methods, and perform business orchestration. You can execute Data Marketplace APIs for processes that run on the Cloud Server.

You can configure a Data Marketplace API in the Service step and invoke it using API Gateway.

To use Data Marketplace APIs in a process, you must configure the

Allowed Groups

or the

Allowed Users

fields. Users must have the Data Marketplace administrator role to invoke a process that integrates with a Data Marketplace API.

The following image shows the Execute Data Marketplace API properties:

Input Fields

Configure the following input fields in the Service step for a Data Marketplace API:

HTTP Method: Required. The HTTP method to invoke the Data Marketplace API such as GET, PUT, or POST.
Relative Path: Required. The relative path of the Data Marketplace API.
For example, to perform operations on the data assets in Data Marketplace, enter the following as the relative path:

dataAssets

To perform operations on the data elements in Data Marketplace, enter the following as the relative path:

dataAssets/{{id}}/dataElements
Payload: The JSON payload to be sent to the Data Marketplace API using the PUT or POST method.
For example, to send employee data to the Data Marketplace API, enter the data in the JSON format as shown in the following sample:

'{ "Employee": [ { "firstName ": "Cindy", "lastName": "Louis", "department": "IT" "status": "Employed" } ] }'
Query Parameter: The process object that returns the data associated with the Data Marketplace API query parameters.
You can use the API query parameters such as sort or status to sort or filter the data using the GET method. Based on the query parameter, the API returns the associated data in the XML format.

You can configure the Query Parameter field by using a formula or field.

For example, to use a formula to get the maximum number of assets with the enabled status, use the status query parameter as shown in the following sample:

<DataMarketplaceQueryParameters> <queryParams> <name>status</name> <value>ENABLED</value> </queryParams> <queryParams> <name>limit</name> <value>10</value> </queryParams> </DataMarketplaceQueryParameters>

For information about using another field to configure the Query Parameter field, see Creating fields to execute Data Marketplace API.
Path Variable: The process object that is associated with the Data Marketplace API path variables.
You can configure the Path Variable field by using a formula or field.

For example, to insert data elements into the data asset, provide the ID in the path variable as shown in the following sample:

<DataMarketplacePathVariables> <pathVariables> <name>id</name> <value>eu33-39839j2</value> </pathVariables> <pathVariables> <name>categoryId</name> <value>ad2c915-60c4</value> </pathVariables> </DataMarketplacePathVariables>

For information about using another field to configure the Path Variable field, see Creating fields to execute Data Marketplace API.

Output Field

Configure the following output field in the Assignment step or Decision step for a Data Marketplace API:

Name	Type	Description
Data Marketplace Response	Text	The string variable that stores the output.

For more information about Data Marketplace APIs, see the Data Marketplace help.

Creating fields to execute Data Marketplace API

You can configure the query parameter and path variable by passing the value as a field.

To pass the value of the query parameter and path variable as a field, you must create temporary fields. You must select the custom type as

Data Marketplace Query Parameters

process object for the query parameter field and

Data Marketplace Path Variables

process object for the path variable field as shown in the following image:

The image shows the temporary fields that you can configure for a Data Marketplace API.

The temporary fields you created appear in the Assignment step. In the Assignment step, you can configure the values for the query parameter and path variable temporary fields as shown in the following image:

The image shows the name value pairs that you can configure for query parameter and path variable.

Here,

queryParams

and

pathVariables

are the input fields configured in the Data Marketplace Query Parameters and Data Marketplace Path Variables process objects with the name-value pair.

In the Service step, you must select the temporary fields that were added for the query parameter or path variable field values as shown in the following image: