Create a conditional edge path
curl --request POST \
--url https://{subdomain}.logicgate.com/api/v2/paths/edge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "a1b2c3d4",
"to": "a1b2c3d4",
"allowInternal": false,
"allowExternal": false,
"allowCurrentAssignee": false,
"description": "This describes the path.",
"requireAssignee": false,
"operator": "EQUALS",
"priority": 0,
"field": "a1b2c3d4",
"option": {
"textValue": "Medium Risk",
"numericValue": 2
}
}
'import requests
url = "https://{subdomain}.logicgate.com/api/v2/paths/edge"
payload = {
"from": "a1b2c3d4",
"to": "a1b2c3d4",
"allowInternal": False,
"allowExternal": False,
"allowCurrentAssignee": False,
"description": "This describes the path.",
"requireAssignee": False,
"operator": "EQUALS",
"priority": 0,
"field": "a1b2c3d4",
"option": {
"textValue": "Medium Risk",
"numericValue": 2
}
}
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({
from: 'a1b2c3d4',
to: 'a1b2c3d4',
allowInternal: false,
allowExternal: false,
allowCurrentAssignee: false,
description: 'This describes the path.',
requireAssignee: false,
operator: 'EQUALS',
priority: 0,
field: 'a1b2c3d4',
option: {textValue: 'Medium Risk', numericValue: 2}
})
};
fetch('https://{subdomain}.logicgate.com/api/v2/paths/edge', 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/v2/paths/edge",
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([
'from' => 'a1b2c3d4',
'to' => 'a1b2c3d4',
'allowInternal' => false,
'allowExternal' => false,
'allowCurrentAssignee' => false,
'description' => 'This describes the path.',
'requireAssignee' => false,
'operator' => 'EQUALS',
'priority' => 0,
'field' => 'a1b2c3d4',
'option' => [
'textValue' => 'Medium Risk',
'numericValue' => 2
]
]),
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/v2/paths/edge"
payload := strings.NewReader("{\n \"from\": \"a1b2c3d4\",\n \"to\": \"a1b2c3d4\",\n \"allowInternal\": false,\n \"allowExternal\": false,\n \"allowCurrentAssignee\": false,\n \"description\": \"This describes the path.\",\n \"requireAssignee\": false,\n \"operator\": \"EQUALS\",\n \"priority\": 0,\n \"field\": \"a1b2c3d4\",\n \"option\": {\n \"textValue\": \"Medium Risk\",\n \"numericValue\": 2\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/v2/paths/edge")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"a1b2c3d4\",\n \"to\": \"a1b2c3d4\",\n \"allowInternal\": false,\n \"allowExternal\": false,\n \"allowCurrentAssignee\": false,\n \"description\": \"This describes the path.\",\n \"requireAssignee\": false,\n \"operator\": \"EQUALS\",\n \"priority\": 0,\n \"field\": \"a1b2c3d4\",\n \"option\": {\n \"textValue\": \"Medium Risk\",\n \"numericValue\": 2\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v2/paths/edge")
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 \"from\": \"a1b2c3d4\",\n \"to\": \"a1b2c3d4\",\n \"allowInternal\": false,\n \"allowExternal\": false,\n \"allowCurrentAssignee\": false,\n \"description\": \"This describes the path.\",\n \"requireAssignee\": false,\n \"operator\": \"EQUALS\",\n \"priority\": 0,\n \"field\": \"a1b2c3d4\",\n \"option\": {\n \"textValue\": \"Medium Risk\",\n \"numericValue\": 2\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4",
"from": "a1b2c3d4",
"to": "a1b2c3d4",
"allowInternal": false,
"allowExternal": false,
"allowCurrentAssignee": false,
"description": "This describes the path.",
"requireAssignee": false,
"object": "edge-path",
"operator": "EQUALS",
"priority": 0,
"field": {
"id": "a1b2c3d4",
"name": "Risk Severity",
"application": {
"id": "a1b2c3d4",
"name": "Cyber Risk Management Application",
"type": "CONTROLS_COMPLIANCE",
"object": "application"
},
"workflow": {
"id": "a1b2c3d4",
"name": "Risk Assessments",
"recordPrefix": "Assessment",
"object": "workflow"
},
"label": "Enter the Risk Severity based on your assessment",
"global": false,
"required": false,
"tooltip": "Select the Risk Severity",
"helpText": "Determine the Risk Severity from your assessment",
"type": "SELECT",
"valueType": "OPTION",
"optionValues": [
{
"id": "a1b2c3d4",
"type": "OPTION",
"textValue": "Medium Risk",
"numericValue": 2,
"object": "value"
}
],
"defaultValues": [
{
"id": "a1b2c3d4",
"type": "OPTION",
"textValue": "Medium Risk",
"numericValue": 2,
"object": "value"
}
],
"pattern": "[0-9][0-9][0-9]-[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]$",
"message": "<string>",
"expression": "%f + %f",
"nullStrategy": "Available options are: null, 0, 1, N/A, a blank space, and an empty String.",
"logicalHandling": "Some examples are: EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, etc.",
"labelsEnabled": true,
"fieldInputs": [
{
"id": "<string>",
"crossflowReducer": "NEWEST",
"calcSpecificToStep": true,
"calcStep": {
"id": "a1b2c3d4",
"name": "Identify Risk",
"description": "This is a description of the step",
"xpos": 20,
"ypos": 20,
"type": "ORIGIN",
"enableComments": false,
"assignableUserType": "APP_USERS",
"externalUserMfaRequired": false,
"autofillEnabled": false,
"workflow": {
"id": "a1b2c3d4",
"name": "Risk Assessments",
"recordPrefix": "Assessment",
"object": "workflow"
},
"object": "step"
},
"systemField": "NAME",
"fieldWorkflow": {
"id": "a1b2c3d4",
"name": "Risk Assessments",
"recordPrefix": "Assessment",
"object": "workflow"
},
"fieldWorkflowId": "<string>",
"customField": {
"id": "a1b2c3d4",
"name": "Risk Severity",
"label": "Enter the Risk Severity based on your assessment",
"global": false,
"required": false,
"tooltip": "Select the Risk Severity",
"helpText": "Determine the Risk Severity from your assessment",
"type": "SELECT",
"valueType": "OPTION",
"pattern": "[0-9][0-9][0-9]-[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]$",
"message": "<string>",
"expression": "%f + %f",
"nullStrategy": "Available options are: null, 0, 1, N/A, a blank space, and an empty String.",
"logicalHandling": "Some examples are: EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, etc.",
"labelsEnabled": true,
"linkDepth": 123,
"object": "field"
},
"customFieldId": "<string>",
"priority": 123
}
],
"linkDepth": 123,
"object": "field"
},
"option": {
"id": "a1b2c3d4",
"type": "OPTION",
"textValue": "Medium Risk",
"numericValue": 2,
"object": "value"
}
}{
"property": "<string>",
"value": "<string>",
"message": "<string>"
}{
"property": "<string>",
"value": "<string>",
"message": "<string>"
}{
"status": "<string>",
"message": "<string>"
}Edge Path
Create a conditional edge path
Permissions: Build Access to parent application
Create a conditional edge path from a JSON request body.
POST
/
api
/
v2
/
paths
/
edge
Create a conditional edge path
curl --request POST \
--url https://{subdomain}.logicgate.com/api/v2/paths/edge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "a1b2c3d4",
"to": "a1b2c3d4",
"allowInternal": false,
"allowExternal": false,
"allowCurrentAssignee": false,
"description": "This describes the path.",
"requireAssignee": false,
"operator": "EQUALS",
"priority": 0,
"field": "a1b2c3d4",
"option": {
"textValue": "Medium Risk",
"numericValue": 2
}
}
'import requests
url = "https://{subdomain}.logicgate.com/api/v2/paths/edge"
payload = {
"from": "a1b2c3d4",
"to": "a1b2c3d4",
"allowInternal": False,
"allowExternal": False,
"allowCurrentAssignee": False,
"description": "This describes the path.",
"requireAssignee": False,
"operator": "EQUALS",
"priority": 0,
"field": "a1b2c3d4",
"option": {
"textValue": "Medium Risk",
"numericValue": 2
}
}
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({
from: 'a1b2c3d4',
to: 'a1b2c3d4',
allowInternal: false,
allowExternal: false,
allowCurrentAssignee: false,
description: 'This describes the path.',
requireAssignee: false,
operator: 'EQUALS',
priority: 0,
field: 'a1b2c3d4',
option: {textValue: 'Medium Risk', numericValue: 2}
})
};
fetch('https://{subdomain}.logicgate.com/api/v2/paths/edge', 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/v2/paths/edge",
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([
'from' => 'a1b2c3d4',
'to' => 'a1b2c3d4',
'allowInternal' => false,
'allowExternal' => false,
'allowCurrentAssignee' => false,
'description' => 'This describes the path.',
'requireAssignee' => false,
'operator' => 'EQUALS',
'priority' => 0,
'field' => 'a1b2c3d4',
'option' => [
'textValue' => 'Medium Risk',
'numericValue' => 2
]
]),
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/v2/paths/edge"
payload := strings.NewReader("{\n \"from\": \"a1b2c3d4\",\n \"to\": \"a1b2c3d4\",\n \"allowInternal\": false,\n \"allowExternal\": false,\n \"allowCurrentAssignee\": false,\n \"description\": \"This describes the path.\",\n \"requireAssignee\": false,\n \"operator\": \"EQUALS\",\n \"priority\": 0,\n \"field\": \"a1b2c3d4\",\n \"option\": {\n \"textValue\": \"Medium Risk\",\n \"numericValue\": 2\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/v2/paths/edge")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"a1b2c3d4\",\n \"to\": \"a1b2c3d4\",\n \"allowInternal\": false,\n \"allowExternal\": false,\n \"allowCurrentAssignee\": false,\n \"description\": \"This describes the path.\",\n \"requireAssignee\": false,\n \"operator\": \"EQUALS\",\n \"priority\": 0,\n \"field\": \"a1b2c3d4\",\n \"option\": {\n \"textValue\": \"Medium Risk\",\n \"numericValue\": 2\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v2/paths/edge")
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 \"from\": \"a1b2c3d4\",\n \"to\": \"a1b2c3d4\",\n \"allowInternal\": false,\n \"allowExternal\": false,\n \"allowCurrentAssignee\": false,\n \"description\": \"This describes the path.\",\n \"requireAssignee\": false,\n \"operator\": \"EQUALS\",\n \"priority\": 0,\n \"field\": \"a1b2c3d4\",\n \"option\": {\n \"textValue\": \"Medium Risk\",\n \"numericValue\": 2\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4",
"from": "a1b2c3d4",
"to": "a1b2c3d4",
"allowInternal": false,
"allowExternal": false,
"allowCurrentAssignee": false,
"description": "This describes the path.",
"requireAssignee": false,
"object": "edge-path",
"operator": "EQUALS",
"priority": 0,
"field": {
"id": "a1b2c3d4",
"name": "Risk Severity",
"application": {
"id": "a1b2c3d4",
"name": "Cyber Risk Management Application",
"type": "CONTROLS_COMPLIANCE",
"object": "application"
},
"workflow": {
"id": "a1b2c3d4",
"name": "Risk Assessments",
"recordPrefix": "Assessment",
"object": "workflow"
},
"label": "Enter the Risk Severity based on your assessment",
"global": false,
"required": false,
"tooltip": "Select the Risk Severity",
"helpText": "Determine the Risk Severity from your assessment",
"type": "SELECT",
"valueType": "OPTION",
"optionValues": [
{
"id": "a1b2c3d4",
"type": "OPTION",
"textValue": "Medium Risk",
"numericValue": 2,
"object": "value"
}
],
"defaultValues": [
{
"id": "a1b2c3d4",
"type": "OPTION",
"textValue": "Medium Risk",
"numericValue": 2,
"object": "value"
}
],
"pattern": "[0-9][0-9][0-9]-[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]$",
"message": "<string>",
"expression": "%f + %f",
"nullStrategy": "Available options are: null, 0, 1, N/A, a blank space, and an empty String.",
"logicalHandling": "Some examples are: EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, etc.",
"labelsEnabled": true,
"fieldInputs": [
{
"id": "<string>",
"crossflowReducer": "NEWEST",
"calcSpecificToStep": true,
"calcStep": {
"id": "a1b2c3d4",
"name": "Identify Risk",
"description": "This is a description of the step",
"xpos": 20,
"ypos": 20,
"type": "ORIGIN",
"enableComments": false,
"assignableUserType": "APP_USERS",
"externalUserMfaRequired": false,
"autofillEnabled": false,
"workflow": {
"id": "a1b2c3d4",
"name": "Risk Assessments",
"recordPrefix": "Assessment",
"object": "workflow"
},
"object": "step"
},
"systemField": "NAME",
"fieldWorkflow": {
"id": "a1b2c3d4",
"name": "Risk Assessments",
"recordPrefix": "Assessment",
"object": "workflow"
},
"fieldWorkflowId": "<string>",
"customField": {
"id": "a1b2c3d4",
"name": "Risk Severity",
"label": "Enter the Risk Severity based on your assessment",
"global": false,
"required": false,
"tooltip": "Select the Risk Severity",
"helpText": "Determine the Risk Severity from your assessment",
"type": "SELECT",
"valueType": "OPTION",
"pattern": "[0-9][0-9][0-9]-[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]$",
"message": "<string>",
"expression": "%f + %f",
"nullStrategy": "Available options are: null, 0, 1, N/A, a blank space, and an empty String.",
"logicalHandling": "Some examples are: EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, etc.",
"labelsEnabled": true,
"linkDepth": 123,
"object": "field"
},
"customFieldId": "<string>",
"priority": 123
}
],
"linkDepth": 123,
"object": "field"
},
"option": {
"id": "a1b2c3d4",
"type": "OPTION",
"textValue": "Medium Risk",
"numericValue": 2,
"object": "value"
}
}{
"property": "<string>",
"value": "<string>",
"message": "<string>"
}{
"property": "<string>",
"value": "<string>",
"message": "<string>"
}{
"status": "<string>",
"message": "<string>"
}Authorizations
ApiTokenbasic
Bearer token issued via the Authentication endpoints.
Headers
A bearer authorization header containing a Risk Cloud API access token in the format Authorization: Bearer TOKEN — replace TOKEN with your actual access token.
To obtain a Risk Cloud API access token, refer to Obtain an API Access Token in the LogicGate Help Center.
Body
application/json
Conditional edge path (Create).
The ID of the source step.
Example:
"a1b2c3d4"
The ID of the destination step.
Example:
"a1b2c3d4"
Whether a step's current assignee may assign this record to any user with access to the target step on submission.
Example:
false
Whether a step's current assignee may assign this record to external email addresses on submission.
Example:
false
Allow a step's current assignee to submit without assigning
Example:
false
Description of the path.
Example:
"This describes the path."
Require an assignee to be chosen
Example:
false
Type of operator for an edge path.
Available options:
EQUALS, NOT_EQUALS, IS, IS_NOT, GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, CONTAINS, DOES_NOT_CONTAIN, NULL, NOT_NULL, DATE_RANGE, NUMERIC_RANGE Example:
"EQUALS"
Determines which edge path should be invoked first. Priority is in descending order with 0 being the first edge.
Example:
0
Field that is to be evaluated for the edge.
Example:
"a1b2c3d4"
Value to be compared against.
Show child attributes
Show child attributes
Response
Success
The unique ID of this Risk Cloud resource
Example:
"a1b2c3d4"
The ID of the source step.
Example:
"a1b2c3d4"
The ID of the destination step.
Example:
"a1b2c3d4"
Whether a step's current assignee may assign this record to any user with access to the target step on submission.
Example:
false
Whether a step's current assignee may assign this record to external email addresses on submission.
Example:
false
Allow a step's current assignee to submit without assigning
Example:
false
Description of the path.
Example:
"This describes the path."
Require an assignee to be chosen
Example:
false
Identifies the type of object this data represents
Example:
"edge-path"
Type of operator for an edge path.
Available options:
EQUALS, NOT_EQUALS, IS, IS_NOT, GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, CONTAINS, DOES_NOT_CONTAIN, NULL, NOT_NULL, DATE_RANGE, NUMERIC_RANGE Example:
"EQUALS"
Determines which edge path should be invoked first. Priority is in descending order with 0 being the first edge.
Example:
0
Field that is to be evaluated for the edge.
Show child attributes
Show child attributes
Value to be compared against.
Show child attributes
Show child attributes