{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"approverId": {
"type": "string",
"description": "Approver identifier of the assessment (deprecated, use approvers list instead)"
},
"approverName": {
"type": "string",
"description": "Approver name of the assessment (deprecated, use approvers list instead)"
},
"approverOnlySectionRespondents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"respondentId": {
"type": "string",
"format": "uuid",
"description": "Id of the respondent for approver only sections"
},
"respondentName": {
"type": "string",
"description": "Name of the respondent for approver only sections"
}
}
},
"description": "List of respondents for approver-only sections"
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"approverId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the approver"
},
"approverName": {
"type": "string",
"description": "Display name of the approver"
},
"comment": {
"type": "string",
"description": "Optional comment for the approver assignment"
},
"workflowStageIds": {
"type": "array",
"description": "Workflow Stage Ids"
}
},
"required": [
"approverId"
]
},
"description": "List of approvers for the assessment"
},
"attachmentRequests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachmentId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the attachment"
},
"fileName": {
"type": "string",
"description": "Name of the file being attached to the assessment"
},
"fileDescription": {
"type": "string",
"description": "Optional description of the attached file and its relevance to the assessment"
}
},
"required": [
"attachmentId",
"fileName"
]
},
"description": "List of assessment attachment request"
},
"checkForInFlightAssessments": {
"type": "boolean",
"description": "Whether to check if any in-flight (status < COMPLETED) assessments exist with the same templateRootVersionId"
},
"controlImplementationDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"controlImplementationId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the control implementation"
},
"controlImplementationName": {
"type": "string",
"description": "Name of the control implementation"
},
"controlImplementationNumber": {
"type": "integer",
"format": "int64",
"description": "External number of the control implementation"
},
"sourceId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the source entity associated with the control implementation"
},
"sourceName": {
"type": "string",
"description": "Name of the source entity associated with the control implementation"
},
"sourceType": {
"type": "string",
"enum": [
"APPLICATION",
"SYSTEM",
"DATABASE",
"NETWORK",
"INFRASTRUCTURE"
],
"description": "Type of the source entity associated with the control implementation"
},
"entityBusinessKey": {
"type": "string",
"description": "Business key for the control implementation entity"
}
},
"required": [
"controlImplementationId",
"controlImplementationName"
]
},
"description": "Populated when Control Implementations are selected as Primary for Assessment"
},
"creationSource": {
"type": "string",
"description": "Source of assessment creation",
"enum": [
"RULE_ENGINE_ASSESSMENT_SOURCE",
"DEFAULT",
"COPY",
"REASSESS",
"BULK_IMPORT",
"INVENTORY_STAGE_RULES"
]
},
"deadline": {
"type": "string",
"description": "Deadline to complete the assessment (format: YYYY-MM-DDTHH:MM:SS.FFFZ)"
},
"defaultTemplateDeadlineReminder": {
"type": "boolean",
"description": "Default Template Deadline Reminder"
},
"description": {
"type": "string",
"description": "Description of the assessment"
},
"duplicateNotAllowed": {
"type": "boolean",
"description": "Duplicate Not Allowed"
},
"engagementLink": {
"type": "object",
"description": "Engagement Link",
"properties": {
"engagementId": {
"type": "string",
"description": "Engagement identifier for which the assessment is created"
},
"engagementName": {
"type": "string",
"description": "Name of the engagement linked to the assessment"
},
"number": {
"type": "integer",
"description": "Sequential number assigned to the engagement"
}
},
"required": [
"engagementId",
"engagementName"
]
},
"entityLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name of the label"
},
"nameKey": {
"type": "string",
"description": "Internationalization key for the label name"
},
"referenceEntity": {
"type": "string",
"enum": [
"DATA_CATEGORY",
"PROCESSING_PURPOSE",
"LEGAL_BASIS",
"DATA_SUBJECT",
"RETENTION_PERIOD",
"TRANSFER_METHOD",
"SECURITY_MEASURE"
],
"description": "Type of the reference entity this label is associated with"
},
"valueRefId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the referenced entity value. Null for custom labels."
},
"valueKey": {
"type": "string",
"description": "Internationalization key for the referenced entity value"
}
},
"required": [
"name"
]
},
"description": "List of entity attribute labels for the assessment"
},
"incidentDetails": {
"type": "object",
"description": "Incident Details",
"properties": {
"incidentId": {
"type": "string",
"description": "Unique identifier for the incident associated with the assessment"
},
"incidentName": {
"type": "string",
"description": "Name of the incident associated with the assessment"
}
},
"required": [
"incidentId",
"incidentName"
]
},
"inventoryDetails": {
"type": "object",
"description": "Inventory Details",
"properties": {
"inventoryId": {
"type": "string",
"description": "Inventory ID for which the assessment is created"
},
"inventoryTypeId": {
"type": "integer",
"description": "Type of the inventory for which the assessment is created"
},
"inventoryTypeName": {
"type": "string",
"description": "type name of the inventory for which the assessment is created."
},
"inventoryNumber": {
"type": "integer",
"description": "External number of the inventory for which the assessment is created"
},
"inventoryName": {
"type": "string",
"description": "Name of the inventory for which the assessment is created"
}
},
"required": [
"inventoryId",
"inventoryName",
"inventoryNumber",
"inventoryTypeId"
]
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of labels to attach to the assessment"
},
"name": {
"type": "string",
"description": "Name of the assessment"
},
"orgGroupId": {
"type": "string",
"description": "Organization group identifier to which the assessment should belong"
},
"orgGroupName": {
"type": "string",
"description": "Organization group name to which the assessment should belong"
},
"primaryEntityDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of the assessable entity"
},
"name": {
"type": "string",
"description": "Name of the assessable entity"
},
"number": {
"type": "integer",
"format": "int64",
"description": "Number of the assessable entity"
},
"relationshipResponseDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"relationshipNodeType": {
"type": "string",
"description": "Type of the relationship node"
},
"entityId": {
"type": "string",
"description": "Unique identifier of the related entity"
},
"entityDisplayName": {
"type": "string",
"description": "Display name of the related entity"
},
"entityType": {
"type": "object"
}
}
},
"description": "Relationship Response Details"
},
"displayName": {
"type": "string",
"description": "Display name of the entity"
},
"entityBusinessKey": {
"type": "string",
"description": "Business Key of the entity"
}
}
},
"description": "Populated when Business Object needs to be selected as Primary for Assessment (except Inventory, Incident, Control Implementations and Engagements)"
},
"primaryRecordTypeReference": {
"type": "string",
"description": "Type of primary record when primaryEntityDetails are populated"
},
"reminder": {
"type": "integer",
"description": "Number of days before the deadline when the reminder should be sent to the respondent"
},
"reminderSchedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the reminder schedule."
},
"assessmentId": {
"type": "string",
"format": "uuid",
"description": "Identifier of the assessment this reminder schedule applies to."
},
"sectionId": {
"type": "string",
"format": "uuid",
"description": "Identifier of a specific assessment section this reminder schedule targets (optional)."
},
"reminderInterval": {
"type": "integer",
"format": "int32",
"description": "Interval in days between consecutive reminders."
},
"reminderReceiverEntityType": {
"type": "string",
"enum": [
"APPROVER",
"RESPONDENT",
"ALL"
],
"description": "Recipient type who will receive the reminder notifications."
}
},
"required": [
"reminderReceiverEntityType"
]
},
"description": "Reminder Schedules"
},
"respondentCreationType": {
"type": "string",
"description": "Type of user creation for respondents",
"enum": [
"INVITED",
"PROJECT_RESPONDENT"
]
},
"respondents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"respondentId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the respondent user"
},
"respondentName": {
"type": "string",
"description": "Display name of the respondent"
},
"comment": {
"type": "string",
"description": "Optional comment for the respondent assignment"
},
"sectionIds": {
"type": "array",
"description": "Section Ids"
},
"isRespondentOfApproverSection": {
"type": "boolean",
"description": "Flag indicating whether this respondent is assigned to approver sections"
}
},
"required": [
"respondentName"
]
},
"description": "List of respondents. A minimum of one respondent must be assigned to the assessment"
},
"ruleId": {
"type": "string",
"description": "Identifier of the rule that triggered this assessment creation"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tag identifiers to attach to the assessment during creation"
},
"templateId": {
"type": "string",
"description": "Template identifier for which the assessment has to be created (mandatory if templateRootVersionId is not provided)"
},
"templateRootVersionId": {
"type": "string",
"description": "Template root version identifier for which the assessment has to be created"
},
"triggeredByAssessmentId": {
"type": "string",
"description": "Identifier of the assessment that triggered this assessment creation"
},
"triggeredByAssessmentName": {
"type": "string",
"description": "Name of the assessment that triggered this assessment creation"
},
"userAssignmentMode": {
"type": "string",
"description": "Mode of user assignment for the assessment",
"enum": [
"ASSESSMENT",
"SECTION"
]
},
"workflowId": {
"type": "string",
"description": "Workflow identifier for which the assessment is associated with"
}
},
"required": [
"PCID",
"name",
"respondents"
]
}