Risk Cloud API: Export Record Data
Updated on: January 17, 2022
In order to properly export Records and their Field data, we first need to gather information on the Layout ID, Application ID, and Workflow ID. Then, we will construct out a JSON body with this information to make a proper POST request for exporting Records.
Obtain Proper API Authentication
Prior to any interaction with Risk Cloud's APIs we will need to set the authorization header. Instructions on how this can be accomplished can be found here.
Layout
The Layout ID can be obtained by either looking for the ID in the URL when in the Layout’s edit modal or by using the following endpoint.
Type: GET https://your-company.logicgate.com/api/v1/layouts
This will return a list of all Layouts. Now, parse this array of Layouts until you find your Layout, and place the Layout ID into your JSON object:
{
"layout": "LAYOUT_ID"
}
Application and Workflow
The Application ID can be found using the following endpoint:
Type: GET https://your-company.logicgate.com/api/v1/applications/workflows
This will return a list of all active Applications with their Workflows. Similarly to Layout, parse this array until you find your Application and Workflow and add this Application ID and Workflow ID into your JSON object. The JSON object should look like this:
{
"layout": "LAYOUT_ID",
"applications": ["APPLICATION_ID"],
"workflow": "WORKFLOW_ID"
}
Note: The key for Applications is plural "application" and is an array of string IDs. Additionally, to export all Records in one Application, across all Workflows in that Application, use a Global Layout and do not specify a Workflow in your JSON body.
Statuses and Steps
With our current JSON body, we will be exporting all Records in the Workflow. What if we wanted to be more granular with our Record selection? Good news!
The next keys in our JSON object, “statuses” and “steps” is optional. This key allows us to filter to the Records with one of the following specific statuses: INACTIVE, NOT_ASSIGNED, ASSIGNED, IN_PROGRESS, COMPLETE. The Step ID can be pulled via the browser’s URL. If you decided to use one of these statuses and specify a Step, your JSON object would look like this:
{
"layout": "LAYOUT_ID",
"applications": ["APPLICATION_ID"],
"workflow": "WORKFLOW_ID",
"statuses": ["IN_PROGRESS"],
"step": "STEP_ID"
}
Retrieve Records
Now you can use the JSON object above as the body of the request to retrieve the Field information and values for your selected Layout, Application, Workflow, Steps, and Record statuses.
Type: POST https://your-company.logicgate.com/api/v1/records/export/csv
Note: To export as an XLSX document, change “csv” to “xlsx” in the request URL.