diff --git a/README.md b/README.md index cd3ae75dbbad95b4d1d3d02a26217c93ed202d76..f3ca5fc7f1540ff52173161b4085e1e9c2ddd7ba 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ The extension is licensed under [AGPL-3.0](LICENSE.txt). ## Documentation * [How to create a search with the data processor](docs/how_to_create_search.md) +* [Using API output to fetch the results in data processor](docs/HowToAddAPIDataOutput.md) * How to export and import a data processor ## Developer documentation diff --git a/docs/HowToAddAPIDataOutput.md b/docs/HowToAddAPIDataOutput.md new file mode 100644 index 0000000000000000000000000000000000000000..2137f5600597a7985d014cd9aec16abd6cc16399 --- /dev/null +++ b/docs/HowToAddAPIDataOutput.md @@ -0,0 +1,27 @@ +# How to Add API Output in Data Processor + +API output returns an API which can be called to retrieve the Data Processor results. +In this tutorial we are going to add API Output to our Data Processor + +Following the previous tutorials we have added Data Source and Data Fields to Data Processor + +For this tutorial we are considering Contact as the Data Source and DisplayName, Contact ID as the output fields of the Data Processor + +##### Follow the below mentioned steps to add API output: + +- First Navigate to your Data Processor and select **Add Output** +- Select **API** from the **Select Output** dropdown +- Enter the **API Entity Name** +- Enter the **API Action Name** + +See the below screen for example: + + + +- Then click on Save button + +##### Follow the below mentioned steps to see the usage of : +- Navigate to API Explorer v3 under Support -> Developer +- Seach for Entity name you entered while configuring API output (example: MyTestEntity) +- Click on Execute +- This is the result of Data Processor which we can get by making API calls as shown. diff --git a/docs/images/apioutput_configuration.jpeg b/docs/images/apioutput_configuration.jpeg new file mode 100644 index 0000000000000000000000000000000000000000..bab1e4a20f441a998159b34c1e8f7f3c056c84b0 Binary files /dev/null and b/docs/images/apioutput_configuration.jpeg differ