Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Work API

25 actions 25 updates phrasing extends openapi/adobe-suite-work-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 25 · first 16 shown; the file carries all of them

$.info
$.paths['/work/{id}'].get
$.paths['/work'].get
$.paths['/work/count'].get
$.paths['/work/search'].get
$.paths['/work/report'].get
$.paths['/work/getMyAccomplishmentsCount'].put
$.paths['/work/getMyWorkCount'].put
$.paths['/work/getMyWorkCountFiltered'].put
$.paths['/work/getWFHomeObjects'].put
$.paths['/work/getWFHomeObjectsFilterSortBy'].put
$.paths['/work/getWFHomeObjectsListWithoutDate'].put
$.paths['/work/getWFHomeObjectsProjectItemList'].put
$.paths['/work/getWFHomeObjectsProjectList'].put
$.paths['/work/getWorkRequestsCount'].put
$.paths['/work/teamRequestCount'].put

OpenAPI Overlay

Raw ↑
# 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 Work API
  version: 1.0.0
extends: openapi/adobe-suite-work-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['/work/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one work item by ID
      effect: read
      questions:
      - How can I look up a single Workfront work item when I already have its ID?
      - Can I choose which fields come back when fetching one work item?
      instructions:
      - text: Show me work item {id}.
        slots:
          id: path.id
      - text: Get work item {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several work items by ID at once
      effect: read
      questions:
      - Is there a way to pull a batch of work items in one call by passing a list of IDs?
      - What does a bulk get of work items return for each ID I pass?
      instructions:
      - text: Fetch the work items with IDs {id} in one request.
        slots:
          id: query.id
      - text: Bulk get work items {id} returning fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count work items matching filters
      effect: read
      questions:
      - How many work items match a given filter in Workfront?
      - Can I get just the total number of work items without listing them?
      instructions:
      - text: Count all work items where {filters}.
        slots:
          filters: query.filters
      - text: Give me the total number of work items in the system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search work items with filters
      effect: read
      questions:
      - How do I search work items by status, assignee or other filters?
      - Can I page and sort the results when searching work items?
      instructions:
      - text: Search work items matching {filters}.
        slots:
          filters: query.filters
      - text: Search work items matching {filters} and return fields {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on work items
      effect: read
      questions:
      - Can I get grouped or aggregated report data about work items rather than raw records?
      - What kind of summary report can I run across work items?
      instructions:
      - text: Run a work item report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a report of work items using list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getMyAccomplishmentsCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count my completed accomplishments
      effect: read
      questions:
      - How many accomplishments have I completed in Workfront?
      - Is there a quick number for my finished work, without the list?
      instructions:
      - text: Tell me how many accomplishments I have.
      - text: Get the count of my accomplishments.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getMyWorkCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count the work assigned to me
      effect: read
      questions:
      - How many items are currently in my work list?
      - What is the total count of work assigned to me, unfiltered?
      instructions:
      - text: Count everything in my work list.
      - text: How much work do I have assigned right now, as a number.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getMyWorkCountFiltered'].put
  update:
    x-apievangelist-phrasing:
      intent: Count my assigned work with a filter
      effect: read
      questions:
      - Can I count only the part of my assigned work that matches a filter?
      - How many of my own work items meet a specific condition?
      instructions:
      - text: Count my assigned work where {filters}.
        slots:
          filters: query.filters
      - text: Give me a filtered count of my work using {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getWFHomeObjects'].put
  update:
    x-apievangelist-phrasing:
      intent: Load my Workfront Home work items
      effect: read
      questions:
      - How do I pull the items shown on my Workfront Home page for a date range?
      - Can I narrow my Home items by view, action group or a search term?
      instructions:
      - text: Load my Home items between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show my Home items in view {view} matching {search}, first {limit}.
        slots:
          view: query.view
          search: query.search
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getWFHomeObjectsFilterSortBy'].put
  update:
    x-apievangelist-phrasing:
      intent: Load Home items with a filter and sort order
      effect: read
      questions:
      - Can I sort my Workfront Home items by a field and choose ascending or descending?
      - Is it possible to include undated items when filtering my Home list?
      instructions:
      - text: Show my Home items filtered by {filter} sorted by {sortBy}.
        slots:
          filter: query.filter
          sortBy: query.sortBy
      - text: List my Home items sorted by {sortBy} ascending={isAscending}, including undated ones.
        slots:
          sortBy: query.sortBy
          isAscending: query.isAscending
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getWFHomeObjectsListWithoutDate'].put
  update:
    x-apievangelist-phrasing:
      intent: List Home items that have no dates
      effect: read
      questions:
      - Where can I find the Home work items that have no planned dates?
      - Can I sort my undated Home items?
      instructions:
      - text: Show my undated Home items sorted by {sortBy}.
        slots:
          sortBy: query.sortBy
      - text: List the first {limit} Home items without dates matching {filter}.
        slots:
          limit: query.limit
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getWFHomeObjectsProjectItemList'].put
  update:
    x-apievangelist-phrasing:
      intent: List my Home items within one project
      effect: read
      questions:
      - How can I see just my Home work items that belong to a particular project?
      - Can I restrict a project's Home items to a date window?
      instructions:
      - text: Show my Home items in project {projectID}.
        slots:
          projectID: query.projectID
      - text: List my items in project {projectID} due between {startDate} and {endDate}.
        slots:
          projectID: query.projectID
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getWFHomeObjectsProjectList'].put
  update:
    x-apievangelist-phrasing:
      intent: List projects that hold my Home work
      effect: read
      questions:
      - Which projects contain the work showing on my Home page?
      - Can I search the list of projects behind my Home items by name?
      instructions:
      - text: List the projects my Home work belongs to matching {search}.
        slots:
          search: query.search
      - text: Show the projects with my Home work between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/getWorkRequestsCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count work requests matching filters
      effect: read
      questions:
      - How many work requests are there that match my filter?
      - Can I get a count of work requests rather than the requests themselves?
      instructions:
      - text: Count the work requests where {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many work requests exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/teamRequestCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count team requests with a filter
      effect: read
      questions:
      - How many requests assigned to my team meet a certain filter?
      - Can I filter the team request count?
      instructions:
      - text: Count my team's requests where {filters}.
        slots:
          filters: query.filters
      - text: Give a filtered team request count using {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/teamRequestsCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count all requests for my teams
      effect: read
      questions:
      - What is the total number of requests waiting on my teams?
      - Is there an unfiltered count of team requests?
      instructions:
      - text: Count all requests across my teams.
      - text: Tell me the total team requests count.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/workItemStatusLabels'].put
  update:
    x-apievangelist-phrasing:
      intent: Get status labels for work items
      effect: read
      questions:
      - How do I get the display status label for a set of work items?
      - Can I translate several work items into their status labels in one call?
      instructions:
      - text: Get the status labels for work items {items}.
        slots:
          items: query.items
      - text: Look up what status label each of {items} shows.
        slots:
          items: query.items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/myAccomplishments'].get
  update:
    x-apievangelist-phrasing:
      intent: List my accomplishments
      effect: read
      questions:
      - Where can I see the list of work I have accomplished?
      - Can I filter my accomplishments list?
      instructions:
      - text: List my accomplishments.
      - text: Show my accomplishments matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/myAwaitingFeedbackRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List my requests awaiting feedback
      effect: read
      questions:
      - Which of my requests are waiting for my feedback?
      - Can I filter the requests that need a response from me?
      instructions:
      - text: Show my requests awaiting feedback.
      - text: List requests waiting on my feedback where {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/myCompletedRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List my completed requests
      effect: read
      questions:
      - What requests that I submitted have been completed?
      - Can I filter my finished requests?
      instructions:
      - text: List my completed requests.
      - text: Show my completed requests matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/myOpenRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List my open requests
      effect: read
      questions:
      - Which of the requests I submitted are still open?
      - Can I filter my open requests list?
      instructions:
      - text: Show my open requests.
      - text: List my still-open requests where {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/myWork'].get
  update:
    x-apievangelist-phrasing:
      intent: List the work assigned to me
      effect: read
      questions:
      - What tasks and issues are currently assigned to me?
      - Can I filter my work list down to specific items?
      instructions:
      - text: List everything assigned to me.
      - text: Show my assigned work matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/teamRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List requests assigned to my teams
      effect: read
      questions:
      - Which requests are sitting in my team's queue?
      - Can I filter the list of team requests?
      instructions:
      - text: List my team's requests.
      - text: Show team requests matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work/workRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List work requests
      effect: read
      questions:
      - Where do I see the full list of work requests, not just a count?
      - Can I filter work requests by criteria?
      instructions:
      - text: List the work requests.
      - text: Show work requests where {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'