desc
","assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","deadline":"2025-06-30T00:00:00.000","orgGroupId":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","taskTypeNameKey":"ef4e5bf9-7462-43af-b74f-72b61308629b","priority":"MEDIUM","collaborators":[{"collaboratorId":"0d9739ff-541c-48d9-9861-c9b94ea6c1ae","type":"GROUP"}]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"},"examples":{"Task Creation Response":{"summary":"Sample response for a successful task creation","description":"Task Creation Response","value":{"id":"989f1de5-d41f-45d7-a93a-78f554a41f54","parentEntityId":"c37283de-c93e-4da6-a3da-0c1791da5e33","taskName":"task_04","taskType":{"name":"projects","nameKey":"TaskRegistry.TaskType.ModuleTask.Name.Projects","module":"CustomObject","moduleNameTranslationKey":"TaskRegistry.Module.Name.CustomObject","id":"504ccd60-8966-40e6-bb6c-13f7d10dbfe7","label":null,"icon":"/cdn/static/images/onetrust/taskregistry/Projects.svg"},"deadline":"2025-06-30T00:00:00Z","status":"Open","priority":"MEDIUM","description":"desc
","orgGroupId":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","orgGroupAttribute":{"valueKey":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","value":"PLTF REP"},"assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","isActive":true,"sourceType":null,"sourceId":null,"moduleSource":null,"taskAssignmentInformations":[{"userInfo":{"name":"Arpita K","nameWithAttributes":"Arpita K"},"assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER","isCollaborator":false},{"userInfo":{"name":"Test User Group","nameWithAttributes":null},"assigneeId":"0d9739ff-541c-48d9-9861-c9b94ea6c1ae","type":"GROUP","isCollaborator":true}],"presentationMode":"DRAWER","isCollaboratorSupported":true,"isCollaboratorGroupSupported":true,"relativeUrl":null,"activity":"COMPLETE_TASK","workflowAndStageBasicInformation":null,"workflowId":null,"workflowStageId":null,"stageName":null,"stageNameKey":null,"badgeColor":null,"dueDateInfo":null,"permissionsMetadata":null,"createdBy":"41955b71-e581-4187-ab6c-d00d1403350c","createdByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"createdDT":"2025-06-12T11:54:17.177Z","modifiedBy":null,"modifiedByAttribute":null,"modifiedDT":null,"completionDate":null,"isRequired":false,"canEditRequiredTask":null,"pastDue":false,"activityKey":"TaskRegistry.ActivityKey.CompleteTask"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["OBJECT_MANAGER","OBJECT_MANAGER_READ","OBJECT_MANAGER_WRITE","INTEGRATION"]}]}},"/v1/tasks/{taskId}":{"get":{"operationId":"findTaskUsingGET_1","summary":"Get Task","description":"Use this API to retrieve a specific task on an object. The response will include details such as the activity history, assignee, and deadline.\n\n> 🗒 Things to Know\n> \n> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.","tags":["Object Task Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/platform-object-manager.json"},"parameters":[{"name":"taskId","in":"path","description":"The unique identifier of the task.","required":true,"schema":{"description":"Unique identifier of the task to retrieve","type":"string","format":"uuid","example":"41955b71-e581-4187-ab6c-d00d1403350c"},"example":"41955b71-e581-4187-ab6c-d00d1403350c"},{"name":"includePermissionsMetadata","in":"query","description":"This flag indicates whether to include permissions metadata.","required":false,"schema":{"description":"Whether to include permissions metadata in the response","type":"boolean","default":false},"example":false},{"name":"excludeInactiveTask","in":"query","description":"This flag indicates whether to exclude inactive tasks.","required":false,"schema":{"description":"Whether to exclude inactive tasks from the response","type":"boolean","default":false},"example":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"},"examples":{"Task Details Response":{"summary":"Sample response with complete task details","description":"Task Details Response","value":{"id":"a1f229b1-8041-48ba-9354-ce90c03ce5b8","parentEntityId":"804c2939-c265-4181-9f52-fbdba80ff042","taskName":"task_01","taskType":{"name":"datasets","nameKey":"TaskRegistry.TaskType.ModuleTask.Name.Datasets","module":"CustomObject","moduleNameTranslationKey":"TaskRegistry.Module.Name.CustomObject","id":"c569969c-94a9-4e2c-869d-e8334063d2ed","label":null,"icon":null},"deadline":"2025-07-01T00:00:00Z","status":"Open","priority":"LOW","description":"desc
","orgGroupId":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","orgGroupAttribute":{"valueKey":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","value":"PLTF REP"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","isActive":true,"sourceType":null,"sourceId":null,"moduleSource":null,"taskAssignmentInformations":[{"userInfo":{"name":"User 1","nameWithAttributes":"User 1"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","type":"USER","isCollaborator":false},{"userInfo":{"name":"Arpita K","nameWithAttributes":"Arpita K"},"assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER","isCollaborator":true},{"userInfo":{"name":"ADAN-7056_TEST","nameWithAttributes":null},"assigneeId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP","isCollaborator":true}],"presentationMode":"DRAWER","isCollaboratorSupported":true,"isCollaboratorGroupSupported":true,"relativeUrl":"https://lkgb.1trust.app/ai-governance/datasets-type/datasets/804c2939-c265-4181-9f52-fbdba80ff042/details?context=eyJ0ZW5hbnRIYXNoIjoiJDJhJDEwJENSanpTWUJNSE1zeWk3dXE4RG1PZS5pZ3dQUm9XcFllSUFIdE1Wa0JoaGVGVVM2dmFNM0J5In0%3D&contextVersion=1","activity":"COMPLETE_TASK","workflowAndStageBasicInformation":null,"workflowId":null,"workflowStageId":null,"stageName":null,"stageNameKey":null,"badgeColor":null,"dueDateInfo":null,"permissionsMetadata":null,"createdBy":"41955b71-e581-4187-ab6c-d00d1403350c","createdByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"createdDT":"2025-06-12T11:59:08.581Z","modifiedBy":"41955b71-e581-4187-ab6c-d00d1403350c","modifiedByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"modifiedDT":"2025-06-12T12:04:06.048Z","completionDate":null,"isRequired":false,"canEditRequiredTask":null,"pastDue":false,"activityKey":"TaskRegistry.ActivityKey.CompleteTask"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["OBJECT_MANAGER","OBJECT_MANAGER_READ","OBJECT_MANAGER_WRITE","INTEGRATION"]}]},"put":{"operationId":"updateTaskUsingPUT_1","summary":"Update Task","description":"Use this API to update an existing task for an object.\n\n> 🗒 Things to Know\n> \n> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.","tags":["Object Task Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/platform-object-manager.json"},"parameters":[{"name":"taskId","in":"path","description":"The unique identifier of the task.","required":true,"schema":{"description":"Unique identifier of the task to update","type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateRequest"},"examples":{"Update Task Status":{"summary":"Update task status and progress","description":"Updates a task's status and progress information","value":{"taskName":"task_01","description":"desc
","assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","deadline":"2025-06-30T00:00:00.000","status":"Open","priority":"LOW","collaborators":[{"collaboratorId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER"},{"collaboratorId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP"}]}},"Reassign Task":{"summary":"Change task assignee and due date","description":"Reassigns a task to a different person and updates the due date","value":{"taskName":"task_01","description":"desc
","assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","deadline":"2025-07-01T00:00:00.000","status":"Open","priority":"LOW","collaborators":[{"collaboratorId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER"},{"collaboratorId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"},"examples":{"Updated Task Response":{"summary":"Sample response for a successful task update","description":"Updated Task Response","value":{"id":"a1f229b1-8041-48ba-9354-ce90c03ce5b8","parentEntityId":"804c2939-c265-4181-9f52-fbdba80ff042","taskName":"task_01","taskType":{"name":"datasets","nameKey":"TaskRegistry.TaskType.ModuleTask.Name.Datasets","module":"CustomObject","moduleNameTranslationKey":"TaskRegistry.Module.Name.CustomObject","id":"c569969c-94a9-4e2c-869d-e8334063d2ed","label":null,"icon":null},"deadline":"2025-07-01T00:00:00Z","status":"Open","priority":"LOW","description":"desc
","orgGroupId":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","orgGroupAttribute":{"valueKey":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","value":"PLTF REP"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","isActive":true,"sourceType":null,"sourceId":null,"moduleSource":null,"taskAssignmentInformations":[{"userInfo":{"name":"ADAN-7056_TEST","nameWithAttributes":null},"assigneeId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP","isCollaborator":true},{"userInfo":{"name":"User 1","nameWithAttributes":"User 1"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","type":"USER","isCollaborator":false},{"userInfo":{"name":"Arpita K","nameWithAttributes":"Arpita K"},"assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER","isCollaborator":true}],"presentationMode":"DRAWER","isCollaboratorSupported":true,"isCollaboratorGroupSupported":true,"relativeUrl":null,"activity":"COMPLETE_TASK","workflowAndStageBasicInformation":null,"workflowId":null,"workflowStageId":null,"stageName":null,"stageNameKey":null,"badgeColor":null,"dueDateInfo":null,"permissionsMetadata":null,"createdBy":"41955b71-e581-4187-ab6c-d00d1403350c","createdByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"createdDT":"2025-06-12T11:59:08.581Z","modifiedBy":"41955b71-e581-4187-ab6c-d00d1403350c","modifiedByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"modifiedDT":"2025-06-12T12:04:05.812Z","completionDate":null,"isRequired":false,"canEditRequiredTask":null,"pastDue":false,"activityKey":"TaskRegistry.ActivityKey.CompleteTask"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["OBJECT_MANAGER","OBJECT_MANAGER_READ","OBJECT_MANAGER_WRITE","INTEGRATION"]}]}}},"components":{"schemas":{"TaskCollaboratorDto":{"type":"object","properties":{"collaboratorId":{"description":"The unique identifier of the user assigned as a collaborator on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"collaboratorEmail":{"description":"The email address of the user assigned as a collaborator on the task.","type":"string","example":"collaborator@example.com","maxLength":255,"minLength":5},"type":{"description":"The type of collaborator. ","type":"string","example":"USER","enum":["USER","GROUP"]}},"example":{"collaboratorId":"123e4567-e89b-12d3-a456-426614174000","collaboratorEmail":"collaborator@example.com","type":"USER"},"required":["type"]},"TaskContextInformation":{"type":"object","properties":{"parameters":{"description":"This parameter can be used to store details in key value pairs.","additionalProperties":{"type":"object"},"example":{"taskId":"123e4567-e89b-12d3-a456-426614174000","priority":"HIGH","assignedTo":"john.doe@example.com"},"type":"object"}},"example":{"parameters":{"assignedTo":"john.doe@example.com","priority":"HIGH","taskId":"123e4567-e89b-12d3-a456-426614174000"}}},"TaskUpdateRequest":{"type":"object","properties":{"taskName":{"description":"The name of the task.","type":"string","example":"Review document","maxLength":512,"minLength":1},"description":{"description":"The description of the task.","type":"string","example":"Please review the attached document and provide feedback","maxLength":2000},"assigneeId":{"description":"The unique identifier of the user assigned as an assignee on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assigneeEmail":{"description":"The email address of the user assigned as an assignee on the task.","type":"string","example":"user@example.com","maxLength":255,"minLength":5},"collaborators":{"description":"The details of the collaborators assigned to the task.","type":"array","items":{"$ref":"#/components/schemas/TaskCollaboratorDto"}},"deadline":{"description":"The date and time by which the task should be completed.","type":"string","format":"date-time","example":"2023-12-31T23:59:59"},"status":{"description":"The status of the task.","type":"string","example":"Open","enum":["Open","Closed"]},"context":{"description":"The contextual details of the task.","$ref":"#/components/schemas/TaskContextInformation"},"priority":{"description":"The priority level of the task.","type":"string","example":"MEDIUM","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"isRequired":{"description":"This flag indicates whether the task is required.","type":"boolean","example":false,"default":"false"},"sourceType":{"description":"The type of source that created the task.","type":"string","example":"RULES","maxLength":16,"minLength":1},"sourceId":{"description":"The unique identifier of the source that created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}},"example":{"taskName":"Review document","description":"Please review the attached document and provide feedback","assigneeId":"123e4567-e89b-12d3-a456-426614174000","deadline":"2023-12-31T23:59:59","status":"Open","priority":"MEDIUM"},"required":["taskName"]},"AttributeValue":{"type":"object","properties":{"valueKey":{"description":"The name key of the attribute used for translation purposes.","type":"string","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","maxLength":255,"minLength":1},"value":{"description":"The name of the attribute.","type":"string","example":"Document Review Team","maxLength":255,"minLength":1}},"example":{"valueKey":"f47ac10b-58cc-4372-a567-0e02b2c3d479","value":"Document Review Team"},"required":["value","valueKey"]},"DueDateInfo":{"type":"object","properties":{"date":{"description":"The date and time that the task is due.","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"color":{"description":"The color code for displaying the task due date.","type":"string","example":"#FF0000","maxLength":7,"minLength":1},"icon":{"description":"The icon of the task due date.","type":"string","example":"clock-warning","maxLength":50,"minLength":1},"textKey":{"description":"The text key to display with the task due date used for translation purposes.","type":"string","example":"TaskRegistry.DueDate.Overdue","maxLength":255,"minLength":1},"numberOfDays":{"description":"The number of days until or past the task due date.","type":"integer","format":"int64","example":5}},"example":{"date":"2023-12-31T23:59:59Z","color":"#FF0000","icon":"clock-warning","textKey":"TaskRegistry.DueDate.Overdue","numberOfDays":5},"required":["color","date","icon","numberOfDays","textKey"]},"TaskAssignmentInformation":{"type":"object","properties":{"userInfo":{"description":"The details of the users or user groups responsible for the task.","$ref":"#/components/schemas/UserInfo"},"assigneeId":{"description":"The unique identifier of the user or user group assigned to the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"description":"The type of assignee or collaborator. ","type":"string","example":"USER","enum":["USER","GROUP"]},"isCollaborator":{"description":"This flag indicates whether the user or user group was added as a collaborator.","type":"boolean","example":false,"default":"false"}},"example":{"taskId":"123e4567-e89b-12d3-a456-426614174000","userInfo":{"id":"123e4567-e89b-12d3-a456-426614174001","name":"John Doe"},"assigneeId":"123e4567-e89b-12d3-a456-426614174000","type":"USER","isCollaborator":false},"required":["assigneeId","isCollaborator","type"]},"TaskInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"parentEntityId":{"description":"The unique identifier of the parent record where the task was created.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskName":{"description":"The name of the task.","type":"string","example":"Review Document XYZ","maxLength":255,"minLength":1},"taskType":{"description":"The details of the task type.","example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Document Review","description":"Review and approve documents"},"$ref":"#/components/schemas/TaskTypeInformation"},"deadline":{"description":"The date and time by which the task should be completed.","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"status":{"description":"The status of the task.","type":"string","example":"Open","enum":["Open","Closed"]},"priority":{"description":"The priority level of the task.","type":"string","example":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"description":{"description":"The description of the task.","type":"string","example":"This task requires reviewing document X and providing feedback","maxLength":4000},"orgGroupId":{"description":"The unique identifier of the organization responsible for the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"orgGroupAttribute":{"description":"The attribute details of the organization responsible for the task.","example":{"value":"OneTrust LLC","valueKey":"123e4567-e89b-12d3-a456-426614174000"},"$ref":"#/components/schemas/AttributeValue"},"assigneeId":{"description":"The unique identifier of the user assigned as an assignee on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"isActive":{"description":"This flag indicates whether the task is active.","type":"boolean","example":true,"default":"true"},"sourceType":{"description":"The type of source that created the task.","type":"string","example":"RULES","maxLength":50},"sourceId":{"description":"The unique identifier of the source that created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"moduleSource":{"description":"The source product of the task.","type":"string","example":"assessment","enum":["assessment","audit-mgmt","cyber-risk","data-mapping","data-governance","esg","erm","incident","issue","itrm","program-benchmarking","maturity-planning","risk","vendor","vendor-portal","compliance-automation","SpeakUp","EntityScoping","ControlObjective","exception"]},"taskAssignmentInformations":{"description":"The details of the task assignment.","type":"array","items":{"$ref":"#/components/schemas/TaskAssignmentInformation"},"example":[{"assigneeId":"123e4567-e89b-12d3-a456-426614174000","assigneeName":"John Doe","assignmentType":"PRIMARY"}]},"presentationMode":{"description":"The presentation mode of the task.","type":"string","example":"DEFAULT","enum":["NAVIGATION","DRAWER"]},"isCollaboratorSupported":{"description":"This flag indicates whether users can be assigned as collaborators on the task.","type":"boolean","example":true,"default":"false"},"isCollaboratorGroupSupported":{"description":"This flag indicates whether user groups can be assigned as collaborators on the task.","type":"boolean","example":true,"default":"false"},"relativeUrl":{"description":"The relative URL associated with the task.","type":"string","example":"/tasks/review/123","maxLength":255},"activity":{"description":"The type of activity for the task.","type":"string","example":"COMPLETE_TASK","enum":["COMPLETE_TASK","REVIEW_DSARSUBTASK","APPROVE_RISK","RESPOND_TO_ASSESSMENT","COMPLETE_AUDIT","REVIEW_REQUEST","COURSE_COMPLETION_PENDING","REVIEW_ASSESSMENT","REVIEW_INCIDENT","IMPLEMENT_CONTROL","RISK_TREATMENT","REVIEW_FINDING","ACKNOWLEDGE_TO_ATTESTATION","REVIEW_INITIATIVE","COMPLETE_DISCLOSURE","COMPLETE_DISCLOSURE_ATTESTATION","EVIDENCE_TASK","COMPLETE_DISC_QUESTIONNAIRE","COMPLIANCE_INITIATIVE","REVIEW_ISSUE","CASE_ASSIGNED","SPEAK_UP_QUESTION_ASSIGNED","CONTROL_OBJECTIVE","REVIEW_EXCEPTION"]},"workflowAndStageBasicInformation":{"description":"The details of the workflow and stage.","type":"object","example":{"workflowName":"Document Approval Workflow","currentStage":"Review Stage","stageOrder":2}},"workflowId":{"description":"The unique identifier of the workflow.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"workflowStageId":{"description":"The unique identifier of the workflow stage.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"stageName":{"description":"The name of the workflow stage.","type":"string","example":"Review","maxLength":255},"stageNameKey":{"description":"The name key of the workflow stage used for translation purposes.","type":"string","example":"TaskRegistry.Stage.Review","maxLength":255},"badgeColor":{"description":"The badge color of the workflow stage.","type":"string","example":"#4287f5","maxLength":7},"dueDateInfo":{"description":"The details of the task due date.","$ref":"#/components/schemas/DueDateInfo"},"permissionsMetadata":{"description":"The permissions metadata for the task.","type":"object","additionalProperties":{"type":"boolean"}},"createdBy":{"description":"The unique identifier of the user who created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"createdByAttribute":{"description":"The attribute details of the user who created the task.","example":{"value":"Jane Smith","valueKey":"456e7890-e89b-12d3-a456-426614174000"},"$ref":"#/components/schemas/AttributeValue"},"createdDT":{"description":"The date and time that the task was created.","type":"string","format":"date-time","example":"2023-01-15T14:30:00Z"},"modifiedBy":{"description":"The unique identifier of the user who modified the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"modifiedByAttribute":{"description":"The attribute details of the user who modified the task.","example":{"value":"Jane Smith","valueKey":"456e7890-e89b-12d3-a456-426614174000"},"$ref":"#/components/schemas/AttributeValue"},"modifiedDT":{"description":"The date and time that the task was modified.","type":"string","format":"date-time","example":"2023-01-20T16:45:00Z"},"completionDate":{"description":"The date and time that the task was completed.","type":"string","format":"date-time","example":"2023-01-25T09:15:00Z"},"isRequired":{"description":"This flag indicates whether the task is required.","type":"boolean","example":true,"default":"false"},"canEditRequiredTask":{"description":"This flag indicates whether the task can be edited.","type":"boolean","example":false,"default":"false"},"pastDue":{"description":"This flag indicates whether the task is past due.","type":"boolean"},"activityKey":{"description":"The key of the activity type used for translation purposes.","type":"string","deprecated":true}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","taskName":"Document Review Task","status":"Open","priority":"MEDIUM","deadline":"2023-12-31T23:59:59Z","description":"This task requires reviewing document X and providing feedback","assigneeId":"123e4567-e89b-12d3-a456-426614174000","isActive":true,"taskType":{"id":"type-123","name":"Document Review","description":"Review and approve documents"},"moduleSource":"PRIVACY_RIGHTS","activity":"COMPLETE_TASK","presentationMode":"DEFAULT","isCollaboratorSupported":true,"relativeUrl":"/tasks/review/123","workflowId":"workflow-456","stageName":"Review","isPastDue":false,"createdDT":"2023-01-15T14:30:00Z","modifiedDT":"2023-01-20T16:45:00Z","isRequired":true},"required":["deadline","id","isActive","parentEntityId","priority","status","taskName","taskType"]},"TaskTypeInformation":{"type":"object","properties":{"name":{"description":"The name of the task type.","type":"string","example":"DOCUMENT_REVIEW","maxLength":100,"minLength":1},"nameKey":{"description":"The name key of the task type used for translation purposes.","type":"string","example":"TaskRegistry.TaskType.DocumentReview","maxLength":255,"minLength":1},"module":{"description":"The source product of the task type.","type":"string","example":"ASSESSMENT","maxLength":100,"minLength":1},"moduleNameTranslationKey":{"description":"The name key of the product used for translation purposes.","type":"string","example":"TaskRegistry.Module.Assessment","maxLength":255,"minLength":1},"id":{"description":"The unique identifier of the task type.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"label":{"description":"The display label of the task type.","type":"string","example":"Document Review","maxLength":255,"minLength":1},"icon":{"description":"The icon of the task type.","type":"string","example":"document-check","maxLength":50,"minLength":1}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"DOCUMENT_REVIEW","nameKey":"TaskRegistry.TaskType.DocumentReview","module":"ASSESSMENT","moduleNameTranslationKey":"TaskRegistry.Module.Assessment","label":"Document Review","icon":"document-check"},"required":["id","label","module","moduleNameTranslationKey","name","nameKey"]},"UserInfo":{"type":"object","properties":{"name":{"description":"The name of the user or user group.","type":"string","example":"John Doe"},"nameWithAttributes":{"description":"The name of the user or user group with additional attributes.","type":"string","example":"John Doe (Admin, Department: IT)"}},"example":{"name":"John Doe","nameWithAttributes":"John Doe (Admin, Department: IT)"},"required":["name"]},"AssociatedAttributeInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the attribute.","type":"string","format":"uuid"},"name":{"description":"The name of the attribute.","type":"string","example":"Count of members"},"nameKey":{"description":"The name key of the attribute used for translation purposes.","type":"string","example":"IM.CountOfMembersName"},"description":{"description":"The description of the attribute.","type":"string","example":"Provide details about count associated with this attribute"},"descriptionKey":{"description":"The description key of the attribute used for translation purposes.","type":"string","example":"IM.CountOfMembersDesc"},"schemaId":{"description":"The unique identifier of the attribute schema.","type":"string","format":"uuid"},"schemaName":{"description":"The name of the attribute schema.","type":"string","example":"risk"},"fieldName":{"description":"The fieldName parameter value of the attribute.","type":"string","example":"countOfMembers"},"mappedFieldName":{"description":"The mapped attribute field name.","type":"string","example":"count"},"enabled":{"description":"This flag indicates if the attribute is enabled.","type":"boolean"},"responseType":{"description":"The type of response associated with the attribute.","type":"string","enum":["Text","SingleSelect","MultiSelect","Date","DateTime","NumericalText","NumericalSingleSelect","RadioButton","TextArea","Formula","Level","Range","Score","System"]},"responseSubType":{"description":"The type of scoring method associated with the attribute.","type":"string","enum":["Standard","Formula","Matrix","RollUp"]},"formula":{"description":"The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.","type":"string","example":"sum(1, 3)"},"options":{"description":"The options for the attribute.","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionInformation"}}},"required":["enabled","fieldName","id","name","responseType"]},"AttributeInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the attribute.","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"description":"The name of the attribute.","type":"string","example":"Type of the Record","maxLength":255,"minLength":1},"nameKey":{"description":"The name key of the attribute used for translation purposes.","type":"string","example":"IM.Name","maxLength":255},"description":{"description":"The description of the attribute.","type":"string","example":"Gather Type for the record - provide some value related to nature of record","maxLength":1000},"descriptionKey":{"description":"The description key of the attribute used for translation purposes.","type":"string","example":"IM.Name.Description","maxLength":255},"fieldName":{"description":"The fieldName parameter value of the attribute.","type":"string","example":"nameOfRecord","maxLength":100,"minLength":1},"mappedFieldName":{"description":"The mapped attribute field name.","type":"string","example":"name","maxLength":100},"enabled":{"description":"This flag indicates whether the attribute is enabled.","type":"boolean","example":true,"default":"true"},"required":{"description":"This flag indicates whether the attribute is required.","type":"boolean","example":false,"default":"false"},"readOnly":{"description":"This flag indicates whether the attribute is read-only.","type":"boolean","example":false,"default":"false"},"encrypted":{"description":"This flag indicates whether the attribute is encrypted.","type":"boolean","example":false,"default":"false"},"allowOther":{"description":"This flag indicates whether Other can be selected as an option for the attribute value.","type":"boolean","example":false,"default":"false"},"baseAttribute":{"description":"This flag indicates whether the attribute is a system attribute.","type":"boolean","example":false,"default":"false"},"responseType":{"description":"The type of response associated with the attribute value.","type":"string","example":"Text","enum":["Text","SingleSelect","MultiSelect","Date","Formula","Score","Level","Range"]},"formula":{"description":"The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.","type":"string","example":"Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)","maxLength":4000},"optionType":{"description":"The type of system list used to source the attribute options.","type":"string","example":"None","enum":["None","Static","Dynamic"]},"optionAllowed":{"description":"This flag indicates whether options were configured for the attribute.","type":"boolean","example":false,"default":"false"},"schemaId":{"description":"The unique identifier of the attribute schema.","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"schemaName":{"description":"The name of the attribute schema.","type":"string","example":"vendors","maxLength":100},"options":{"description":"The options for the attribute.","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionInformation"}},"referenceCategories":{"description":"The category details of the attribute.","type":"array","items":{"$ref":"#/components/schemas/CategoryInformation"}},"responseMaxLength":{"description":"The maximum number of characters that can be entered for the attribute value.","type":"integer","format":"int32","example":4000,"default":"4000","maximum":4000,"minimum":1},"responseSubType":{"description":"The type of scoring method associated with the attribute value.","type":"string","example":"STANDARD","enum":["STANDARD","FORMULA","MATRIX"]},"associatedAttributeInformation":{"description":"The details of the associated attributes.","type":"array","items":{"$ref":"#/components/schemas/AssociatedAttributeInformation"}},"multiSelectMaxOptionValues":{"description":"The maximum number of options that can be selected for the attribute.","type":"integer","format":"int32","example":10,"maximum":100,"minimum":1},"hidden":{"description":"This flag indicates whether the attribute is hidden.","type":"boolean","example":false,"default":"false"},"optionUrl":{"description":"The URL of the attribute option.","type":"string","example":"/api/risk-v2/risk-categories","maxLength":255},"intakeQuestion":{"description":"The details of the attribute intake question.","$ref":"#/components/schemas/IntakeQuestion"},"deleteMarker":{"description":"The deletion status of the attribute.","type":"string","example":"MARKED_FOR_DELETE","enum":["MARKED_FOR_DELETE","DELETING","DELETED"]},"optionMetadata":{"description":"The additional metadata details of the attribute option.","$ref":"#/components/schemas/AttributeOptionMetadataInformation"},"validationRuleId":{"description":"The validation rule configured for the attribute.","type":"string","example":"email"},"associatedAttributeFieldName":{"description":"The fieldName parameter value of the attribute.","type":"string"}},"required":["enabled","fieldName","name"]},"AttributeOptionInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the attribute option.","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"option":{"description":"The name of the attribute option.","type":"string","example":"TypeA","maxLength":255,"minLength":1},"optionKey":{"description":"The name key of the attribute option used for translation purposes.","type":"string","example":"IM.TypeA","maxLength":255},"colorCode":{"description":"The color code associated with the attribute option.","type":"string","example":"#FF5733","maxLength":7},"sequence":{"description":"The sequential order in which the attribute option displays.","type":"integer","format":"int32","example":1,"maximum":32767,"minimum":1},"enabled":{"description":"This flag indicates whether the attribute option is enabled.","type":"boolean","example":true,"default":"true"},"metadata":{"description":"The metadata details of the attribute option.","$ref":"#/components/schemas/AttributeOptionMetadata"}},"required":["option"]},"AttributeOptionMetadata":{"type":"object","properties":{"hint":{"description":"The hint of the attribute option.","type":"string"},"hintKey":{"description":"The hint key of the attribute option used for translation purposes.","type":"string"}}},"AttributeOptionMetadataInformation":{"type":"object","properties":{"entityTypeName":{"description":"The type of system list used to source the attribute option.","type":"string","example":"Location"},"basicServiceContextPath":{"description":"The base path of the API URL used to source the attribute option.","type":"string","example":"/api/location"},"optionUrl":{"description":"The API URL path used to source the attribute option.","type":"string","example":"/api/location/ui/v1/entity-types/names/Location/entities/basic-details"},"viewType":{"description":"The display format of the attribute option.","type":"string"}}},"CategoryInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the category.","type":"string","format":"uuid"},"name":{"description":"The name of the category.","type":"string","example":"Financial Category"},"nameKey":{"description":"The name key of the category used for translation purposes.","type":"string","example":"IM.FinancialCategoryName"}}},"IntakeQuestion":{"type":"object","properties":{"nameKey":{"description":"The name key of the attribute intake question used for translation purposes.","type":"string"},"name":{"description":"The name of the attribute intake question.","type":"string"},"descriptionKey":{"description":"The description key of the attribute intake question used for translation purposes.","type":"string"},"description":{"description":"The description of the attribute intake question.","type":"string"}}},"AttributeValueInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the attribute.","type":"string","format":"uuid","example":"a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"},"value":{"description":"The name of the attribute.","type":"string","example":"Text Value"},"valueKey":{"description":"The name key of the attribute used for translation purposes.","type":"string","example":"attribute.option.valueKey"},"colorCode":{"description":"The color code associated with the attribute.","type":"string","example":"red"},"optionSelectionValue":{"description":"The selection value of the attribute.","type":"string","example":3.5},"displayLabel":{"description":"The display label for the attribute.","type":"string","example":"United State | San Francisco"},"disabled":{"description":"This flag indicates whether the attribute is disabled.","type":"boolean","example":false,"default":"false"}},"required":["value"]},"EntityOrganizationInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the organization.","type":"string","example":"Business Unit"}},"required":["id"]},"EntityUpdateRequest":{"type":"object","properties":{"name":{"description":"The name of the object.","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"organization":{"description":"The details of the organization responsible for the object.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Business Unit"},"$ref":"#/components/schemas/EntityOrganizationInformation"},"attributes":{"description":"This parameter can be used to store attribute details in key value pairs.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}}},"example":{"name":"OneTrust Updated","attributes":{"textAttributeName":[{"value":"New Text Value"}]}},"title":"Entity Update Request"},"BasicEntityTypeInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the object type.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the object type.","type":"string","example":"Vendor"},"seeded":{"description":"This flag indicates whether the object type is seeded. ","type":"boolean","example":true},"moduleName":{"description":"The name of the product where the object type exists.","type":"string","example":"Vendor","enum":["Vendor","DataMapping","Risk","Assessments","CustomEntityManagement"]},"schemaName":{"description":"The name of the schema.","type":"string","example":"vendor","enum":["vendor","data-mapping","risk","assessments","customEntityManagement"]}},"example":"{\n \"id\": \"f2229953-b4b5-4042-8cb9-b78038cc4c46\",\n \"name\": \"Vendor\",\n \"nameKey\": \"EntityType.Vendor.Name\",\n \"seeded\": true,\n \"moduleName\": \"Vendor\",\n \"schemaName\": \"vendor\"\n},\n","required":["id","name"]},"EntityBasicUserInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the user who last modified the record.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the user who last modified the record.","type":"string","example":"First Last"},"email":{"description":"The email address of the user who last modified the record.","type":"string","example":"user@gmail.com"},"initials":{"description":"The initials of the user who last modified the record.","type":"string","example":"FL"}}},"EntityInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the object.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46","readOnly":true},"number":{"description":"The sequential order in which the object was created.","type":"integer","format":"int64","example":1,"maximum":9999999,"minimum":1,"readOnly":true},"name":{"description":"The name of the object.","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"orgGroupId":{"description":"The unique identifier of the organization responsible for the object.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc2c46"},"schemaId":{"description":"The unique identifier of the schema.","type":"string","format":"uuid","example":"c21319953-b4b5-4042-8cb9-b78038cc4c51","readOnly":true},"entityType":{"description":"The details of the object type.","example":{"id":"a2319953-b4b5-4042-8cb9-b78038cc4c46","name":"Asset"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"workflowAndStage":{"description":"The details of the workflow and stage.","example":{"id":"b271c01a-89a9-41b1-8185-0a3e2bfdad84","name":"Vendor On-Boarding Workflow","nameKey":"Workflow.VendorOnBoarding.Name","type":"Vendor","workflowMode":"BASIC","stageId":"9fc111cb-c379-4f08-8aff-5be954c1a6e6","stageName":"Start On-Boarding","stageNameKey":"Workflow.VendorOnBoarding.Stage.StartOnBoarding","badgeColor":"#4287f5"},"$ref":"#/components/schemas/EntityWorkflowInformation"},"attributes":{"description":"The details of the associated attributes.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"auditFields":{"description":"The activity details of when the record was created and last updated.","example":{"createdBy":"admin@example.com","createdTimestamp":"2023-01-15T10:30:45Z","lastModifiedBy":"system@example.com","lastModifiedTimestamp":"2025-03-22T14:15:22Z"},"$ref":"#/components/schemas/EntityRecordAuditInformation","readOnly":true}},"example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"OneTrust","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc2c46","name":"Vendor"}},"required":["entityType","id","name","number","schemaId"],"title":"Entity Information"},"EntityRecordAuditInformation":{"type":"object","properties":{"createdDate":{"description":"The date and time that the record was created.","type":"string","format":"date-time","example":"2021-05-13T13:06:49.853Z"},"lastUpdatedDate":{"description":"The date and time that the record was last updated.","type":"string","format":"date-time","example":"2021-05-13T13:06:49.853Z"},"createdBy":{"description":"The creation details of the record.","example":{"id":"c21319953-b4b5-4042-8cb9-b78038cc4c51","name":"Name"},"$ref":"#/components/schemas/EntityBasicUserInformation"},"lastModifiedBy":{"description":"The last modified details of the record.","example":{"id":"c21319953-b4b5-4042-8cb9-b78038cc4c51","name":"Name"},"$ref":"#/components/schemas/EntityBasicUserInformation"}},"required":["createdDate"]},"EntityWorkflowInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the workflow.","type":"string","format":"uuid","example":"b271c01a-89a9-41b1-8185-0a3e2bfdad84"},"name":{"description":"The name of the workflow.","type":"string","example":"Vendor On-Boarding Workflow"},"type":{"description":"The type of workflow.","type":"string","example":"Vendor"},"workflowMode":{"description":"The mode in which the workflow was created.","type":"string","example":"BASIC","enum":["ADVANCED, BASIC"]},"stageId":{"description":"The unique identifier of the workflow stage.","type":"string","format":"uuid","example":"9fc111cb-c379-4f08-8aff-5be954c1a6e6"},"stageName":{"description":"The name of the workflow stage.","type":"string","example":"Start On-Boarding"}},"example":{"id":"b271c01a-89a9-41b1-8185-0a3e2bfdad84","name":"Vendor On-Boarding Workflow","nameKey":"Workflow.VendorOnBoarding.Name","type":"Vendor","workflowMode":"BASIC","stageId":"9fc111cb-c379-4f08-8aff-5be954c1a6e6","stageName":"Start On-Boarding","stageNameKey":"Workflow.VendorOnBoarding.Stage.StartOnBoarding","badgeColor":"#4287f5"},"required":["id","name","stageId","stageName","type"]},"TaskCreateRequest":{"type":"object","properties":{"parentEntityId":{"description":"The unique identifier of the parent record where the task was created.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskName":{"description":"The name of the task.","type":"string","example":"Review document","maxLength":512,"minLength":1},"description":{"description":"The description of the task.","type":"string","example":"Please review the attached document and provide feedback","maxLength":2000},"orgGroupId":{"description":"The unique identifier of the organization responsible for the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskTypeNameKey":{"description":"The name key of the task type used for translation purposes.","type":"string","example":"REVIEW_TASK","maxLength":100,"minLength":1},"assigneeId":{"description":"The unique identifier of the user assigned as an assignee on the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assigneeEmail":{"description":"The email address of the user assigned as an assignee on the task.","type":"string","example":"user@example.com","maxLength":255,"minLength":5},"collaborators":{"description":"The details of the collaborators assigned to the task.","type":"array","items":{"$ref":"#/components/schemas/TaskCollaboratorDto"}},"deadline":{"description":"The date and time by which the task should be completed.","type":"string","format":"date-time","example":"2023-12-31T23:59:59"},"context":{"description":"The contextual details of the task.","$ref":"#/components/schemas/TaskContextInformation"},"isActive":{"description":"This flag indicates whether the task is active.","type":"boolean","example":true,"default":"false"},"sourceType":{"description":"The type of source that created the task.","type":"string","example":"RULES","maxLength":16},"sourceId":{"description":"The unique identifier of the source that created the task.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"resourceId":{"description":"The unique identifier of the parent record where the task was created.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"resourceTypeNameKey":{"description":"The key used to identify the type of resource.","type":"string","example":"ASSESSMENT","maxLength":100,"minLength":1},"moduleSource":{"description":"The source product of the task.","type":"string","enum":["assessment","audit-mgmt","cyber-risk","data-mapping","data-governance","esg","erm","incident","issue","itrm","program-benchmarking","maturity-planning","risk","vendor","vendor-portal","compliance-automation","SpeakUp","EntityScoping","ControlObjective","exception"]},"priority":{"description":"The priority level of the task.","type":"string","example":"MEDIUM","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"isRequired":{"description":"This flag indicates whether the task is required.","type":"boolean","example":false,"default":"false"}},"example":{"parentEntityId":"123e4567-e89b-12d3-a456-426614174000","taskName":"Review document","description":"Please review the attached document and provide feedback","orgGroupId":"123e4567-e89b-12d3-a456-426614174000","taskTypeNameKey":"REVIEW_TASK","assigneeId":"123e4567-e89b-12d3-a456-426614174000","deadline":"2023-12-31T23:59:59","priority":"MEDIUM"},"required":["orgGroupId","parentEntityId","taskName","taskTypeNameKey"]},"AssociatedAttribute":{"type":"object","properties":{"fieldName":{"description":"The fieldName parameter value of the attribute.","type":"string"},"name":{"description":"The name of the attribute.","type":"string"},"nameKey":{"description":"The name key of the attribute used for translation purposes.","type":"string"},"description":{"description":"The description of the attribute.","type":"string"},"descriptionKey":{"description":"The description key of the attribute used for translation purposes.","type":"string"},"options":{"description":"The options for the attribute.","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionRequest"}}},"required":["name","options"]},"AssociatedAttributeRequest":{"type":"object","properties":{"associatedAttributes":{"description":"The details of the associated attributes.","type":"array","items":{"$ref":"#/components/schemas/AssociatedAttribute"}}},"required":["associatedAttributes"]},"AttributeContext":{"type":"object","properties":{"parameters":{"description":"This parameter can be used to store attribute details in key value pairs.","additionalProperties":{"type":"object"},"type":"object"}}},"AttributeCreateRequest":{"type":"object","properties":{"fieldName":{"description":"The fieldName parameter value of the attribute.","type":"string","example":"nameOfRecord","maxLength":100},"name":{"description":"The name of the attribute.","type":"string","example":"Type of the Record","maxLength":255,"minLength":1},"nameKey":{"description":"The name key of the attribute used for translation purposes.","type":"string","example":"IM.Name","maxLength":255},"description":{"description":"The description of the attribute.","type":"string","example":"Gather Type for the record - provide some value related to nature of record","maxLength":1000},"descriptionKey":{"description":"The description key of the attribute used for translation purposes.","type":"string","example":"IM.Name.Description","maxLength":255},"required":{"description":"This flag indicates whether the attribute is required.","type":"boolean","example":false,"default":"false"},"allowOther":{"description":"This flag indicates whether Other can be selected as an option for the attribute value.","type":"boolean","example":false,"default":"false"},"responseType":{"description":"The type of response associated with the attribute value.","type":"string","example":"Text","enum":["Text","SingleSelect","MultiSelect","Date","Formula","Score","Level","Range"]},"optionType":{"description":"The type of system list used to source the attribute options.","type":"string","example":"None","default":"None","enum":["None","Static","Dynamic"],"maxLength":50},"options":{"description":"The options for the attribute.","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionRequest"}},"referenceCategoryIds":{"description":"The list of category identifiers of the attribute.","type":"array","items":{"type":"string","format":"uuid"},"example":["550e8400-e29b-41d4-a716-446655440000"]},"formula":{"description":"The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.","type":"string","example":"Default:Field4 + Default:Field3 + 100","maxLength":4000},"context":{"description":"The contextual details of the attribute.","$ref":"#/components/schemas/AttributeContext"},"source":{"description":"The source of the attribute.","type":"string","example":"system","maxLength":50},"responseSubType":{"description":"The type of scoring method associated with the attribute value.","type":"string","example":"STANDARD","enum":["STANDARD","FORMULA","MATRIX"]},"associatedAttributeRequest":{"description":"The attributes to add to the schema.","$ref":"#/components/schemas/AssociatedAttributeRequest"},"maxMultiSelectAllowedOptionValues":{"description":"The maximum number of options that can be selected for the attribute.","type":"integer","format":"int32","example":10,"maximum":100,"minimum":1},"encrypted":{"description":"This flag indicates whether the attribute is encrypted.","type":"boolean","example":false,"default":"false"},"metadata":{"description":"The metadata details of the attribute option.","type":"string","example":{"sortable":true,"filterOperators":["EQUAL_TO","NOT_EQUAL_TO"]}},"intakeQuestion":{"description":"The details of the attribute intake question.","$ref":"#/components/schemas/IntakeQuestion"},"validationRuleId":{"description":"The validation rule configured for the attribute.","type":"string","example":"email","maxLength":255}},"required":["fieldName","name","responseType"]},"AttributeOptionRequest":{"type":"object","properties":{"option":{"description":"The name of the attribute option.","type":"string","example":"Example Option","maxLength":255,"minLength":1},"optionKey":{"description":"The name key of the attribute option used for translation purposes.","type":"string","example":"example_option","maxLength":255},"optionSelectionValue":{"description":"The selection value of an option for the attribute.","type":"string","example":"value1","maxLength":255},"colorCode":{"description":"The color code associated with the attribute option.","type":"string","example":"#FFFFFF","enum":["#000000","#FFFFFF","#FF0000","#00FF00","#0000FF"],"maxLength":7,"minLength":4,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"metadata":{"description":"The metadata details of the attribute option.","example":{"hint":"This option provides additional information about the attribute","hintKey":"attribute.option.hint.key"},"$ref":"#/components/schemas/AttributeOptionMetadata"}},"example":{"option":"Example Option","optionKey":"example_option","optionSelectionValue":"value1","colorCode":"#FFFFFF"},"required":["option"],"title":"Attribute Option Request"},"EntityDetailRequest":{"type":"object","properties":{"extendedBaseAttributes":{"description":"The details of the attribute.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}}}},"LinkRequest":{"type":"object","properties":{"attributes":{"description":"This parameter can be used to store attribute details in key value pairs.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"entity1":{"description":"The details of the source object in the relationship.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entity2":{"description":"The details of the target object in the relationship.","example":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"}},"required":["entity1","entity2"]},"LinkedEntityInformation":{"type":"object","properties":{"linkEntityDetail":{"description":"The details of linked objects.","example":{"includeCustomFields":true,"includeStandardFields":true},"$ref":"#/components/schemas/EntityDetailRequest"},"id":{"description":"The unique identifier of the object.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"number":{"description":"The sequential order in which the object was created.","type":"integer","format":"int64","example":1024,"maximum":9999999,"minimum":1,"readOnly":true},"name":{"description":"The name of the object.","type":"string","example":"OneTrust DataGuidance","maxLength":255,"minLength":1},"detailsAccessRestricted":{"description":"This flag indicates whether the object is view-only.","type":"boolean","example":false},"redirectURL":{"description":"The redirect URL for the object. ","type":"string","example":"/entity/product/f2229953-b4b5-4042-8cb9-b78038cc4c46"},"entityType":{"description":"The details of the object type.","example":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Product","displayName":"Product","nameKey":"entity.type.product","displayNameKey":"entity.type.product.display","module":"VENDOR"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"deleted":{"description":"This flag indicates whether the object is deleted.","type":"boolean"}},"example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","number":1024,"name":"OneTrust DataGuidance","isDeleted":false,"detailsAccessRestricted":false,"redirectURL":"/entity/product/f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Product","displayName":"Product","nameKey":"entity.type.product","displayNameKey":"entity.type.product.display","module":"VENDOR"},"linkEntityDetail":{"includeCustomFields":true,"includeStandardFields":true}},"required":["entityType","id","number"],"title":"Linked Entity Information"},"BasicLinkTypeLabelInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the relationship type.","type":"integer","format":"int64","example":1},"entityType1ToEntityType2EntityLinkName":{"description":"The source object type's relationship to the target object type.","type":"string","example":"OneTrust provides GRC"},"entityType2ToEntityType1EntityLinkName":{"description":"The target object type's relationship to the source object type.","type":"string","example":"GRC belongs to OneTrust"}},"required":["id"]},"IdOrNameLinkType":{"type":"object","properties":{"id":{"description":"The unique identifier of the relationship type.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the relationship type.","type":"string","example":"Product/Service"},"idOrNamePresent":{"description":"This flag indicates whether the ID or name of the relationship type is present.","type":"boolean"}}},"LinkInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the relationship record.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46","readOnly":true},"linkType":{"description":"The details of the relationship type.","example":{"name":"Related"},"$ref":"#/components/schemas/IdOrNameLinkType"},"linkTypeLabel":{"description":"The display label for the relationship type.","example":{"entityType1ToEntityType2EntityLinkName":"Send Data To","entityType2ToEntityType1EntityLinkName":"Receive Data From"},"$ref":"#/components/schemas/BasicLinkTypeLabelInformation"},"entity1":{"description":"The details of the source object in the relationship.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entity2":{"description":"The details of the target object in the relationship.","example":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"schemaId":{"description":"The unique identifier of the schema.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46","readOnly":true},"auditFields":{"description":"The activity details of when the record was created and last updated.","example":{"createdBy":"admin@example.com","createdTimestamp":"2023-01-15T10:30:45Z","lastModifiedBy":"system@example.com","lastModifiedTimestamp":"2025-03-22T14:15:22Z"},"$ref":"#/components/schemas/EntityRecordAuditInformation","readOnly":true}},"example":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","linkType":{"name":"Related"}},"required":["entity1","entity2","id","linkType"],"title":"Link Information"},"AttributePredicate":{"type":"object","properties":{"field":{"description":"The field by which to filter results.","type":"string"},"operator":{"description":"The relationship that must be met between the field and the value.","type":"string","enum":["EQUAL_TO","NOT_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","LESS_THAN","LESS_THAN_EQUAL_TO","BETWEEN"]},"value":{"description":"The value by which to filter results.","type":"object","oneOf":[{"type":"string","format":"uuid"},{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"type":"string"},{"type":"number"}]},"toValue":{"description":"The end value by which to filter results.","type":"object","oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"type":"string"},{"type":"number"}]}},"required":["field"]},"AttributeQueryCriteria":{"type":"object","properties":{"filters":{"description":"The criteria used to filter results.","type":"array","items":{"$ref":"#/components/schemas/AttributePredicate"},"uniqueItems":true},"fullText":{"description":"The key terms for the search criteria.","type":"string"}}},"EntityTypeInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the object type.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the object type.","type":"string","example":"Vendor"},"seeded":{"description":"This flag indicates whether the object type is seeded.","type":"boolean","example":true},"moduleName":{"description":"The name of the product where the object type exists.","type":"string","example":"Vendor","enum":["Vendor","DataMapping","Risk","Assessments","CustomEntityManagement"]},"schemaName":{"description":"The name of the schema.","type":"string","example":"vendor","enum":["vendor","data-mapping","risk","assessments","customEntityManagement"]},"description":{"description":"The description of the object type.","type":"string","example":"A third-party organization that provides goods or services to the company"},"descriptionKey":{"description":"The description key of the object type used for translation purposes.","type":"string","example":"entity.type.vendor.description"},"workflowType":{"description":"The type of workflow.","type":"string","example":"vendor_assessment"},"enabled":{"description":"This flag indicates whether the object type is enabled. ","type":"boolean","example":true,"default":"true"},"moduleScopes":{"description":"The product scopes of the object type.","type":"array","items":{"type":"string"},"example":["Inventory","VRM","Assessments","IssueManagement"],"enum":["Inventory","VRM","Assessments","IssueManagement","CustomEntityManagement","Control"]},"settings":{"description":"The settings details of the object type.","example":{"enableSearch":true,"enableQuickCreate":true,"enableExtendedAttributes":true,"enableDuplicateDetection":true,"workflowEnabled":true,"auditEnabled":true},"$ref":"#/components/schemas/EntityTypeSettingInformation"},"auditFields":{"description":"The activity details of when the record was created and last updated.","example":{"createdBy":"admin@example.com","createdTimestamp":"2023-01-15T10:30:45Z","lastModifiedBy":"system@example.com","lastModifiedTimestamp":"2025-03-22T14:15:22Z"},"$ref":"#/components/schemas/EntityRecordAuditInformation"}},"example":{"id":"789e4567-e89b-12d3-a456-426614174123","name":"Vendor","nameKey":"entity.type.vendor","displayName":"Vendor","displayNameKey":"entity.type.vendor.display","module":"VENDOR","description":"A third-party organization that provides goods or services to the company","descriptionKey":"entity.type.vendor.description","workflowType":"vendor_assessment","enabled":true,"moduleScopes":["Inventory","VRM","Security"],"settings":{"enableSearch":true,"enableQuickCreate":true,"enableExtendedAttributes":true,"enableDuplicateDetection":true,"workflowEnabled":true,"auditEnabled":true},"auditFields":{"createdBy":"admin@example.com","createdTimestamp":"2023-01-15T10:30:45Z","lastModifiedBy":"system@example.com","lastModifiedTimestamp":"2025-03-22T14:15:22Z"}},"required":["id","name","settings"]},"EntityTypeSettingInformation":{"type":"object","properties":{"enableWorkflow":{"description":"This flag indicates whether the workflow is enabled.","type":"boolean","example":true},"enableWorkflowStageTracking":{"description":"This flag indicates whether workflow stage tracking is enabled.","type":"boolean","example":true},"assessable":{"description":"This flag indicates whether the object type is assessable.","type":"boolean","example":false},"enableTask":{"description":"This flag indicates whether tasks are enabled.","type":"boolean","example":false},"enableRisk":{"description":"This flag indicates whether risks are enabled.","type":"boolean","example":false},"enableDocument":{"description":"This flag indicates whether documents are enabled.","type":"boolean","example":false},"enableControl":{"description":"This flag indicates whether controls are enabled.","type":"boolean","example":false},"enableWebForm":{"description":"This flag indicates whether web forms are enabled.","type":"boolean","example":false},"enableComment":{"description":"This flag indicates whether comments are enabled.","type":"boolean","example":false}},"required":["assessable","enableComment","enableControl","enableDocument","enableRisk","enableTask","enableWebForm","enableWorkflow","enableWorkflowStageTracking"]},"PageEntityTypeInformation":{"type":"object","properties":{"content":{"description":"The data of the returned objects.","example":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Customer","nameKey":"EntityType.Customer"}],"items":{"$ref":"#/components/schemas/EntityTypeInformation"},"type":"array"},"totalElements":{"description":"The total number of results in the list.","type":"integer","format":"int64","example":75,"minimum":0},"totalPages":{"description":"The total number of pages in the list.","type":"integer","format":"int32","example":8,"minimum":0},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":0,"minimum":0},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":10,"maximum":1000,"minimum":20},"first":{"description":"This flag indicates whether the current page is the first page of the list.","type":"boolean","example":true},"last":{"description":"This flag indicates whether the current page is the last page of the list.","type":"boolean","example":false},"empty":{"description":"The flag indicates whether no results exist on the page.","type":"boolean","example":false},"numberOfElements":{"description":"The number of results on the current page.","type":"integer","format":"int32","example":10,"minimum":0},"hasNext":{"description":"This flag indicates whether there is a next page in the list.","type":"boolean","example":true},"hasPrevious":{"description":"This flag indicates whether there is a previous page in the list.","type":"boolean","example":false},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/Sort"},"pageable":{"description":"The configuration parameters of the page.","$ref":"#/components/schemas/Pageable"}},"example":{"content":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Customer","nameKey":"EntityType.Customer","description":"Customer entity type","seeded":true,"moduleName":"EntityManagement","schemaName":"customer"}],"totalElements":75,"totalPages":8,"number":0,"size":10,"first":true,"last":false,"empty":false,"numberOfElements":10},"required":["content","empty","first","hasNext","hasPrevious","last","number","numberOfElements","size","totalElements","totalPages"]},"Pageable":{"type":"object","properties":{"pageNumber":{"description":"The page number of the results.","type":"integer","format":"int32","example":0},"pageSize":{"description":"The number of results per page.","type":"integer","format":"int32","example":10},"offset":{"description":"The number of results to exclude from the start of the list.","type":"integer","format":"int64","example":0},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/Sort"},"paged":{"description":"This flag indicates whether the list is paged.","type":"boolean","example":true},"unpaged":{"description":"This flag indicates whether the list is not paged.","type":"boolean","example":false}}},"Sort":{"type":"object","properties":{"sorted":{"description":"This flag indicates whether the results were sorted.","type":"boolean","example":true},"unsorted":{"description":"This flag indicates whether the results were unsorted.","type":"boolean","example":false},"empty":{"description":"This flag indicates whether sort criteria was left undefined.","type":"boolean","example":false}}},"CustomLinkTypeCreateRequest":{"type":"object","properties":{"name":{"description":"The name of the relationship type.","type":"string","example":"Product/Service"},"description":{"description":"The description of the relationship type.","type":"string","example":"Defined link between Vendor and Product/Service"},"linkAssociations":{"description":"The details of linked relationships.","type":"array","items":{"$ref":"#/components/schemas/LinkTypeAssociationRequest"},"example":[{"entityType1":{"name":"Vendors"},"entityType2":{"name":"Assets"}},{"entityType1":{"name":"Vendors"},"entityType2":{"name":"Vendors"}}],"uniqueItems":true},"entityType1ToEntityType2EntityLinkName":{"description":"The name of the source object type's relationship to the target object type.","type":"string","example":"OneTrust provides GRC"},"entityType2ToEntityType1EntityLinkName":{"description":"The name of the target object type's relationship to the source object type.","type":"string","example":"GRC belongs to OneTrust"}},"required":["linkAssociations","name"]},"LinkTypeAssociationRequest":{"type":"object","properties":{"entityType1":{"description":"The details of the source object type in the relationship.","example":{"name":"Vendors"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"entityType2":{"description":"The details of the target object type in the relationship.","example":{"name":"Vendors"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"entityTypePairKey":{"description":"The pair key of the linked object types.","type":"string"}},"required":["entityType1","entityType2"]},"LinkTypeAssociationInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the relationship type.","type":"integer","format":"int64","example":999},"entityType1":{"description":"The details of the source object type in the relationship.","example":{"name":"Vendors"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"entityType2":{"description":"The details of the target object type in the relationship.","example":{"name":"Vendors"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"enabled":{"description":"This flag indicates whether relationship links are enabled.","type":"boolean","example":true},"seeded":{"description":"This flag indicates whether the relationship type is seeded.","type":"boolean","example":true},"auditFields":{"description":"The activity details of when the record was created and last updated.","example":{"createdDate":"2021-11-20T13:06:49.853803","lastUpdatedDate":"2021-12-01T13:06:49.853803"},"$ref":"#/components/schemas/EntityRecordAuditInformation"}},"required":["enabled","entityType1","entityType2","id","seeded"]},"LinkTypeDetailedInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the relationship type.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the relationship type. ","type":"string","example":"Product/Service","maxLength":255,"minLength":1},"nameKey":{"description":"The name key of the relationship type used for translation purposes.","type":"string","example":"link.type.productservice.name"},"seeded":{"description":"This flag indicates whether the relationship type is seeded.","type":"boolean","example":true,"default":"false"},"moduleName":{"description":"The name of the product where the relationship type exists.","type":"string","example":"CustomEntityManagement"},"description":{"description":"The description of the relationship type.","type":"string","example":"Links between vendors and their products"},"descriptionKey":{"description":"The description key of the relationship type used for translation purposes.","type":"string","example":"entity.link.vendor_product.description"},"entityType1ToEntityType2EntityLinkName":{"description":"The name of the source object type's relationship to the target object type.","type":"string","example":"Vendor provides Product"},"entityType1ToEntityType2EntityLinkNameKey":{"description":"The name key of the source object type's relationship to the target object type used for translation purposes.","type":"string","example":"entity.link.vendor_to_product"},"entityType2ToEntityType1EntityLinkName":{"description":"The name of the target object type's relationship to the source object type.","type":"string","example":"Product belongs to Vendor"},"entityType2ToEntityType1EntityLinkNameKey":{"description":"The name key of the target object types's relationship to the source object type.","type":"string","example":"entity.link.product_to_vendor"},"enableAudit":{"description":"This flag indicates whether audit activity is enabled.","type":"boolean","example":true,"default":"false"},"allowNewCustomLinkAssociation":{"description":"This flag indicates whether new relationship links are allowed.","type":"boolean","example":false,"default":"true"},"auditFields":{"description":"The activity details of when the record was created and last updated.","$ref":"#/components/schemas/EntityRecordAuditInformation"},"linkAssociations":{"description":"The details of linked relationships.","type":"array","items":{"$ref":"#/components/schemas/LinkTypeAssociationInformation"},"example":"[{\"moduleName\": \"Inventory\" ,\"entityTypePair\": {\"entityType1\": {\"name\": \"Vendors\"}, \"entityType2\": {\"name\": \"Assets\"}}, {\"entityType1\": {\"name\": \"Vendors\"}, \"entityType2\": {\"name\": \"Vendors\"}}}]"}},"required":["id","linkAssociations","name"]},"PageLinkTypeDetailedInformation":{"type":"object","properties":{"content":{"description":"The data of the returned objects.","example":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Data Transfer Link"}],"items":{"$ref":"#/components/schemas/LinkTypeDetailedInformation"},"type":"array"},"totalElements":{"description":"The total number of results in the list.","type":"integer","format":"int64","example":150,"minimum":0},"totalPages":{"description":"The total number of pages in the list.","type":"integer","format":"int32","example":15,"minimum":0},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":0,"minimum":0},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":10,"maximum":1000,"minimum":20},"first":{"description":"This flag indicates whether the current page is the first page of the list.","type":"boolean","example":true},"last":{"description":"This flag indicates whether the current page is the last page of the list.","type":"boolean","example":false},"empty":{"description":"The flag indicates whether no results exist on the page.","type":"boolean","example":false},"numberOfElements":{"description":"The number of results on the current page.","type":"integer","format":"int32","example":10,"minimum":0},"hasNext":{"description":"This flag indicates whether there is a next page in the list.","type":"boolean","example":true},"hasPrevious":{"description":"This flag indicates whether there is a previous page in the list.","type":"boolean","example":false},"sort":{"description":"The sort criteria that dictates the order of the results.","example":{"sorted":true,"unsorted":false,"empty":false},"$ref":"#/components/schemas/Sort"},"pageable":{"description":"The configuration parameters of the page.","$ref":"#/components/schemas/Pageable"}},"example":{"content":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Data Transfer Link","description":"Link type for data transfer relationships"}],"totalElements":150,"totalPages":15,"number":0,"size":10,"first":true,"last":false,"empty":false,"numberOfElements":10},"required":["content","empty","first","hasNext","hasPrevious","last","number","numberOfElements","size","totalElements","totalPages"]},"EntityQueryRequest":{"type":"object","properties":{"criteria":{"description":"The details of the filter criteria.","example":{"filters":[{"fieldName":"name","operator":"contains","value":"OneTrust"}],"searchQuery":"privacy","sort":[{"fieldName":"lastModifiedTimestamp","direction":"DESC"}]},"$ref":"#/components/schemas/AttributeQueryCriteria"},"organizationTraversalStrategy":{"description":"The strategy used to return objects within the organizational hierarchy.","type":"string","example":"ancestors_and_descendants","enum":["ancestors_and_descendants","descendants","all"]},"requestedOrganizationId":{"description":"The unique identifier of the organization for the request.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"queryAction":{"description":"The action specifying the source of the API request.","type":"string","example":"ListEntity"}},"example":{"criteria":{"filters":[{"fieldName":"name","operator":"contains","value":"OneTrust"},{"fieldName":"entityStatus","operator":"equals","value":"Active"},{"fieldName":"lastModifiedTimestamp","operator":"greaterThan","value":"2024-01-01T00:00:00Z"}],"searchQuery":"privacy","sort":[{"fieldName":"lastModifiedTimestamp","direction":"DESC"}]},"organizationTraversalStrategy":"ancestors_and_descendants","requestedOrganizationId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","queryAction":"ListEntity"}},"Page":{"type":"object","properties":{"totalElements":{"description":"The total number of results in the list.","type":"integer","format":"int64"},"totalPages":{"description":"The total number of pages in the list.","type":"integer","format":"int32"},"size":{"description":"The number of results per page.","type":"integer","format":"int32"},"content":{"description":"The data of the returned objects.","items":{"type":"object"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32"},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/SortObject"},"first":{"description":"This flag indicates whether the current page is the first page of the list.","type":"boolean"},"last":{"description":"This flag indicates whether the current page is the last page of the list.","type":"boolean"},"numberOfElements":{"description":"The number of results on the current page.","type":"integer","format":"int32"},"pageable":{"description":"The configuration parameters of the page.","$ref":"#/components/schemas/PageableObject"},"empty":{"description":"The flag indicates whether no results exist on the page.","type":"boolean"}}},"PageableObject":{"type":"object","properties":{"offset":{"description":"The number of results to exclude from the start of the list.","type":"integer","format":"int64"},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/SortObject"},"pageNumber":{"description":"The page number of the results.","type":"integer","format":"int32"},"pageSize":{"description":"The number of results per page.","type":"integer","format":"int32"},"paged":{"description":"This flag indicates whether the list is paged.","type":"boolean"},"unpaged":{"description":"This flag indicates whether the list is not paged.","type":"boolean"}}},"SortObject":{"type":"object","properties":{"empty":{"description":"This flag indicates whether sort criteria was left undefined.","type":"boolean"},"sorted":{"description":"This flag indicates whether the results were sorted.","type":"boolean"},"unsorted":{"description":"This flag indicates whether the results were unsorted.","type":"boolean"}}},"BasicAttributeInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the workflow.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"value":{"description":"The name of the workflow.","type":"string","example":"Galaxy"}}},"BasicLinkCreateSourceRequest":{"type":"object","properties":{"attributes":{"description":"The attributes of the relationship.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"entity1":{"description":"The details of the source object in the relationship.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entity2":{"description":"The details of the target object in the relationship.","example":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entityLinkTypeId":{"description":"The unique identifier of the relationship type.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46"},"sourceSystemGenerator":{"description":"The system the generated the relationship link.","type":"string","example":"LINK-SOURCE"},"linkTypeLabel":{"description":"The display name of the relationship type.","type":"string","example":"Sends Data To"}},"example":{"entity1":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"name":"Vendor"}},"entity2":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"name":"Asset"}},"entityLinkTypeId":"d1119953-b4b5-4042-8cb9-b78038cc4c46"},"required":["entity2"],"title":"Basic Link Create Source Request"},"EntityCreateRequest":{"type":"object","properties":{"name":{"description":"The name of the object.","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"organization":{"description":"The details of the organization responsible for the object.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Organization Name"},"$ref":"#/components/schemas/EntityOrganizationInformation"},"attributes":{"description":"This parameter can be used to store attribute details in key value pairs.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"workflowAndStage":{"description":"The details of the workflow and stage.","example":{"workflow":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","value":"Workflow Name"},"stage":{"id":"d2329953-b4b5-4042-8cb9-b78038cc4c46","value":"Stage Name"}},"$ref":"#/components/schemas/EntityWorkflowStageRequest"},"entityLinks":{"description":"The details of the linked objects.","type":"array","items":{"$ref":"#/components/schemas/BasicLinkCreateSourceRequest"},"example":[{"entity1":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","entityType":{"name":"Issue"}},"entityLinkTypeId":"a1fe9bea-1e27-4f33-bd1c-3420b894bbb0"}]}},"example":{"name":"OneTrust","organization":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"attributes":{"textAttributeName":[{"value":"Text"}]}},"required":["name"],"title":"Entity Create Request"},"EntityWorkflowStageRequest":{"type":"object","properties":{"workflow":{"description":"The details of the workflow.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","value":"Example Workflow"},"$ref":"#/components/schemas/BasicAttributeInformation"},"stage":{"description":"The details of the workflow stage.","example":{"id":"c86539953-b4b5-4042-8cb9-b78038ccfc46","value":"Example Stage"},"$ref":"#/components/schemas/BasicAttributeInformation"},"closedDate":{"description":"The date and time that the workflow stage closed.","type":"string","format":"date-time","example":"2017-02-03T10:37:30Z"}},"example":{"workflow":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","value":"Example Workflow"},"stage":{"id":"c86539953-b4b5-4042-8cb9-b78038ccfc46","value":"Example Stage"}},"title":"Entity Workflow Stage Request"},"ContextInformation":{"type":"object","properties":{"parameters":{"description":"This parameter can be used to store details in key value pairs.","additionalProperties":{"type":"object"},"type":"object"}}},"EntityFieldRequest":{"type":"object","properties":{"fields":{"description":"The name of the field.","type":"array","items":{"type":"string"},"example":["textAttributeField1","singleSelectAttributeField1"]},"mode":{"description":"The mode in which non-required fields would be selected.","type":"string","default":"select_all","enum":["select_all","ignore_all","specific"]},"includeSelectedFullTextSearchFields":{"description":"This flag indicates whether to include selected full text search fields.","type":"boolean","example":true},"overriddenSearchFields":{"description":"The overridden search fields.","type":"array","items":{"type":"string"},"example":["name"]}},"required":["mode"]},"EntityListRequest":{"type":"object","properties":{"context":{"description":"The contextual details of the object.","$ref":"#/components/schemas/ContextInformation"},"queryRequest":{"description":"The details of the filter, text, and organization search criteria.","$ref":"#/components/schemas/EntityQueryRequest"},"requestedFields":{"description":"The details of the non-required fields to include in the response.","$ref":"#/components/schemas/EntityFieldRequest"}},"example":{"queryRequest":{"criteria":{"filters":[{"fieldName":"name","operator":"contains","value":"OneTrust"},{"fieldName":"entityStatus","operator":"equals","value":"Active"}],"searchQuery":"gdpr","sort":[{"fieldName":"lastModifiedTimestamp","direction":"DESC"}]},"organizationTraversalStrategy":"ancestors_and_descendants","requestedOrganizationId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","queryAction":"ListEntity"},"requestedFields":{"includeStandardFields":true,"includeCustomFields":true,"includeAuditFields":false,"specificStandardFields":["name","entityNumber","createdBy"],"specificCustomFields":["vendor_tier","risk_score"]}}},"PageEntityInformation":{"type":"object","properties":{"content":{"description":"The data of the returned objects.","example":[{"entityType":"Customer","idType":"UUID","javaType":"com.example.Customer"}],"items":{"$ref":"#/components/schemas/EntityInformation"},"type":"array"},"totalElements":{"description":"The total number of results in the list.","type":"integer","format":"int64","example":100,"minimum":0},"totalPages":{"description":"The total number of pages in the list.","type":"integer","format":"int32","example":10,"minimum":0},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":0,"minimum":0},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":10,"maximum":1000,"minimum":20},"first":{"description":"This flag indicates whether the current page is the first page of the list.","type":"boolean","example":true},"last":{"description":"This flag indicates whether the current page is the last page of the list.","type":"boolean","example":false},"empty":{"description":"The flag indicates whether no results exist on the page.","type":"boolean","example":false},"numberOfElements":{"description":"The number of results on the current page.","type":"integer","format":"int32","example":10,"minimum":0},"hasNext":{"description":"This flag indicates whether there is a next page in the list.","type":"boolean","example":true},"hasPrevious":{"description":"This flag indicates whether there is a previous page in the list.","type":"boolean","example":false},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/Sort"}},"example":{"content":[{"entityType":"Customer","idType":"UUID","javaType":"com.example.Customer"}],"totalElements":100,"totalPages":10,"number":0,"size":10,"first":true,"last":false,"empty":false,"numberOfElements":10},"required":["content","empty","first","hasNext","hasPrevious","last","number","numberOfElements","size","totalElements","totalPages"]},"ModelCreateRequest":{"type":"object","properties":{"name":{"description":"The name of the object.","type":"string","example":"Customer Sentiment Analysis Model","maxLength":255,"minLength":3,"title":"Model Name"},"description":{"description":"The description of the object.","type":"string","example":"Deep learning model for analyzing customer feedback sentiment","maxLength":1000,"title":"Model Description"},"modelVersion":{"description":"The version of the model.","type":"string","example":"2.3.1","pattern":"^\\d+\\.\\d+\\.\\d+$","title":"Model Version"},"limitations":{"description":"The limitations of the model.","type":"string","example":"Limited accuracy for non-English languages and specialized industry terminology","maxLength":2000,"title":"Model Limitations"},"biases":{"description":"The known biases of the model.","type":"string","example":"May have cultural bias based on training data predominantly from North American customers","maxLength":2000,"title":"Model Biases"},"demographicParityDifference":{"description":"The demographic parity difference measurement.","type":"string","format":"decimal","example":0.05,"title":"Demographic Parity Difference"},"demographicParityRatio":{"description":"The demographic parity ratio measurement.","type":"string","format":"decimal","example":0.92,"title":"Demographic Parity Ratio"},"equalizedOddsDifference":{"description":"The equalized odds difference measurement.","type":"string","format":"decimal","example":0.07,"title":"Equalized Odds Difference"},"equalizedOddsRatio":{"description":"The equalized odds ratio measurement.","type":"string","format":"decimal","example":0.89,"title":"Equalized Odds Ratio"},"referenceLink":{"description":"The reference link or other URL.","type":"string","format":"uri","example":"https://example.com/model-docs/sentiment-analysis","maxLength":2048,"title":"Reference Link"},"hubReferenceId":{"description":"The hub reference identifier to cross-reference model repositories.","type":"string","example":"SA-MODEL-2025-001","maxLength":100,"title":"Hub Reference ID"},"modelSource":{"description":"The source of the model.","type":"string","example":"Internal Development","default":"Internal Development","enum":["Internal Development","Vendor","Open Source","Third Party"],"title":"Model Source"},"additionalAttributes":{"description":"This parameter can be used to store attribute details in key value pairs.","type":"object","example":{"algorithm":[{"stringValue":"BERT"}],"accuracy":[{"doubleValue":0.95}],"f1Score":[{"doubleValue":0.93}]},"additionalProperties":true,"title":"Additional Attributes"},"entityDetail":{"description":"The details of the object.","example":{"extendedBaseAttributes":{"location":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","value":"New York","displayValue":"New York"}],"certifications":[{"value":"AWS Certified Solutions Architect"}]},"nameKey":"OneTrust.CM.ModelNameKey"},"$ref":"#/components/schemas/EntityDetailRequest","additionalProperties":true,"title":"Entity Details"},"orgGroupId":{"description":"The unique identifier of the organization responsible for the object.","format":"uuid","example":{"id":"f8e7d6c5-b4a3-2019-8765-432109876543","name":"Parent Org"},"$ref":"#/components/schemas/EntityOrganizationInformation","title":"Organization Group ID"}},"example":{"name":"Customer Sentiment Analysis Model","description":"Model for analyzing customer feedback sentiment","modelVersion":"1.0.0","limitations":"Limited accuracy for non-English languages","biases":"May have cultural bias based on training data","modelSource":"Internal Development","referenceLink":"https://docs.example.com/models/sentiment-analysis"},"required":["name"],"title":"Model Creation Request"},"EntityIdentifierInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the object.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the object.","type":"string","example":"OneTrust"},"number":{"description":"The sequential order in which the object was created.","type":"integer","format":"int64","example":1},"orgGroupId":{"description":"The unique identifier of the organization responsible for the object.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46"},"entityType":{"description":"The details of the object type.","example":{"id":"a2319953-b4b5-4042-8cb9-b78038cc4c46","name":"Asset"},"$ref":"#/components/schemas/BasicEntityTypeInformation"}},"required":["entityType","id"]},"PageEntityIdentifierInformation":{"type":"object","properties":{"content":{"description":"The data of the returned objects.","example":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Customer Entity","type":"customer"}],"items":{"$ref":"#/components/schemas/EntityIdentifierInformation"},"type":"array"},"totalElements":{"description":"The total number of results in the list.","type":"integer","format":"int64","example":250,"minimum":0},"totalPages":{"description":"The total number of pages in the list.","type":"integer","format":"int32","example":25,"minimum":0},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":0,"minimum":0},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":10,"maximum":1000,"minimum":1},"first":{"description":"This flag indicates whether the current page is the first page of the list.","type":"boolean","example":true},"last":{"description":"This flag indicates whether the current page is the last page of the list.","type":"boolean","example":false},"empty":{"description":"The flag indicates whether no results exist on the page.","type":"boolean","example":false},"numberOfElements":{"description":"The number of results on the current page.","type":"integer","format":"int32","example":10,"minimum":0},"hasNext":{"description":"This flag indicates whether there is a next page in the list.","type":"boolean","example":true},"hasPrevious":{"description":"This flag indicates whether there is a previous page in the list.","type":"boolean","example":false}},"example":{"content":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Customer Entity","type":"customer","status":"active"}],"totalElements":250,"totalPages":25,"number":0,"size":10,"first":true,"last":false,"empty":false,"numberOfElements":10},"required":["content","empty","first","hasNext","hasPrevious","last","number","numberOfElements","size","totalElements","totalPages"]},"ProjectCreateRequest":{"type":"object","properties":{"name":{"description":"The name of the object.","type":"string","example":"Data Analytics Platform Development","maxLength":255,"minLength":3,"title":"Project Name"},"description":{"description":"The description of the object.","type":"string","example":"Development of an enterprise-wide data analytics platform with machine learning capabilities","maxLength":1000,"title":"Project Description"},"deadline":{"description":"The deadline of the project.","type":"string","format":"date","example":"2025-12-31","title":"Project Deadline"},"externalId":{"description":"The external identifier for the project.","type":"string","example":"PROJ-2025-001","maxLength":100,"title":"External ID"},"projectLink":{"description":"The project link or other URL.","type":"string","format":"uri","example":"https://project-tracker.example.com/projects/PROJ-2025-001","maxLength":2048,"title":"Project Link"},"intendedUse":{"description":"The intended use of the project.","type":"string","example":"Improve data-driven decision making across the organization","maxLength":1000,"title":"Intended Use"},"businessValue":{"description":"The business value of the project.","type":"string","example":"High","maxLength":100,"title":"Business Value"},"projectOwner":{"description":"The user assigned as the owner of the project.","type":"string","example":"john.smith@example.com","title":"Project Owner"},"status":{"description":"The status of the project.","type":"string","example":"Active","enum":["Draft","Active","In Progress","On Hold","Completed","Cancelled"],"title":"Project Status"},"type":{"description":"The type of project.","type":"string","example":"Development","enum":["AI","Campaign","Feature","General","Process","Product"],"title":"Project Type"},"internalOrExternal":{"description":"This parameter indicates whether the project is internal or external.","type":"string","example":"Internal","enum":["Internal","External"],"title":"Internal or External"},"promotionStatus":{"description":"The project promotion status.","type":"string","example":"Not Promoted","enum":["Not Promoted","Promoted","Promotion Pending"],"title":"Promotion Status"},"additionalAttributes":{"description":"This parameter can be used to store attribute details in key value pairs.","type":"object","example":{"description":[{"value":"Project to describe AI models"}],"status":[{"id":"c93031cd-7ed0-44c8-b454-396ec67095d9"}],"projectOwner":[{"id":"2e236528-dc82-4527-a76e-449d7044945a"}],"type":[{"value":"AI"}],"deadline":[{"value":"2025-07-30"}],"externalId":[{"value":"PROJ-123"}],"intendedUse":[{"value":"To provide data"}],"internalOrExternal":[{"id":"0bed5a32-ff57-49e9-8d21-143d50172d49"}],"purpose":[{"id":"0c5e58bc-8eb3-4fd6-810a-92d7e436d8d0"}],"attributeMultiSelectValue.valueId4_1":[{"id":"b28c4fe7-8ae7-4468-aa81-070600564f83"}]},"additionalProperties":true,"title":"Additional Attributes"},"entityDetail":{"description":"The details of the object.","example":{"extendedBaseAttributes":{"location":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","value":"New York","displayValue":"New York"}],"certifications":[{"value":"AWS Certified Solutions Architect"}]},"nameKey":"OneTrust.CM.ProjectNameKey"},"$ref":"#/components/schemas/EntityDetailRequest","additionalProperties":true,"title":"Entity Details"},"orgGroupId":{"description":"The unique identifier of the organization responsible for the object.","format":"uuid","example":{"id":"f8e7d6c5-b4a3-2019-8765-432109876543","name":"Parent Org"},"$ref":"#/components/schemas/EntityOrganizationInformation","title":"Organization Group ID"}},"example":{"name":"Data Analytics Platform Development","description":"Development of an enterprise-wide data analytics platform","deadline":"2025-12-31","externalId":"PROJ-2025-001","projectLink":"https://project-tracker.example.com/projects/PROJ-2025-001","status":"Active","type":"Development"},"required":["name"],"title":"Project Creation Request"},"AdvanceStageActionRequest":{"type":"object","properties":{"actionType":{"description":"Advance Stage Action Type","type":"string","enum":["ATTRIBUTES, ATTACHMENT"]},"actionMetadata":{"description":"Advance Stage Action Metadata","type":"object","example":{"fieldName":"value"},"additionalProperties":{"type":"object"}}},"example":[{"actionType":"ATTRIBUTES","actionMetadata":{"fieldName":"value"}}],"required":["actionType"]},"EntityDefaultWorkflowRequest":{"type":"object","properties":{"name":{"description":"The name of the workflow.","type":"string","example":"Default Vendor On-Boarding"},"description":{"description":"The description of the workflow.","type":"string","example":"Default Vendor On-Boarding For New Vendors"},"status":{"description":"The status of the workflow.","type":"string","enum":["PUBLISHED","DRAFT","ARCHIVED"]},"stages":{"description":"The stages of the workflow.","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageCreateRequest"}}},"required":["name"]},"EntityTypeSettingRequest":{"type":"object","properties":{"enableWorkflow":{"description":"This flag indicates whether the workflow is enabled.","type":"boolean","example":true},"assessable":{"description":"This flag indicates whether the object type is assessable.","type":"boolean","example":false},"enableTask":{"description":"This flag indicates whether tasks are enabled.","type":"boolean","example":false},"enableRisk":{"description":"This flag indicates whether risks are enabled.","type":"boolean","example":false},"enableDocument":{"description":"This flag indicates whether documents are enabled.","type":"boolean","example":false},"enableControl":{"description":"This flag indicates whether controls are enabled.","type":"boolean","example":false},"enableWebForm":{"description":"This flag indicates whether web forms are enabled.","type":"boolean","example":false},"enableComment":{"description":"This flag indicates whether comments are enabled.","type":"boolean","example":false}}},"EntityTypeUpdateRequest":{"type":"object","properties":{"name":{"description":"The name of the object type.","type":"string","example":"Vendor"},"description":{"description":"The description of the object type.","type":"string","example":"Module.VendorsNameKey"},"moduleScopes":{"description":"The product scopes of the object type.","type":"array","items":{"type":"string"},"example":["Inventory","VRM","Assessments","IssueManagement"],"enum":["Inventory","VRM","Assessments","IssueManagement","CustomEntityManagement","Control"],"uniqueItems":true},"settings":{"description":"The settings details of the object type.","example":{"enableWorkflow":true,"assessable":true},"$ref":"#/components/schemas/EntityTypeSettingRequest"},"workflow":{"description":"The details of the workflow.","example":{"name":"Vendor On-Boarding Workflow","description":"Vendor On-Boarding Workflow","stages":[{"name":"Start"},{"name":"End"}]},"$ref":"#/components/schemas/EntityDefaultWorkflowRequest"}}},"StageExceptionConfiguration":{"type":"object","properties":{"stageExceptionApprovers":{"description":"The details of the workflow stage exception approvers.","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageApproverRequest"},"examples":["{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"approverType\": \"SYSTEM_USER\",\n \"approverUserId\": \"456e7890-e89b-12d3-a456-426614174000\"\n }","{\n \"id\": \"234e5678-e89b-12d3-a456-426614174000\",\n \"approverType\": \"USER_ATTRIBUTE\",\n \"referenceApproverUserSourceId\": \"department_manager\",\n \"referenceApproverUserSourceOwner\": \"employee_schema\"\n }","{\n \"id\": \"345e6789-e89b-12d3-a456-426614174000\",\n \"approverType\": \"SYSTEM_USER\",\n \"approverUserGroupId\": \"789e0123-e89b-12d3-a456-426614174000\"\n }"]},"exceptionGrantedTargetStageId":{"description":"The unique identifier of the workflow stage for exception approval.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"workflowExceptionApprovalRequiredFromAll":{"description":"This flag indicates whether approval is required from all workflow stage exception approvers.","type":"boolean","example":true,"default":"false"}}},"WorkflowStageApproverRequest":{"type":"object","properties":{"id":{"description":"The unique identifier of the workflow stage exception approver.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"approverType":{"description":"The user type of the workflow stage exception approver.","type":"string","example":"SYSTEM_USER","enum":["SYSTEM_USER","USER_ATTRIBUTE"]},"approverUserId":{"description":"The unique identifier of the user assigned as the workflow stage exception approver.","type":"string","format":"uuid","example":"456e7890-e89b-12d3-a456-426614174000"},"referenceApproverUserSourceId":{"description":"The reference identifier for the approver's source, e.g. fieldName from Attribute Manager.","type":"string","example":"manager_id"},"referenceApproverUserSourceOwner":{"description":"The reference source owner, e.g. schemaName from Attribute Manager.","type":"string","example":"employee_schema"},"approverUserGroupId":{"description":"The unique identifier of the user group assigned as the workflow stage exception approver.","type":"string","format":"uuid","example":"789e0123-e89b-12d3-a456-426614174000"},"approverIdPresent":{"description":"This flag indicates whether the unique identifier of the workflow stage exception approver is present.","type":"boolean"}},"examples":["{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"approverType\": \"SYSTEM_USER\",\n \"approverUserId\": \"456e7890-e89b-12d3-a456-426614174000\"\n }","{\n \"id\": \"234e5678-e89b-12d3-a456-426614174000\",\n \"approverType\": \"USER_ATTRIBUTE\",\n \"referenceApproverUserSourceId\": \"department_manager\",\n \"referenceApproverUserSourceOwner\": \"employee_schema\"\n }","{\n \"id\": \"345e6789-e89b-12d3-a456-426614174000\",\n \"approverType\": \"SYSTEM_USER\",\n \"approverUserGroupId\": \"789e0123-e89b-12d3-a456-426614174000\"\n }"],"required":["approverType","id"]},"WorkflowStageCreateRequest":{"type":"object","properties":{"name":{"description":"The name of the workflow stage.","type":"string","example":"Document Review Stage"},"nameKey":{"description":"The name key of the workflow stage used for translation purposes.","type":"string","example":"Workflow.DocumentReview.Stage.Review"},"description":{"description":"The description of the workflow stage.","type":"string","example":"Stage for reviewing and approving documents before final submission"},"descriptionKey":{"description":"The description key of the workflow stage used for translation purposes.","type":"string","example":"Workflow.DocumentReview.Stage.Review.Description"},"allowDeletion":{"description":"This flag indicates whether the workflow stage can be deleted.","type":"boolean","example":true,"default":"true"},"badgeColor":{"description":"The badge color of the workflow stage.","type":"string","example":"#4287f5","pattern":"^#[0-9A-Fa-f]{6}$"},"approvalStage":{"description":"This flag indicates whether the workflow stage is the approval stage.","type":"boolean","example":true,"default":"false"},"exceptionStage":{"description":"This flag indicates whether the workflow stage is the exception stage.","type":"boolean","example":false,"default":"false"},"autoAdvanceOnApproval":{"description":"This flag indicates whether the workflow stage will advance upon approval.","type":"boolean","example":true,"default":"false"},"subTasks":{"description":"The details of the workflow stage subtasks.","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageSubTaskCreateRequest"},"example":[{"name":"Initial Review","description":"Perform initial document review","required":true},{"name":"Legal Compliance Check","description":"Verify legal compliance requirements","required":true}]},"stageApprovers":{"description":"The details of the workflow stage approvers.","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageApproverRequest"},"examples":["{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"approverType\": \"SYSTEM_USER\",\n \"approverUserId\": \"456e7890-e89b-12d3-a456-426614174000\"\n }","{\n \"id\": \"234e5678-e89b-12d3-a456-426614174000\",\n \"approverType\": \"USER_ATTRIBUTE\",\n \"referenceApproverUserSourceId\": \"department_manager\",\n \"referenceApproverUserSourceOwner\": \"employee_schema\"\n }","{\n \"id\": \"345e6789-e89b-12d3-a456-426614174000\",\n \"approverType\": \"SYSTEM_USER\",\n \"approverUserGroupId\": \"789e0123-e89b-12d3-a456-426614174000\"\n }"]},"stageExceptionConfiguration":{"description":"The details of the workflow stage exception configuration.","example":{"exceptionGrantedTargetStageId":"345e6789-e89b-12d3-a456-426614174000","stageExceptionApprovers":[{"id":"345e6789-e89b-12d3-a456-426614174000","approverType":"SYSTEM_USER","approverUserGroupId":"789e0123-e89b-12d3-a456-426614174000"}],"workflowExceptionApprovalRequiredFromAll":true},"$ref":"#/components/schemas/StageExceptionConfiguration"},"additionalFields":{"description":"The additional fields associated with the workflow stage.","type":"object","example":{"priority":"HIGH","department":"Legal","estimatedDuration":48,"costCenter":"CC-001","tags":["compliance","review"],"metadata":{"createdBy":"system","version":"1.0"}},"additionalProperties":{"type":"object"}},"advanceStageActionEnabled":{"description":"This flag indicates whether advance stage actions are enabled.","type":"boolean","example":true,"default":"false"},"advanceStageActions":{"description":"The details of the advanced stage actions.","type":"array","items":{"$ref":"#/components/schemas/AdvanceStageActionRequest"},"example":[{"actionType":"ATTRIBUTES","actionMetadata":{"fieldName":"value"}}]},"approvers":{"description":"The details of the workflow stage approvers.","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageApproverRequest"}}},"example":{"name":"Document Review Stage","nameKey":"Workflow.DocumentReview.Stage.Review","description":"Stage for reviewing and approving documents","descriptionKey":"Workflow.DocumentReview.Stage.Review.Description","allowDeletion":true,"badgeColor":"#4287f5","approvalStage":true,"exceptionStage":false,"autoAdvanceOnApproval":true,"subTasks":[{"name":"Initial Review","description":"Perform initial document review","required":true}],"stageApprovers":[{"approverId":"123e4567-e89b-12d3-a456-426614174000","approverType":"USER","required":true}],"stageExceptionConfiguration":{"allowExceptions":true,"exceptionApprovers":["456e7890-e89b-12d3-a456-426614174000"]},"additionalFields":{"priority":"HIGH","department":"Legal","estimatedDuration":48},"advanceStageActionEnabled":true,"advanceStageActions":[{"actionType":"ATTRIBUTES","actionMetadata":{"fieldName":"value"}}]},"required":["name"]},"WorkflowStageSubTaskCreateRequest":{"type":"object","properties":{"id":{"description":"Workflow Stage Sub-task Identifier","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"Workflow Stage Sub-task Name","type":"string","example":"Approval Sub-task"},"nameKey":{"description":"Workflow Stage Sub-task Name Key. Used for Translation","type":"string","example":"Workflow.SubTask.Approval"},"description":{"description":"Workflow Stage Sub-task Description","type":"string","example":"Review and validate all contract terms and conditions before approval"},"descriptionKey":{"description":"Workflow Stage Sub-task Description Key. Used for Translation","type":"string","example":"Workflow.SubTask.Approval.Description"},"required":{"description":"Indicate if Workflow Stage Sub-task is mandatory or not","type":"boolean","example":true,"default":"false"},"assigneeId":{"description":"Indicate if Workflow Stage Sub-task Assignee Id","type":"string","format":"uuid","example":"456e7890-e89b-12d3-a456-426614174000"},"assigneeName":{"description":"Indicate if Workflow Stage Sub-task Assignee Name","type":"string","example":"John Doe"},"actionType":{"description":"Workflow action type","type":"string","example":"Review"},"actionParameters":{"description":"Workflow action parameters","type":"string","example":{"reviewType":"legal","priority":"high","deadline":"2024-01-30"}}},"examples":["{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"name\": \"Document Review Sub-task\",\n \"nameKey\": \"Workflow.SubTask.ReviewContractTerms\",\n \"description\": \"Review and validate all Document Review Sub-task\",\n \"descriptionKey\": \"Workflow.SubTask.ReviewContractTerms.Description\",\n \"required\": true,\n \"assigneeId\": \"456e7890-e89b-12d3-a456-426614174000\",\n \"assigneeName\": \"John Doe\",\n \"actionType\": \"REVIEW\",\n \"actionParameters\": \"{\\\"reviewType\\\": \\\"legal\\\", \\\"priority\\\": \\\"high\\\"}\"\n}\n","{\n \"id\": \"234e5678-e89b-12d3-a456-426614174000\",\n \"name\": \"Approval Sub-task\",\n \"nameKey\": \"Workflow.SubTask.ManagerApproval\",\n \"description\": \"Requires Approval Sub-task before proceeding\",\n \"descriptionKey\": \"Workflow.SubTask.ManagerApproval.Description\",\n \"required\": true,\n \"assigneeId\": \"567e8901-e89b-12d3-a456-426614174000\",\n \"assigneeName\": \"Jane Smith\",\n \"actionType\": \"APPROVE\",\n \"actionParameters\": \"{\\\"approvalLevel\\\": \\\"manager\\\", \\\"timeout\\\": 48}\"\n}\n"],"required":["id","name"]},"LinkTypeInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the relationship type.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the relationship type.","type":"string","example":"Product/Service","maxLength":255,"minLength":1},"nameKey":{"description":"The name key of the relationship type used for translation purposes.","type":"string","example":"link.type.productservice.name"},"seeded":{"description":"This flag indicates whether the relationship type is seeded.","type":"boolean","example":true,"default":"false"},"moduleName":{"description":"The name of the product where the relationship type exists.","type":"string","example":"CustomEntityManagement"},"description":{"description":"The description of the relationship type.","type":"string","example":"Links between vendors and their products"},"descriptionKey":{"description":"The description key of the relationship type used for translation purposes.","type":"string","example":"entity.link.vendor_product.description"},"entityType1ToEntityType2EntityLinkName":{"description":"The name of the source object type's relationship to the target object type.","type":"string","example":"Vendor provides Product"},"entityType1ToEntityType2EntityLinkNameKey":{"description":"The name key of the source object type's relationship to the target object type used for translation purposes.","type":"string","example":"entity.link.vendor_to_product"},"entityType2ToEntityType1EntityLinkName":{"description":"The name of the target object type's relationship to the source object type.","type":"string","example":"Product belongs to Vendor"},"entityType2ToEntityType1EntityLinkNameKey":{"description":"The name key of the target object type's relationship to the source object type used for translation purposes.","type":"string","example":"entity.link.product_to_vendor"},"enableAudit":{"description":"This flag indicates whether audit activity is enabled.","type":"boolean","example":true,"default":"false"},"allowNewCustomLinkAssociation":{"description":"This flag indicates whether new custom relationship links are allowed.","type":"boolean","example":false,"default":"true"},"auditFields":{"description":"The activity details of when the record was created and last updated.","$ref":"#/components/schemas/EntityRecordAuditInformation"}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Vendor-Product","nameKey":"entity.link.vendor_product","description":"Links between vendors and their products","descriptionKey":"entity.link.vendor_product.description","displayName":"Vendor Product Relationship","displayNameKey":"entity.link.vendor_product.display","entityType1Id":"789e4567-e89b-12d3-a456-426614174123","entityType1Name":"Vendor","entityType2Id":"456e4567-e89b-12d3-a456-426614174789","entityType2Name":"Product","entityType1ToEntityType2EntityLinkName":"Vendor provides Product","entityType1ToEntityType2EntityLinkNameKey":"entity.link.vendor_to_product","entityType2ToEntityType1EntityLinkName":"Product belongs to Vendor","entityType2ToEntityType1EntityLinkNameKey":"entity.link.product_to_vendor","enableAudit":true,"allowNewCustomLinkAssociation":false,"auditFields":{"createdBy":"john.doe@example.com","createdTimestamp":"2025-01-15T10:30:45Z","lastModifiedBy":"jane.smith@example.com","lastModifiedTimestamp":"2025-06-10T14:15:22Z"}},"required":["id","name"]}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"OBJECT_MANAGER":"Grants full access to Object Manager related APIs.","OBJECT_MANAGER_READ":"Grants read access to Object Manager related APIs","OBJECT_MANAGER_WRITE":"Grants write access to Object Manager related APIs"}}}}}}}