Run a Record

curl --request POST \
  --url https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "changed"
}
'

import requests

url = "https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run"

payload = { "mode": "changed" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({mode: 'changed'})
};

fetch('https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => 'changed'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run"

	payload := strings.NewReader("{\n  \"mode\": \"changed\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"changed\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/apps/{app_id}/collections/{collection_id}/records/{record_id}/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"changed\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "Important Record",
  "status": "COMPLETED",
  "source": "API",
  "rules_count": 123,
  "rules_pass_count": 123,
  "rules_fail_count": 123,
  "rules_warn_count": 123,
  "rules": {},
  "config": {
    "id": "<string>",
    "rules": [
      {
        "name": "Check Business Name",
        "key": "CHECK_BUSINESS_NAME",
        "on_success": "PASS",
        "on_fail": "WARN",
        "workflow_id": "work_xxx",
        "workflow_version_id": "workv_xxx",
        "workflow_use_latest": true,
        "execution_order": "before-all",
        "step_key": "<string>",
        "workflow_input_default": {
          "business_name": "Example Corp"
        },
        "disabled": false
      }
    ],
    "mappings": [
      {
        "source_path": "LOAN_APPLICATION:income",
        "destination_paths": [
          "MONTHLY_INCOME:amount",
          "ANNUAL_INCOME:amount"
        ]
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  },
  "collection_name": "<string>",
  "collection_id": "col_xxx",
  "created_by": {
    "id": "user_xxx",
    "name": "John Doe"
  },
  "entity": {
    "id": "<string>",
    "entity_id": "<string>",
    "trigger_id": "<string>",
    "record_id": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "link": "<string>",
  "usage": {
    "total": 123,
    "rules": {},
    "calls": [
      {
        "id": "<string>",
        "total": 123,
        "calls": [
          "<unknown>"
        ]
      }
    ]
  }
}