Start scoped assessment - Risk Cloud Developer Portal

cURL

curl --request POST \
  --url https://{subdomain}.logicgate.com/api/v1/scoped-assessments \
  --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/scoped-assessments"

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/scoped-assessments', 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/scoped-assessments",
  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/scoped-assessments"

	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/scoped-assessments")
  .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/scoped-assessments")

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

{
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "parentRecord": {
    "id": "a1b2c3d4",
    "recordName": "Assessment-7",
    "name": "Medium Risk",
    "status": "IN_PROGRESS",
    "sequenceNumber": 7,
    "dates": {
      "created": "1672552800000",
      "dueDate": "1672552800000",
      "recordDueDate": "1672552800000",
      "daysUntilDue": 3,
      "updated": "1672552800000",
      "completed": "1672552800000",
      "lastCompleted": "1672552800000"
    },
    "assignee": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "creator": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "application": {
      "id": "a1b2c3d4",
      "name": "Cyber Risk Management Application",
      "type": "CONTROLS_COMPLIANCE",
      "object": "application"
    },
    "workflow": {
      "id": "a1b2c3d4",
      "name": "Risk Assessments",
      "recordPrefix": "Assessment",
      "object": "workflow"
    },
    "currentStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "originStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "fields": [
      {
        "id": "a1b2c3d4",
        "name": "Risk Severity",
        "label": "Enter the Risk Severity based on your assessment",
        "global": false,
        "type": "SELECT",
        "valueType": "OPTION",
        "required": false,
        "values": [
          {
            "id": "a1b2c3d4",
            "type": "OPTION",
            "textValue": "Medium Risk",
            "numericValue": 2,
            "object": "value"
          }
        ],
        "object": "field"
      }
    ],
    "object": "application"
  },
  "focusRecord": {
    "id": "a1b2c3d4",
    "recordName": "Assessment-7",
    "name": "Medium Risk",
    "status": "IN_PROGRESS",
    "sequenceNumber": 7,
    "dates": {
      "created": "1672552800000",
      "dueDate": "1672552800000",
      "recordDueDate": "1672552800000",
      "daysUntilDue": 3,
      "updated": "1672552800000",
      "completed": "1672552800000",
      "lastCompleted": "1672552800000"
    },
    "assignee": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "creator": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "application": {
      "id": "a1b2c3d4",
      "name": "Cyber Risk Management Application",
      "type": "CONTROLS_COMPLIANCE",
      "object": "application"
    },
    "workflow": {
      "id": "a1b2c3d4",
      "name": "Risk Assessments",
      "recordPrefix": "Assessment",
      "object": "workflow"
    },
    "currentStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "originStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "fields": [
      {
        "id": "a1b2c3d4",
        "name": "Risk Severity",
        "label": "Enter the Risk Severity based on your assessment",
        "global": false,
        "type": "SELECT",
        "valueType": "OPTION",
        "required": false,
        "values": [
          {
            "id": "a1b2c3d4",
            "type": "OPTION",
            "textValue": "Medium Risk",
            "numericValue": 2,
            "object": "value"
          }
        ],
        "object": "field"
      }
    ],
    "object": "application"
  },
  "creator": {
    "id": "a1b2c3d4",
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "object": "user"
  },
  "assessmentWorkflow1": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "recordPrefix": "<string>",
    "allowGroups": true,
    "requireGroups": true,
    "xpos": 123,
    "ypos": 123,
    "sla": {
      "enabled": true,
      "duration": 123
    },
    "allowAec": true,
    "applicationId": "<string>",
    "workflowType": "WORKFLOW",
    "application": {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "<string>",
      "color": "<string>",
      "icon": "<string>",
      "live": true,
      "permissionsEnabled": true
    }
  },
  "assessmentWorkflow2": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "recordPrefix": "<string>",
    "allowGroups": true,
    "requireGroups": true,
    "xpos": 123,
    "ypos": 123,
    "sla": {
      "enabled": true,
      "duration": 123
    },
    "allowAec": true,
    "applicationId": "<string>",
    "workflowType": "WORKFLOW",
    "application": {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "<string>",
      "color": "<string>",
      "icon": "<string>",
      "live": true,
      "permissionsEnabled": true
    }
  },
  "assessmentWf1RecordCount": 123,
  "assessmentWf2RecordCount": 123
}

POST

api

scoped-assessments

cURL

curl --request POST \
  --url https://{subdomain}.logicgate.com/api/v1/scoped-assessments \
  --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/scoped-assessments"

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/scoped-assessments', 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/scoped-assessments",
  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/scoped-assessments"

	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/scoped-assessments")
  .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/scoped-assessments")

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

