Return a paginated list of fields from a particular workflow.
curl --request GET \
--url https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}', 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/fields/workflow/{workflowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"totalElements": 123,
"totalPages": 123,
"first": true,
"last": true,
"numberOfElements": 123,
"pageable": {
"paged": true,
"pageNumber": 123,
"pageSize": 123,
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"unpaged": true,
"offset": 123
},
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"size": 123,
"content": [
{
"id": "<string>",
"fieldType": "TEXT",
"name": "<string>",
"labels": [
"<string>"
],
"label": "<string>",
"tooltip": "<string>",
"helpText": "<string>",
"format": "CURRENCY",
"currency": "EUR",
"enabledForRecordAccess": true,
"currentValues": [
{
"id": "<string>",
"valueType": "<string>",
"discriminator": "<string>",
"textValue": "<string>",
"numericValue": 123,
"isDefault": true,
"archived": true,
"priority": 123,
"userGroup": "<string>",
"fieldId": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true
}
],
"defaultValues": [
{
"id": "<string>",
"valueType": "<string>",
"discriminator": "<string>",
"textValue": "<string>",
"numericValue": 123,
"isDefault": true,
"archived": true,
"priority": 123,
"userGroup": "<string>",
"fieldId": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true
}
],
"analysisEstimate": "CONFIDENCE",
"analysisType": "CONTACT_FREQUENCY",
"operators": [
"EQUALS"
],
"convertibleTo": [
"<string>"
],
"copyRecordAccessField": true,
"valueType": "<string>",
"global": true,
"requiresUniqueValue": true,
"analysisOutputField": true,
"discrete": true,
"crossWorkflowCalculation": true,
"validTypeForCalculationInput": true
}
],
"number": 123,
"empty": true
}Field
Return a paginated list of fields from a particular workflow
Given a workflowId and FieldRequest, get a pageable list of all matching fields from that workflow. Pageable parameters can be added as a request param in the url.
GET
/
api
/
v1
/
fields
/
workflow
/
{workflowId}
Return a paginated list of fields from a particular workflow.
curl --request GET \
--url https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}', 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/fields/workflow/{workflowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/fields/workflow/{workflowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"totalElements": 123,
"totalPages": 123,
"first": true,
"last": true,
"numberOfElements": 123,
"pageable": {
"paged": true,
"pageNumber": 123,
"pageSize": 123,
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"unpaged": true,
"offset": 123
},
"sort": {
"sorted": true,
"unsorted": true,
"empty": true
},
"size": 123,
"content": [
{
"id": "<string>",
"fieldType": "TEXT",
"name": "<string>",
"labels": [
"<string>"
],
"label": "<string>",
"tooltip": "<string>",
"helpText": "<string>",
"format": "CURRENCY",
"currency": "EUR",
"enabledForRecordAccess": true,
"currentValues": [
{
"id": "<string>",
"valueType": "<string>",
"discriminator": "<string>",
"textValue": "<string>",
"numericValue": 123,
"isDefault": true,
"archived": true,
"priority": 123,
"userGroup": "<string>",
"fieldId": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true
}
],
"defaultValues": [
{
"id": "<string>",
"valueType": "<string>",
"discriminator": "<string>",
"textValue": "<string>",
"numericValue": 123,
"isDefault": true,
"archived": true,
"priority": 123,
"userGroup": "<string>",
"fieldId": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true
}
],
"analysisEstimate": "CONFIDENCE",
"analysisType": "CONTACT_FREQUENCY",
"operators": [
"EQUALS"
],
"convertibleTo": [
"<string>"
],
"copyRecordAccessField": true,
"valueType": "<string>",
"global": true,
"requiresUniqueValue": true,
"analysisOutputField": true,
"discrete": true,
"crossWorkflowCalculation": true,
"validTypeForCalculationInput": true
}
],
"number": 123,
"empty": true
}Authorizations
ApiTokenbasic
Query Parameters
Available options:
TEXT, EXTERNAL_USER, EXTERNAL_ID, TEXT_AREA, DATE_PICKER, NUMBER, E_SIGNATURE, CHECKBOX, MULTI_SELECT, RADIO, SELECT, USER, ATTACHMENT, CALCULATION, TEXT_CONCATENATION, FIXED_DATE_CALCULATION, LINKED_RECORDS_COUNT, DUE_DATE, DAYS_UNTIL_DUE, EVIDENCE, AEC_INFO, ANNUAL_LOSS_EXPOSURE Response
200 - application/json
OK

