Searches for scoping records in the specified workflow.
curl --request POST \
--url https://{subdomain}.logicgate.com/api/v1/records/search/review-scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parentRecordId": "<string>",
"focusRecordId": "<string>",
"scopingTreeId": "<string>",
"sourceRecords": [
{
"recordId": "<string>",
"include": true
}
]
}
'import requests
url = "https://{subdomain}.logicgate.com/api/v1/records/search/review-scope"
payload = {
"parentRecordId": "<string>",
"focusRecordId": "<string>",
"scopingTreeId": "<string>",
"sourceRecords": [
{
"recordId": "<string>",
"include": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentRecordId: '<string>',
focusRecordId: '<string>',
scopingTreeId: '<string>',
sourceRecords: [{recordId: '<string>', include: true}]
})
};
fetch('https://{subdomain}.logicgate.com/api/v1/records/search/review-scope', 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://{subdomain}.logicgate.com/api/v1/records/search/review-scope",
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([
'parentRecordId' => '<string>',
'focusRecordId' => '<string>',
'scopingTreeId' => '<string>',
'sourceRecords' => [
[
'recordId' => '<string>',
'include' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{subdomain}.logicgate.com/api/v1/records/search/review-scope"
payload := strings.NewReader("{\n \"parentRecordId\": \"<string>\",\n \"focusRecordId\": \"<string>\",\n \"scopingTreeId\": \"<string>\",\n \"sourceRecords\": [\n {\n \"recordId\": \"<string>\",\n \"include\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{subdomain}.logicgate.com/api/v1/records/search/review-scope")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parentRecordId\": \"<string>\",\n \"focusRecordId\": \"<string>\",\n \"scopingTreeId\": \"<string>\",\n \"sourceRecords\": [\n {\n \"recordId\": \"<string>\",\n \"include\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/records/search/review-scope")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentRecordId\": \"<string>\",\n \"focusRecordId\": \"<string>\",\n \"scopingTreeId\": \"<string>\",\n \"sourceRecords\": [\n {\n \"recordId\": \"<string>\",\n \"include\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"recordResponse": {
"headers": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"header": "<string>",
"priority": 123,
"link": true,
"direction": "ASC",
"systemField": "NAME",
"labelDisplayType": "VALUE",
"workflow": "<string>",
"field": "<string>",
"workflowMap": "<string>",
"workflowId": "<string>",
"toDelete": true,
"isPrimaryField": true,
"primaryField": true,
"headerOrFieldName": "<string>",
"category": "ANALYSIS",
"sortProperty": "<string>",
"sortable": true,
"customField": true
}
],
"uuid": "<string>",
"content": [
{
"properties": [
{
"header": "<string>",
"fieldType": "TEXT",
"systemField": "NAME",
"recordId": "<string>",
"url": "<string>",
"rawValue": "<unknown>",
"formattedValue": "<string>",
"formattedValueList": [
"<string>"
]
}
],
"record": {
"id": "<string>",
"depth": 123,
"name": "<string>",
"recordName": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"user": true,
"canEdit": true,
"canRead": true,
"step": "<string>",
"workflow": "<string>",
"application": "<string>",
"jiraKey": "<string>",
"stepId": "<string>",
"stepEnd": true
}
}
],
"pageable": {
"paged": true,
"pageNumber": 123,
"pageSize": 123,
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"unpaged": true,
"offset": 123
},
"pageRequest": {
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"pageNumber": 123,
"pageSize": 123,
"offset": 123,
"paged": true,
"unpaged": true
},
"last": true,
"totalElements": 123,
"totalPages": 123,
"first": true,
"numberOfElements": 123,
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"size": 123,
"number": 123,
"empty": true
},
"totalAssessments": 123,
"recordsWithMultipleAssessments": 123
}Record search
Searches for scoping records in the specified workflow
POST
/
api
/
v1
/
records
/
search
/
review-scope
Searches for scoping records in the specified workflow.
curl --request POST \
--url https://{subdomain}.logicgate.com/api/v1/records/search/review-scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parentRecordId": "<string>",
"focusRecordId": "<string>",
"scopingTreeId": "<string>",
"sourceRecords": [
{
"recordId": "<string>",
"include": true
}
]
}
'import requests
url = "https://{subdomain}.logicgate.com/api/v1/records/search/review-scope"
payload = {
"parentRecordId": "<string>",
"focusRecordId": "<string>",
"scopingTreeId": "<string>",
"sourceRecords": [
{
"recordId": "<string>",
"include": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentRecordId: '<string>',
focusRecordId: '<string>',
scopingTreeId: '<string>',
sourceRecords: [{recordId: '<string>', include: true}]
})
};
fetch('https://{subdomain}.logicgate.com/api/v1/records/search/review-scope', 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://{subdomain}.logicgate.com/api/v1/records/search/review-scope",
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([
'parentRecordId' => '<string>',
'focusRecordId' => '<string>',
'scopingTreeId' => '<string>',
'sourceRecords' => [
[
'recordId' => '<string>',
'include' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{subdomain}.logicgate.com/api/v1/records/search/review-scope"
payload := strings.NewReader("{\n \"parentRecordId\": \"<string>\",\n \"focusRecordId\": \"<string>\",\n \"scopingTreeId\": \"<string>\",\n \"sourceRecords\": [\n {\n \"recordId\": \"<string>\",\n \"include\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{subdomain}.logicgate.com/api/v1/records/search/review-scope")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parentRecordId\": \"<string>\",\n \"focusRecordId\": \"<string>\",\n \"scopingTreeId\": \"<string>\",\n \"sourceRecords\": [\n {\n \"recordId\": \"<string>\",\n \"include\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/records/search/review-scope")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentRecordId\": \"<string>\",\n \"focusRecordId\": \"<string>\",\n \"scopingTreeId\": \"<string>\",\n \"sourceRecords\": [\n {\n \"recordId\": \"<string>\",\n \"include\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"recordResponse": {
"headers": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"header": "<string>",
"priority": 123,
"link": true,
"direction": "ASC",
"systemField": "NAME",
"labelDisplayType": "VALUE",
"workflow": "<string>",
"field": "<string>",
"workflowMap": "<string>",
"workflowId": "<string>",
"toDelete": true,
"isPrimaryField": true,
"primaryField": true,
"headerOrFieldName": "<string>",
"category": "ANALYSIS",
"sortProperty": "<string>",
"sortable": true,
"customField": true
}
],
"uuid": "<string>",
"content": [
{
"properties": [
{
"header": "<string>",
"fieldType": "TEXT",
"systemField": "NAME",
"recordId": "<string>",
"url": "<string>",
"rawValue": "<unknown>",
"formattedValue": "<string>",
"formattedValueList": [
"<string>"
]
}
],
"record": {
"id": "<string>",
"depth": 123,
"name": "<string>",
"recordName": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"user": true,
"canEdit": true,
"canRead": true,
"step": "<string>",
"workflow": "<string>",
"application": "<string>",
"jiraKey": "<string>",
"stepId": "<string>",
"stepEnd": true
}
}
],
"pageable": {
"paged": true,
"pageNumber": 123,
"pageSize": 123,
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"unpaged": true,
"offset": 123
},
"pageRequest": {
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"pageNumber": 123,
"pageSize": 123,
"offset": 123,
"paged": true,
"unpaged": true
},
"last": true,
"totalElements": 123,
"totalPages": 123,
"first": true,
"numberOfElements": 123,
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"size": 123,
"number": 123,
"empty": true
},
"totalAssessments": 123,
"recordsWithMultipleAssessments": 123
}Authorizations
ApiTokenbasic
Query Parameters
Body
application/json

