Risk Assessment

Create Risk Assessment

Create new assessment for a entity(vendor) with given name. Allows to update the field which are define custom during cofiguration.

Body:

{

    "name": "string",
    "entity": "string",
    "owner": "string"
    "<column slug for custom field>":"value for custom vield"
}


Documentation for Item Types

Below are the format based on column types which are supposed to be sent as value

  1. Text

  • Description: Handles plain textual data.
  • Input Example: "Hello, World!"
  1. RichText

  • Description: Manages text with rich text formatting elements.
  • Input Example: "Hello, World!"
  1. DateInterval (DATEDELTA)

  • Description: Represents an interval of dates.Intervals allowed: "month", "week", "day", "year" and "hour".
  • Input Example: {"size": 10, "interval": "day"}
  1. Date

  • Description: Manages a single date value. input as %Y-%m-%d format, output as ISO 8601 format
  • Input Example: "2023-01-01"
  1. SingleSelect

  • Description: Handles the selection of a single option from a set of choices.Please take a look at args for 'item' of type SingleSelect, Input is the key of the option to be selected, output is the value of the option selected.
  • Input Example: 2
  1. Binary

  • Description: Manages binary values, typically representing true or false.
  • Input Example: True
  1. MultiSelect

  • Description: Handles the selection of multiple options from a list.Please take a look at args for 'item' of type MultiSelect.Input is the list of keys of the options to be selected, output is the list of values of the options selected.
  • Input Example: [0, 2]
  1. Phone

  • Description: Processes phone number data.
  • Input Example: "+1-123-456-7890"
  1. Email

  • Description: Manages email address information.
  • Input Example: "user@example.com"
  1. User

  • Description: Validates and saves expent user-related data. Input is the array of user ids.
  • Input Example: [76]
  1. Team

  • Description: Validates and saves expent team-related data. Input is the array of team ids.
  • Input Example: [33] [Team Id]
  1. Number

  • Description: Manages numerical values.
  • Input Example: 42
  1. File

  • Description: Processes file data.
  • Input Example: {"filename": "document.txt", "filetype": "txt", "url": "http://example.com/document.txt"}
  1. Url

  • Description: Manages web URLs.
  • Input Example: "http://example.com"
  1. Currency

  • Description: Processes currency data.
  • Input Example: {"amount": 100, "currency": "USD"}
post/v2/risk/assessment

Headers

authorizationstring required

The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer    access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY

The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer    access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY

Request body

namestring required
entitystring required
ownerstring

Response

Successful Response

idstring required
namestring required
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'CLOSED' required

An enumeration.

start_datestring date-time
end_datestring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.