Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Agilework API
11 actions
11 updates
phrasing
extends
openapi/adobe-suite-agilework-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 11
$.info
$.paths['/agilework/{id}'].get
$.paths['/agilework/{id}'].put
$.paths['/agilework/{id}'].delete
$.paths['/agilework'].get
$.paths['/agilework'].put
$.paths['/agilework'].delete
$.paths['/agilework/count'].get
$.paths['/agilework/search'].get
$.paths['/agilework/report'].get
$.paths['/agilework/bulkCopy'].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 Agilework API
version: 1.0.0
extends: openapi/adobe-suite-agilework-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: 10
- target: $.paths['/agilework/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one agile work item
effect: read
questions:
- How do I look up a single agile work item in Workfront by its ID?
- Can I choose which fields return for one agile work record?
instructions:
- text: Get agile work item {id}.
slots:
id: path.id
- text: Fetch agile work {id} with only the fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework/{id}'].put
update:
x-apievangelist-phrasing:
intent: Edit an agile work item
effect: write
questions:
- Can I change the details of one existing agile work item?
- What call updates a single agile work record and returns chosen fields?
instructions:
- text: Edit agile work item {id} with the changes I give you.
slots:
id: path.id
- text: Update agile work {id} and return its {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an agile work item
effect: destructive
questions:
- How do I remove one agile work item?
- Is there a force option when deleting a single agile work record?
instructions:
- text: Delete agile work item {id}.
slots:
id: path.id
- text: Force-delete agile work {id} with force {force}.
slots:
id: path.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework'].get
update:
x-apievangelist-phrasing:
intent: Get several agile work items by ID
effect: read
questions:
- Can I fetch a batch of agile work items when I have their IDs?
- What's the way to load multiple agile work records in one call?
instructions:
- text: Get the agile work items with IDs {ids}.
slots:
ids: query.id
- text: Bulk-fetch agile work records {ids} returning {fields}.
slots:
ids: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework'].put
update:
x-apievangelist-phrasing:
intent: Edit many agile work items at once
effect: write
questions:
- Can I update a whole set of agile work items in one request?
- Is bulk editing supported for agile work records?
instructions:
- text: Bulk edit the agile work items I list with the changes I provide.
- text: Apply my edits to several agile work records and return {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework'].delete
update:
x-apievangelist-phrasing:
intent: Delete several agile work items
effect: destructive
questions:
- Can I delete a batch of agile work items in one go?
- What happens when I force a bulk delete of agile work records?
instructions:
- text: Delete the agile work items {ids}.
slots:
ids: query.id
- text: Bulk force-delete agile work records {ids} with force {force}.
slots:
ids: query.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework/count'].get
update:
x-apievangelist-phrasing:
intent: Count agile work items
effect: read
questions:
- How many agile work items are there?
- Can I count only agile work matching a filter?
instructions:
- text: Count all agile work items.
- text: Tell me how many agile work records match {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework/search'].get
update:
x-apievangelist-phrasing:
intent: Search agile work items
effect: read
questions:
- How can I find agile work items that meet certain conditions?
- Can an agile work search be sorted or paged?
instructions:
- text: Search agile work items matching {filters}.
slots:
filters: query.filters
- text: Find agile work where {filters}, returning {fields} with list options {listOptions}.
slots:
filters: query.filters
fields: query.fields
listOptions: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework/report'].get
update:
x-apievangelist-phrasing:
intent: Run a report on agile work items
effect: read
questions:
- Can I produce an aggregated report of agile work?
- What report data can I pull on agile work filtered by conditions?
instructions:
- text: Run an agile work report filtered by {filters}.
slots:
filters: query.filters
- text: Build an agile work report with list options {listOptions}.
slots:
listOptions: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/agilework/bulkCopy'].put
update:
x-apievangelist-phrasing:
intent: Copy several agile work items
effect: write
questions:
- Can I duplicate a batch of agile work items in one request?
- Which options can I pass when bulk-copying agile work?
instructions:
- text: Copy agile work items {agileWorkIDs}.
slots:
agileWorkIDs: query.agileWorkIDs
- text: Bulk-copy agile work {agileWorkIDs} using options {options}.
slots:
agileWorkIDs: query.agileWorkIDs
options: query.options
method: generated
generated: '2026-09-26'