Launch Assessment

post

https://{hostname}/api/assessment/v3/assessments

Body Params

workflowId

uuid

name

string

required

length between 0 and 2500

description

string

orgGroupId

uuid

orgGroupName

string

approverId

uuid

deprecated

approverName

string

deprecated

approvers

array of objects

approvers

templateId

uuid

templateRootVersionId

uuid

templateType

string

enum

templateName

string

suggestedTemplateId

uuid

suggestedTemplateName

string

deadline

date-time

reminder

int64

reminderSchedules

array of objects

reminderSchedules

respondents

array of objects

required

length between 1 and 2147483647

respondents*

respondentId

uuid

respondentName

string

required

comment

string

sectionIds

array

sectionIds

isRespondentOfApproverSection

boolean

Defaults to false

approverOnlySectionRespondents

array of objects

approverOnlySectionRespondents

respondentCreationType

string

enum

Defaults to INVITED

Allowed:

inventoryDetails

object

incidentDetails

object

controlImplementationDetails

array of objects

controlImplementationDetails

primaryEntityDetails

array of objects

primaryEntityDetails

primaryRecordTypeReference

string

engagementLink

object

ruleId

uuid

triggeredByAssessmentId

uuid

triggeredByAssessmentName

string

tags

userAssignmentMode

string

enum

Defaults to ASSESSMENT

Allowed:

creationSource

string

enum

Defaults to DEFAULT

checkForInFlightAssessments

boolean

Defaults to false

defaultTemplateDeadlineReminder

boolean

labels

array of strings

labels

entityLabels

array of objects

entityLabels

duplicateNotAllowed

boolean

Defaults to false

attachmentRequests

array of objects

attachmentRequests

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*

201Created

429Too Many Requests. For more information, see API Rate Limits.