# 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 Assessment…
  version: 1.0.0
extends: openapi/onetrust-assessment-management-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: 7
- target: $.paths['/api/assessment/v2/assessments/archive'].put
  update:
    x-apievangelist-phrasing:
      intent: Archive assessments
      effect: write
      questions:
      - How do I archive completed assessments in bulk?
      - Where do assessments go after I archive them?
      instructions:
      - text: Archive the assessments I specify.
      - text: Move these assessments into the Archive list in bulk.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/assessment-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Link assessments together
      effect: write
      questions:
      - How do I link one assessment to several others?
      - Which assessment template types can be linked, and can archived ones be included?
      instructions:
      - text: Link assessment {fromId} to assessments {toIds}.
        slots:
          fromId: requestBody.fromId
          toIds: requestBody.toIds
      - text: Connect assessment {fromId} with related assessments {toIds}.
        slots:
          fromId: requestBody.fromId
          toIds: requestBody.toIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/un-archive'].put
  update:
    x-apievangelist-phrasing:
      intent: Unarchive assessments
      effect: write
      questions:
      - How do I restore archived assessments back to the Active list?
      - Can I unarchive several assessments in one request?
      instructions:
      - text: Unarchive the assessments I specify.
      - text: Bring these archived assessments back to Active.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/metadata'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an assessment's name, deadline or reminder
      effect: write
      questions:
      - How do I change an assessment's deadline or reminder?
      - Why are my edits ignored on an assessment in the Completed stage?
      instructions:
      - text: Set the deadline of assessment {assessmentId} to {deadline}.
        slots:
          assessmentId: path.assessmentId
          deadline: requestBody.deadline
      - text: Rename assessment {assessmentId} to {name}.
        slots:
          assessmentId: path.assessmentId
          name: requestBody.name
      - text: Set a reminder of {reminder} on assessment {assessmentId}.
        slots:
          reminder: requestBody.reminder
          assessmentId: path.assessmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/primary-records'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an assessment's primary record
      effect: write
      questions:
      - How do I set or replace the primary record an assessment is about?
      - Can an assessment's primary record be an asset or processing activity?
      instructions:
      - text: Set the primary record of assessment {assessmentId} to {primaryRecordType} {primaryRecordIds}.
        slots:
          assessmentId: path.assessmentId
          primaryRecordType: requestBody.primaryRecordType
          primaryRecordIds: requestBody.primaryRecordIds
      - text: Point assessment {assessmentId} at primary records {primaryRecordIds} of type {primaryRecordType}.
        slots:
          assessmentId: path.assessmentId
          primaryRecordIds: requestBody.primaryRecordIds
          primaryRecordType: requestBody.primaryRecordType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/soft-delete'].put
  update:
    x-apievangelist-phrasing:
      intent: Move an assessment to the recycle bin
      effect: destructive
      questions:
      - How do I soft delete an assessment so it can still be restored?
      - Which assessments can be moved to the recycle bin?
      instructions:
      - text: Move assessment {assessmentId} to the recycle bin.
        slots:
          assessmentId: path.assessmentId
      - text: Soft delete assessment {assessmentId}.
        slots:
          assessmentId: path.assessmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/tags'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an assessment's tags
      effect: write
      questions:
      - How do I tag an assessment?
      - Will updating an assessment's tags remove the ones already on it?
      instructions:
      - text: Replace the tags on assessment {assessmentId}.
        slots:
          assessmentId: path.assessmentId
      - text: Overwrite all tags of assessment {assessmentId} with a new set.
        slots:
          assessmentId: path.assessmentId
      method: generated
      generated: '2026-09-26'