{
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "parentRecord": {
    "id": "a1b2c3d4",
    "recordName": "Assessment-7",
    "name": "Medium Risk",
    "status": "IN_PROGRESS",
    "sequenceNumber": 7,
    "dates": {
      "created": "1672552800000",
      "dueDate": "1672552800000",
      "recordDueDate": "1672552800000",
      "daysUntilDue": 3,
      "updated": "1672552800000",
      "completed": "1672552800000",
      "lastCompleted": "1672552800000"
    },
    "assignee": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "creator": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "application": {
      "id": "a1b2c3d4",
      "name": "Cyber Risk Management Application",
      "type": "CONTROLS_COMPLIANCE",
      "object": "application"
    },
    "workflow": {
      "id": "a1b2c3d4",
      "name": "Risk Assessments",
      "recordPrefix": "Assessment",
      "object": "workflow"
    },
    "currentStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "originStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "fields": [
      {
        "id": "a1b2c3d4",
        "name": "Risk Severity",
        "label": "Enter the Risk Severity based on your assessment",
        "global": false,
        "type": "SELECT",
        "valueType": "OPTION",
        "required": false,
        "values": [
          {
            "id": "a1b2c3d4",
            "type": "OPTION",
            "textValue": "Medium Risk",
            "numericValue": 2,
            "object": "value"
          }
        ],
        "object": "field"
      }
    ],
    "object": "application"
  },
  "focusRecord": {
    "id": "a1b2c3d4",
    "recordName": "Assessment-7",
    "name": "Medium Risk",
    "status": "IN_PROGRESS",
    "sequenceNumber": 7,
    "dates": {
      "created": "1672552800000",
      "dueDate": "1672552800000",
      "recordDueDate": "1672552800000",
      "daysUntilDue": 3,
      "updated": "1672552800000",
      "completed": "1672552800000",
      "lastCompleted": "1672552800000"
    },
    "assignee": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "creator": {
      "id": "a1b2c3d4",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "object": "user"
    },
    "application": {
      "id": "a1b2c3d4",
      "name": "Cyber Risk Management Application",
      "type": "CONTROLS_COMPLIANCE",
      "object": "application"
    },
    "workflow": {
      "id": "a1b2c3d4",
      "name": "Risk Assessments",
      "recordPrefix": "Assessment",
      "object": "workflow"
    },
    "currentStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "originStep": {
      "id": "a1b2c3d4",
      "name": "Identify Risk",
      "type": "ORIGIN",
      "object": "step"
    },
    "fields": [
      {
        "id": "a1b2c3d4",
        "name": "Risk Severity",
        "label": "Enter the Risk Severity based on your assessment",
        "global": false,
        "type": "SELECT",
        "valueType": "OPTION",
        "required": false,
        "values": [
          {
            "id": "a1b2c3d4",
            "type": "OPTION",
            "textValue": "Medium Risk",
            "numericValue": 2,
            "object": "value"
          }
        ],
        "object": "field"
      }
    ],
    "object": "application"
  },
  "creator": {
    "id": "a1b2c3d4",
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "object": "user"
  },
  "assessmentWorkflow1": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "recordPrefix": "<string>",
    "allowGroups": true,
    "requireGroups": true,
    "xpos": 123,
    "ypos": 123,
    "sla": {
      "enabled": true,
      "duration": 123
    },
    "allowAec": true,
    "applicationId": "<string>",
    "workflowType": "WORKFLOW",
    "application": {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "<string>",
      "color": "<string>",
      "icon": "<string>",
      "live": true,
      "permissionsEnabled": true
    }
  },
  "assessmentWorkflow2": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "recordPrefix": "<string>",
    "allowGroups": true,
    "requireGroups": true,
    "xpos": 123,
    "ypos": 123,
    "sla": {
      "enabled": true,
      "duration": 123
    },
    "allowAec": true,
    "applicationId": "<string>",
    "workflowType": "WORKFLOW",
    "application": {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "<string>",
      "color": "<string>",
      "icon": "<string>",
      "live": true,
      "permissionsEnabled": true
    }
  },
  "assessmentWf1RecordCount": 123,
  "assessmentWf2RecordCount": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

parentRecordId

string

required

Minimum string length: 1

focusRecordId

string

required

scopingTreeId

string

required

Minimum string length: 1

includeMode

enum<string>

required

Available options:

INCLUDE,

EXCLUDE

sourceRecords

object[]

required

Show child attributes

Response

200 - application/json

string

required

created

string<date-time>

required

parentRecord

Record (Response) · object

required

Show child attributes

focusRecord

Record (Response) · object

required

Show child attributes

creator

User (Property) · object

required

Show child attributes

assessmentWorkflow1

object

required

Show child attributes

assessmentWorkflow2

object

required

Show child attributes

assessmentWf1RecordCount

integer<int32>

required

assessmentWf2RecordCount

integer<int32>

required