Use REST API for export

Use the procedure in this topic to configure the REST API export channel. When you select REST API, processed documents and extracted data are exported by configuring REST API calls outside of DocAI Studio. All information required by the API is provided in the interface.

Before you begin

Before configuring the REST API export channel, we recommend that you complete the following steps:

Procedure

From the ribbon, select  Steps.
Select the Export tab.
From the Export channel list, select REST API.
The REST API requires that you configure the following three calls:
1. Logon: This call has four tabs that provide information, expected parameters, and sample code to configure the REST API to log on a user.
2. Export: This call has four tabs that provide information and expected parameters to configure the REST API to export solution data.
3. Logoff: This call has three tabs that provide information and expected parameters to configure the REST API to log off a user.

For each call (Logon, Export, Logoff), review the information provided in the following tabs.

Tab	Description
General	Displays the HTTP method (POST, GET, etc.), endpoint path, summary description, sample request URL, and content type.
Parameters	Lists the expected parameters for the API call, including parameter names, types, and descriptions.
Response	Shows the expected response structure and data format returned by the API call.
Response messages	Lists possible response messages, status codes, and their meanings.

Use the information provided to configure the REST API calls in your external system.

No green or red icons are displayed for the REST API export channel because the API calls are configured and run outside of DocAI Studio.

The document export activity is added to the DocAI Studio workflow.
Once export is configured, Save  your solution.

Next steps

Optional. Configure other export channels.
Optional. Configure other steps.
Optional. If you complete the configuration, publish your solution.