Risk Cloud API: Moving Records
Updated on: February 14, 2024
In the Risk Cloud web application, records are moved to their next step by submitting them. This behavior can also be performed via the Risk Cloud API for custom integrations.
In this article, we will walk through the steps necessary for moving a record to another step via the Risk Cloud API.
- Obtain the
record-id
of the record to move - Obtain the
step-id
of the step to move to - Move the record to the desired step
Authentication
Obtain your API Access Token to get started, additionally, this endpoint is limited to the Admin role, so ensure that the creator of the API Key used has the Admin role entitlement.
Step 1: Obtain the record-id
The record-id
can be obtained from the Risk Cloud web application, emails, or via the Risk Cloud API. If you already know your record-id
you may continue to Step 2: Obtain the step-id
Using the Risk Cloud application
The most straightforward way to find the record ID for record-id
is to open the desired record in the Risk Cloud web application, then take the ID from the end of the URL.
https://your-company.logicgate.com/records/{record-id}
Using email
The Contextual Notifications feature offers the ability to set Custom Fields and System Fields in outbound emails. As a result, Record ID is a System Field that can be included in outbound emails from the Risk Cloud. This Record ID could in turn be parsed from the email for use in the following Post Record Comment API request.
Using the Risk Cloud API
Reference the article Risk Cloud API: Record Search to obtain record IDs via the Risk Cloud API.
2. Obtain the step-id
Using the Risk Cloud application
Open the desired step from the builder page located at Build > Applications > (Select a Step) in the Risk Cloud web application, then take the ID from the end of the URL. Ensure that this is a valid step on the same workflow that the record represents.
https://your-company.logicgate.com/build/steps/{step-id}
Using the Risk Cloud API
The Steps API, provides a paginated means of iterating through all resources entitled to the API user.
To search for an application, use the Retrieve Steps endpoint.
3. Moving Records
In this step, we will use the record-id
and step-id
found in the previous steps to move the record.
Path Parameter | Description |
record-id |
The unique ID of the record to move |
step-id |
The unique ID of the step to move the record to |
Sample Request Body
The request body can be empty for this PUT
request.
Response
A 200 response with JSON confirming the the structure and status of the moved record.
{ "id": "a1b2c3d4", "active": true, "created": 1706651975544, "updated": null, "sequenceId": 1, "status": "COMPLETE", "name": "A-1", "viewableTitle": "A-1", "initialStateEndStep": false, "workflowDueDate": null, "recordType": "RECORD", "isPublic": false }