# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Usernote API
  version: 1.0.0
extends: openapi/adobe-suite-usernote-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: 24
- target: $.paths['/usernote/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Workfront user notification
      effect: read
      questions:
      - How do I look up a single user notification by its ID in Workfront?
      - Can I choose which fields come back when fetching one user note?
      instructions:
      - text: Show me user note {id}.
        slots:
          id: path.id
      - text: Get notification {id} with only the {fields} fields.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several user notes by ID at once
      effect: read
      questions:
      - Is there a way to pull a batch of user notes in one call by listing their IDs?
      - Can I fetch multiple Workfront notifications together instead of one at a time?
      instructions:
      - text: Fetch the user notes with IDs {id}.
        slots:
          id: query.id
      - text: Bulk-load notifications {id} returning fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user note
      effect: write
      questions:
      - How do I create a new user note in Workfront through the API?
      - Can I post a notification record for a user programmatically?
      instructions:
      - text: Create a new user note.
      - text: Add a user note and return the {fields} fields.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count user notes matching a filter
      effect: read
      questions:
      - How many user notes match a given filter?
      - Can I get just a total of notifications without downloading them?
      instructions:
      - text: Count user notes matching {filters}.
        slots:
          filters: query.filters
      - text: Give me the total number of user notes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search user notes with filters
      effect: read
      questions:
      - What's the way to search user notes by field values in Workfront?
      - Can I page and sort results when searching user notes?
      instructions:
      - text: Search user notes where {filters}.
        slots:
          filters: query.filters
      - text: Find user notes matching {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on user notes
      effect: read
      questions:
      - Can I run a grouped or aggregated report over user notes?
      - How do I summarize user notes by some field rather than list them?
      instructions:
      - text: Run a user note report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a user note report with options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/acknowledge'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark one notification as read
      effect: write
      questions:
      - How do I acknowledge a single notification so it stops showing as unread?
      - Can I mark one specific user note as read?
      instructions:
      - text: Acknowledge notification {ID}.
        slots:
          ID: query.ID
      - text: Mark user note {ID} as read.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/acknowledgeAll'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark all my notifications as read
      effect: write
      questions:
      - Is there a way to clear every unread notification in one go?
      - How do I acknowledge all of my Workfront notifications at once?
      instructions:
      - text: Mark all my notifications as read.
      - text: Acknowledge every user note I have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/acknowledgeMany'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a set of user notes as read
      effect: write
      questions:
      - Can I acknowledge several user notes by ID in a single call?
      - How do I mark a chosen batch of notes as read?
      instructions:
      - text: Acknowledge user notes {objIDs}.
        slots:
          objIDs: query.objIDs
      - text: 'Mark these notes as read: {objIDs}.'
        slots:
          objIDs: query.objIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/acknowledgeMyNotifications'].put
  update:
    x-apievangelist-phrasing:
      intent: Acknowledge selected notifications of mine
      effect: write
      questions:
      - How do I acknowledge specific notifications from my own notification feed?
      - Can I mark only some of my personal notifications as seen?
      instructions:
      - text: Acknowledge my notifications {objIDs}.
        slots:
          objIDs: query.objIDs
      - text: 'Clear these items from my notification feed: {objIDs}.'
        slots:
          objIDs: query.objIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/unacknowledge'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark one notification as unread again
      effect: write
      questions:
      - Can I undo acknowledging a notification so it shows as unread?
      - How do I flip a single user note back to unread?
      instructions:
      - text: Unacknowledge notification {ID}.
        slots:
          ID: query.ID
      - text: Mark user note {ID} as unread again.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/unacknowledgeMany'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark several notifications as unread
      effect: write
      questions:
      - Is it possible to reset a batch of notes back to unread?
      - How do I unacknowledge multiple user notes at once?
      instructions:
      - text: Unacknowledge user notes {objIDs}.
        slots:
          objIDs: query.objIDs
      - text: 'Set these notes back to unread: {objIDs}.'
        slots:
          objIDs: query.objIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/unacknowledgedAllObjectTypesCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count unread notes across all object types
      effect: read
      questions:
      - How many unread notifications do I have across every object type?
      - Can I get one unread total that covers all kinds of objects?
      instructions:
      - text: Count my unread notes across all object types.
      - text: Tell me my total unread notification count for every object type.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/unacknowledgedAnnouncementCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count my unread announcements
      effect: read
      questions:
      - How many announcements haven't I read yet?
      - Can I get the unread count for announcements only?
      instructions:
      - text: Count my unread announcements.
      - text: How many announcement notes are still unacknowledged for me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/unacknowledgedCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count my unread notifications
      effect: read
      questions:
      - What's my current unread notification count in Workfront?
      - Can I show a badge number of unacknowledged user notes?
      instructions:
      - text: Get my unread notification count.
      - text: Show the number of unacknowledged user notes I have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/announcementNotifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List announcement notifications by page
      effect: read
      questions:
      - How do I list announcement notifications page by page?
      - Can I browse older announcements by page number?
      instructions:
      - text: List announcement notifications.
      - text: Show page {pageNumber} of announcement notifications.
        slots:
          pageNumber: query.pageNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/deletedAnnouncementNotes'].get
  update:
    x-apievangelist-phrasing:
      intent: List deleted announcement notes
      effect: read
      questions:
      - Can I see announcement notes that have been deleted?
      - Which announcements were removed from my notifications?
      instructions:
      - text: List deleted announcement notes.
      - text: Show the last {limit} deleted announcement notes.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myAllObjectTypesUnreadNotifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my unread notifications for all object types
      effect: read
      questions:
      - How do I pull my unread notifications regardless of object type?
      - Can I limit and offset my unread notifications across every object type?
      instructions:
      - text: List my unread notifications across all object types.
      - text: Show {limit} unread notifications of every object type starting at {first}.
        slots:
          limit: query.limit
          first: query.first
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myNewestAnnouncementNotification'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my newest announcement
      effect: read
      questions:
      - What's the most recent announcement sent to me?
      - Can I fetch only the latest announcement notification?
      instructions:
      - text: Show my newest announcement.
      - text: Get the latest announcement notification I received.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myNewestNotification'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my newest notification
      effect: read
      questions:
      - What is the latest notification I got in Workfront?
      - Can I retrieve just my single most recent user note?
      instructions:
      - text: Show my newest notification.
      - text: Get the most recent user note addressed to me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myNotifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notifications
      effect: read
      questions:
      - How do I list all notifications addressed to me?
      - Can I filter my own notification feed?
      instructions:
      - text: List my notifications.
      - text: Show my notifications filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myNotificationsQuickList'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quick list of my notifications
      effect: read
      questions:
      - Is there a lightweight quick list of my notifications for a dropdown?
      - Can I get a short summary list of my recent notifications?
      instructions:
      - text: Show my notifications quick list.
      - text: Get the compact list of my recent notifications.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myUnreadAnnouncementNotifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my unread announcements
      effect: read
      questions:
      - Which announcements are still unread for me?
      - Can I cap how many unread announcements come back?
      instructions:
      - text: List my unread announcements.
      - text: Show up to {limit} unread announcements.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usernote/myUnreadNotifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my unread notifications
      effect: read
      questions:
      - What notifications have I not read yet?
      - Can I list only my unacknowledged notifications with a limit?
      instructions:
      - text: List my unread notifications.
      - text: Show my {limit} most recent unread notifications.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'