Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Project API
33 actions
33 updates
phrasing
extends
openapi/adobe-suite-project-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.
What the actions change
x-apievangelist-phrasing
Targets 33 · first 16 shown; the file carries all of them
$.info
$.paths['/project/{id}'].get
$.paths['/project/{id}'].put
$.paths['/project/{id}'].delete
$.paths['/project'].get
$.paths['/project'].put
$.paths['/project'].post
$.paths['/project'].delete
$.paths['/project/count'].get
$.paths['/project/search'].get
$.paths['/project/report'].get
$.paths['/project/{id}/share'].put
$.paths['/project/share'].put
$.paths['/project/{id}/unshare'].put
$.paths['/project/unshare'].put
$.paths['/project/{id}/sharePublic'].put
OpenAPI Overlay
# 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 Project API
version: 1.0.0
extends: openapi/adobe-suite-project-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: 32
- target: $.paths['/project/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one project by ID
effect: read
questions:
- How do I look up a single Workfront project when I already know its ID?
- Can I choose which fields come back when fetching one project?
instructions:
- text: Show me project {id}.
slots:
id: path.id
- text: Get project {id} with only the fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/project/{id}'].put
update:
x-apievangelist-phrasing:
intent: Edit a single project
effect: write
questions:
- How do I change the details of one existing project?
- What comes back after I edit a project — can I pick the returned fields?
instructions:
- text: Update the details of project {id}.
slots:
id: path.id
- text: Edit project {id} and return the fields {fields} afterwards.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/project/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one project
effect: destructive
questions:
- How do I permanently remove a single project?
- Can I force-delete a project that has dependent objects?
instructions:
- text: Delete project {id}.
slots:
id: path.id
- text: Force delete project {id} even if it has linked items.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/project'].get
update:
x-apievangelist-phrasing:
intent: Fetch several projects by their IDs
effect: read
questions:
- Is there a way to pull several projects at once by a list of IDs?
- Can I fetch a batch of projects in one call instead of one at a time?
instructions:
- text: Fetch the projects with IDs {ids} in one request.
slots:
ids: query.id
- text: Get projects {ids} and include only {fields}.
slots:
ids: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/project'].put
update:
x-apievangelist-phrasing:
intent: Bulk edit many projects at once
effect: write
questions:
- Can I apply changes to many projects in a single bulk update?
- How do I mass-edit a group of projects together?
instructions:
- text: Bulk update the listed projects with the changes I provide.
- text: Mass edit these projects and return {fields} for each.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/project'].post
update:
x-apievangelist-phrasing:
intent: Create a new project or copy an existing one
effect: write
questions:
- How do I create a brand new project?
- Can I make a new project as a copy of an existing one?
instructions:
- text: Create a new project with the name and details I give you.
- text: Make a copy of project {source} as a new project.
slots:
source: query.copySourceID
method: generated
generated: '2026-09-26'
- target: $.paths['/project'].delete
update:
x-apievangelist-phrasing:
intent: Bulk delete several projects
effect: destructive
questions:
- Can I delete a whole batch of projects in one go?
- What happens if I force a bulk project deletion?
instructions:
- text: Delete all of the projects {ids}.
slots:
ids: query.id
- text: Force remove the batch of projects {ids}.
slots:
ids: query.id
method: generated
generated: '2026-09-26'
- target: $.paths['/project/count'].get
update:
x-apievangelist-phrasing:
intent: Count projects matching filters
effect: read
questions:
- How many projects do we have right now?
- Can I get just a count of projects that match a filter, without the records?
instructions:
- text: Count all projects.
- text: Tell me how many projects match {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/project/search'].get
update:
x-apievangelist-phrasing:
intent: Search projects by criteria
effect: read
questions:
- How do I find projects that match certain criteria, like status or owner?
- Can I page and sort through project search results?
instructions:
- text: Search projects where {filters}.
slots:
filters: query.filters
- text: Find projects matching {filters} and return {fields} for each result.
slots:
filters: query.filters
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/project/report'].get
update:
x-apievangelist-phrasing:
intent: Run a grouped report over projects
effect: read
questions:
- Can I get aggregated report data across projects instead of raw records?
- Which report options let me group or summarize project data?
instructions:
- text: Run a project report for {filters}.
slots:
filters: query.filters
- text: Produce an aggregated project report using report options {options}.
slots:
options: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/project/{id}/share'].put
update:
x-apievangelist-phrasing:
intent: Share a project with a user or team
effect: write
questions:
- How do I give a teammate access to one of my projects?
- Can I share a project with view-only rights and block certain actions?
instructions:
- text: Share project {id} with {accessor_type} {accessor} at {access} level.
slots:
id: path.id
accessor_type: query.accessorObjCode
accessor: query.accessorID
access: query.coreAction
- text: Grant user {accessor} {access} rights on project {id}.
slots:
id: path.id
accessor: query.accessorID
access: query.coreAction
method: generated
generated: '2026-09-26'
- target: $.paths['/project/share'].put
update:
x-apievangelist-phrasing:
intent: Share several projects with someone at once
effect: write
questions:
- Can I grant one person access to a batch of projects in one request?
- Is there a bulk way to share multiple projects with a team?
instructions:
- text: Share the projects {ids} with {accessor_type} {accessor} granting {access}.
slots:
ids: query.id
accessor_type: query.accessorObjCode
accessor: query.accessorID
access: query.coreAction
- text: Give team {accessor} {access} access to all of projects {ids}.
slots:
ids: query.id
accessor: query.accessorID
access: query.coreAction
method: generated
generated: '2026-09-26'
- target: $.paths['/project/{id}/unshare'].put
update:
x-apievangelist-phrasing:
intent: Remove someone's access to a project
effect: destructive
questions:
- How do I revoke a user's access to a single project?
- Can I take a team off a project I previously shared with them?
instructions:
- text: Stop sharing project {id} with {accessor_type} {accessor}.
slots:
id: path.id
accessor_type: query.accessorObjCode
accessor: query.accessorID
- text: Revoke user {accessor}'s access on project {id}.
slots:
id: path.id
accessor: query.accessorID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/unshare'].put
update:
x-apievangelist-phrasing:
intent: Revoke access to several projects at once
effect: destructive
questions:
- Can I remove one person from many shared projects in a single call?
- Is there a bulk way to unshare a group of projects?
instructions:
- text: Unshare projects {ids} from {accessor_type} {accessor}.
slots:
ids: query.id
accessor_type: query.accessorObjCode
accessor: query.accessorID
- text: Remove team {accessor} from every project in {ids}.
slots:
ids: query.id
accessor: query.accessorID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/{id}/sharePublic'].put
update:
x-apievangelist-phrasing:
intent: Make a project publicly shared
effect: write
questions:
- How do I make one project visible to everyone through a public share?
- What access level can a public project share grant?
instructions:
- text: Publicly share project {id} with {access} access.
slots:
id: path.id
access: query.coreAction
- text: Open project {id} to everyone as {access}, blocking {blocked}.
slots:
id: path.id
access: query.coreAction
blocked: query.forbiddenActions
method: generated
generated: '2026-09-26'
- target: $.paths['/project/sharePublic'].put
update:
x-apievangelist-phrasing:
intent: Publicly share several projects at once
effect: write
questions:
- Can I turn on public sharing for a batch of projects together?
- Is there a bulk public-share option for multiple projects?
instructions:
- text: Make projects {ids} public with {access} access.
slots:
ids: query.id
access: query.coreAction
- text: Turn on public sharing for all of projects {ids} as {access}.
slots:
ids: query.id
access: query.coreAction
method: generated
generated: '2026-09-26'
- target: $.paths['/project/{id}/unsharePublic'].put
update:
x-apievangelist-phrasing:
intent: Turn off public sharing for a project
effect: destructive
questions:
- How do I stop a project from being publicly shared?
- Can I make a public project private again?
instructions:
- text: Remove the public share from project {id}.
slots:
id: path.id
- text: Make project {id} private again.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/project/unsharePublic'].put
update:
x-apievangelist-phrasing:
intent: Turn off public sharing for several projects
effect: destructive
questions:
- Can I revoke public access on many projects at once?
- Is there a bulk way to make a set of public projects private?
instructions:
- text: Remove public sharing from projects {ids}.
slots:
ids: query.id
- text: Make every project in {ids} private in one request.
slots:
ids: query.id
method: generated
generated: '2026-09-26'
- target: $.paths['/project/approveApproval'].put
update:
x-apievangelist-phrasing:
intent: Approve a pending project approval
effect: write
questions:
- How do I approve a project that is waiting on my sign-off?
- Can I add an audit note and email it when approving a project?
instructions:
- text: Approve project {project} on behalf of user {user}.
slots:
project: query.ID
user: query.userID
- text: Approve project {project} with the audit note {note} and email it.
slots:
project: query.ID
note: query.auditNote
method: generated
generated: '2026-09-26'
- target: $.paths['/project/attachTemplate'].put
update:
x-apievangelist-phrasing:
intent: Attach a template to a project
effect: write
questions:
- How do I apply a project template to an existing project?
- Can I attach a template's tasks under a specific parent task and skip some of them?
instructions:
- text: Attach template {template} to project {project}.
slots:
template: query.templateID
project: query.ID
- text: Add template {template} to project {project} under parent task {parent}.
slots:
template: query.templateID
project: query.ID
parent: query.parentTaskID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/calculateDataExtension'].put
update:
x-apievangelist-phrasing:
intent: Recalculate a project's custom data fields
effect: write
questions:
- How do I refresh the calculated custom fields on a project?
- Can I force a project's custom form calculations to rerun?
instructions:
- text: Recalculate the custom data extension fields on project {project}.
slots:
project: query.ID
- text: Rerun the calculated custom form values for project {project}.
slots:
project: query.ID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/calculateFinance'].put
update:
x-apievangelist-phrasing:
intent: Recalculate a project's finances
effect: write
questions:
- How do I recompute budget and cost figures for a project?
- Can I refresh the financial totals on a project after rates changed?
instructions:
- text: Recalculate the finances for project {project}.
slots:
project: query.ID
- text: Refresh cost and revenue totals on project {project}.
slots:
project: query.ID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/calculateTimeline'].put
update:
x-apievangelist-phrasing:
intent: Recalculate a project's timeline
effect: write
questions:
- How do I recalculate the schedule and dates on a project?
- Can I refresh a project's timeline after moving tasks around?
instructions:
- text: Recalculate the timeline for project {project}.
slots:
project: query.ID
- text: Rerun schedule date calculations on project {project}.
slots:
project: query.ID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/createProjectWithOverride'].put
update:
x-apievangelist-phrasing:
intent: Create a project with an exchange rate override
effect: write
questions:
- Can I create a project and override its currency exchange rate?
- What is the way to create a project with a custom exchange rate?
instructions:
- text: Create project {project} using exchange rate {rate}.
slots:
project: query.project
rate: query.exchangeRate
- text: Set up a new project from {project} with an overridden currency rate of {rate}.
slots:
project: query.project
rate: query.exchangeRate
method: generated
generated: '2026-09-26'
- target: $.paths['/project/linkExternalObject'].put
update:
x-apievangelist-phrasing:
intent: Link an external document or object to a project
effect: write
questions:
- How do I link an item from an external integration to a project?
- Can I attach an external object URL to a project?
instructions:
- text: Link external object {linked} from {integration} to project {project}.
slots:
linked: query.linkedObjectID
integration: query.integrationType
project: query.objID
- text: Connect the URL {url} as an external link on project {project}.
slots:
url: query.URL
project: query.objID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/recallApproval'].put
update:
x-apievangelist-phrasing:
intent: Recall a submitted project approval
effect: write
questions:
- How do I pull back a project I submitted for approval?
- Can I withdraw a project approval request before anyone decides on it?
instructions:
- text: Recall the approval request for project {project}.
slots:
project: query.ID
- text: Withdraw project {project} from its approval process.
slots:
project: query.ID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/rejectApproval'].put
update:
x-apievangelist-phrasing:
intent: Reject a pending project approval
effect: write
questions:
- How do I reject a project that is awaiting my approval?
- Can I explain why a project approval was rejected in an audit note?
instructions:
- text: Reject the approval for project {project}.
slots:
project: query.ID
- text: Decline project {project} with the note {note}.
slots:
project: query.ID
note: query.auditNote
method: generated
generated: '2026-09-26'
- target: $.paths['/project/unlinkExternalObject'].put
update:
x-apievangelist-phrasing:
intent: Unlink an external object from a project
effect: write
questions:
- How do I remove an external integration link from a project?
- Can I detach a linked external document from a project?
instructions:
- text: Unlink external object {linked} from project {project}.
slots:
linked: query.linkedObjectID
project: query.objID
- text: Detach the {integration} item {linked} from project {project}.
slots:
integration: query.integrationType
linked: query.linkedObjectID
project: query.objID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/updateBusinessCaseSource'].put
update:
x-apievangelist-phrasing:
intent: Set the business case source for a project
effect: write
questions:
- How do I change where a project's business case comes from?
- Can I update the business case source on a project?
instructions:
- text: Set the business case source of project {project} to {source}.
slots:
project: query.projectID
source: query.source
- text: Change project {project}'s business case source.
slots:
project: query.projectID
method: generated
generated: '2026-09-26'
- target: $.paths['/project/defaultShownTimesheetProjects'].get
update:
x-apievangelist-phrasing:
intent: List projects shown by default on a timesheet
effect: read
questions:
- Which projects appear by default on my timesheet?
- Can I see the default project list for a given timesheet?
instructions:
- text: List the default projects shown on timesheet {timesheet}.
slots:
timesheet: query.timesheetID
- text: Show which projects my timesheet displays by default.
method: generated
generated: '2026-09-26'
- target: $.paths['/project/helpDeskQueues'].get
update:
x-apievangelist-phrasing:
intent: List projects set up as help desk queues
effect: read
questions:
- Which projects are configured as help desk request queues?
- Can I filter the list of help desk queues?
instructions:
- text: List all help desk queue projects.
- text: Show help desk queues matching {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/project/recentHelpDeskQueues'].get
update:
x-apievangelist-phrasing:
intent: List recently used help desk queues
effect: read
questions:
- Which help desk queues have I used most recently?
- Can I see my recent request queues filtered by criteria?
instructions:
- text: Show my recently used help desk queues.
- text: List recent request queues where {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'