Get Review Rule Repository List

Get review rule repository list, including rule groups and rules information under the repository

GET /api/app-api/sip/platform/v2/review/rule_repo/list

Get Review Rule Repository List

cURL

curl --request GET \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>'

import requests

url = "https://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list"

headers = {
    "x-ti-app-id": "<api-key>",
    "x-ti-secret-code": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-ti-app-id': '<api-key>', 'x-ti-secret-code': '<api-key>'}
};

fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list', 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://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-ti-app-id: <api-key>",
    "x-ti-secret-code: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-ti-app-id", "<api-key>")
	req.Header.Add("x-ti-secret-code", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list")
  .header("x-ti-app-id", "<api-key>")
  .header("x-ti-secret-code", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://docflow.textin.ai/api/app-api/sip/platform/v2/review/rule_repo/list")

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

request = Net::HTTP::Get.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'

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

200

{
  "code": 200,
  "msg": "<string>",
  "result": {
    "repos": [
      {
        "repo_id": "31415926",
        "name": "Review Rule Repo 1",
        "groups": [
          {
            "group_id": "31415926",
            "name": "Review Rule Group 1",
            "rules": [
              {
                "rule_id": "31415926",
                "name": "Review Rule 1",
                "prompt": "Review rule prompt",
                "category_ids": [
                  "1234567890"
                ],
                "referenced_fields": [
                  {
                    "category_id": "1234567890",
                    "category_name": "Invoice",
                    "fields": [
                      {
                        "field_id": "1234567890",
                        "field_name": "Invoice Code"
                      }
                    ],
                    "tables": [
                      {
                        "table_id": "1234567890",
                        "table_name": "Invoice Table",
                        "fields": [
                          {
                            "field_id": "1234567890",
                            "field_name": "Invoice Code"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "category_ids": [
          "1234567890"
        ]
      }
    ],
    "total": 100,
    "page": 1,
    "page_size": 10
  }
}

Authorizations

x-ti-app-id · string · header · required

x-ti-secret-code · string · header · required

Query Parameters

workspace_id · string · required

Workspace ID

Example:

"1234567890"

page · integer · default: 1

Page number

Example:

1

page_size · integer · default: 10

Page size

Example:

10

Response

200 - application/json

Successfully retrieved review rule repository list

code · integer · required

Status code

Example:

200

msg · string · required

Status description

result · object

Show child attributes