# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Privacy Automation - Assessment Automation Assessments API version: 1.0.0 extends: openapi/onetrust-assessments-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 12 - target: $.paths['/api/assessment/v2/assessment-tags'].get update: x-apievangelist-phrasing: intent: List assessment tags effect: read questions: - What tags are available to label assessments? - Where do I find the tag IDs to apply to an assessment? instructions: - text: List all assessment tags. - text: Show the tag IDs I can put on assessments. method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments'].get update: x-apievangelist-phrasing: intent: List assessments effect: read questions: - Which assessments exist in OneTrust and what stage is each in? - Can I list only archived assessments or only ones with a certain status? instructions: - text: List all assessments. - text: List assessments of template type {templateTypes} with status {assessmentStatuses}. slots: templateTypes: query.templateTypes assessmentStatuses: query.assessmentStatuses method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/activities/types/assessmentdelete'].get update: x-apievangelist-phrasing: intent: Export the deleted-assessment audit log effect: read questions: - Who deleted an assessment and when? - Is there a log of every assessment that has been removed? instructions: - text: Export the log of deleted assessments. - text: Show which users deleted assessments and the timestamps. method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/assessment-results'].get update: x-apievangelist-phrasing: intent: List assessment result options effect: read questions: - What result values can I choose when completing an assessment? - Can I narrow the result options to one template type? instructions: - text: List the result options for completing assessments. - text: List assessment result options for template type {templateTypes}. slots: templateTypes: query.templateTypes method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/reference-objects/{id}/assessments'].get update: x-apievangelist-phrasing: intent: List assessments linked to a record effect: read questions: - Which assessments were copied, reassessed or triggered from a given record? - Can I see all assessments tied to a vendor or asset? instructions: - text: List assessments linked to record {id} of type {referenceType}. slots: id: path.id referenceType: query.referenceType - text: Show {linkTypes} assessments linked to {referenceType} record {id}. slots: linkTypes: query.linkTypes referenceType: query.referenceType id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/{assessmentId}/export'].get update: x-apievangelist-phrasing: intent: Export full details of an assessment effect: read questions: - Can I export an assessment with its respondents, approvers, answers and risks? - Is there a way to leave skipped questions out of an assessment export? instructions: - text: Export assessment {assessmentId}. slots: assessmentId: path.assessmentId - text: 'Export assessment {assessmentId} without skipped questions: {excludeSkippedQuestions}.' slots: assessmentId: path.assessmentId excludeSkippedQuestions: query.excludeSkippedQuestions method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/{assessmentId}/record'].get update: x-apievangelist-phrasing: intent: Get a lightweight assessment record effect: read questions: - Can I fetch just an assessment's sections, questions and responses without the risk data? - What does the lightweight assessment record leave out by default? instructions: - text: Get the assessment record for {assessmentId}. slots: assessmentId: path.assessmentId - text: Get the record for assessment {assessmentId} with all details set to {showAllDetails}. slots: assessmentId: path.assessmentId showAllDetails: query.showAllDetails method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/{assessmentId}/score-profiles'].get update: x-apievangelist-phrasing: intent: Get an assessment's score profiles effect: read questions: - How was an assessment scored question by question? - What weights and option scores fed into an assessment's profile score? instructions: - text: Get the score profiles for assessment {assessmentId}. slots: assessmentId: path.assessmentId - text: Break down the question-level scores of assessment {assessmentId}. slots: assessmentId: path.assessmentId method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/assessments/{assessmentId}/workflows'].get update: x-apievangelist-phrasing: intent: Get an assessment's workflow stage effect: read questions: - Which workflow and approval stage is an assessment currently in? - Can I see the stage name and ID for an assessment? instructions: - text: Get the workflow stages for assessment {assessmentId}. slots: assessmentId: path.assessmentId - text: Tell me the current approval stage of assessment {assessmentId}. slots: assessmentId: path.assessmentId method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v2/comments/assessments/{assessmentId}'].get update: x-apievangelist-phrasing: intent: List comments on an assessment effect: read questions: - What have reviewers commented on an assessment's questions? - Are assessment comments sorted by section and question? instructions: - text: List the comments on assessment {assessmentId}. slots: assessmentId: path.assessmentId - text: Show every question comment left on assessment {assessmentId}. slots: assessmentId: path.assessmentId method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v3/assessments/comments'].post update: x-apievangelist-phrasing: intent: Comment on an assessment question effect: write questions: - Can I add a comment to a specific question in an assessment? - What IDs do I need to comment on an assessment question? instructions: - text: Comment {comment} on question {questionId} in section {sectionId} of assessment {assessmentId}. slots: comment: requestBody.comment questionId: requestBody.questionId sectionId: requestBody.sectionId assessmentId: requestBody.assessmentId - text: 'Add a note to question {questionId}, section {sectionId}, assessment {assessmentId}: {comment}.' slots: questionId: requestBody.questionId sectionId: requestBody.sectionId assessmentId: requestBody.assessmentId comment: requestBody.comment method: generated generated: '2026-09-26' - target: $.paths['/api/assessment/v3/assessments/list'].post update: x-apievangelist-phrasing: intent: Filter assessments by approver, respondent or template effect: read questions: - Can I find all assessments assigned to a particular approver or respondent? - Which columns can I choose to return when filtering assessments by criteria? instructions: - text: Find assessments matching {filterCriteria} and return columns {visibleColumns}. slots: filterCriteria: requestBody.filterCriteria visibleColumns: requestBody.visibleColumns - text: Filter assessments by criteria and show only columns {visibleColumns}. slots: visibleColumns: requestBody.visibleColumns method: generated generated: '2026-09-26'