Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Acknowledgement API
14 actions
14 updates
phrasing
extends
openapi/adobe-suite-acknowledgement-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 14
$.info
$.paths['/acknowledgement/{id}'].get
$.paths['/acknowledgement/{id}'].put
$.paths['/acknowledgement/{id}'].delete
$.paths['/acknowledgement'].get
$.paths['/acknowledgement'].put
$.paths['/acknowledgement'].post
$.paths['/acknowledgement'].delete
$.paths['/acknowledgement/count'].get
$.paths['/acknowledgement/search'].get
$.paths['/acknowledgement/report'].get
$.paths['/acknowledgement/acknowledge'].put
$.paths['/acknowledgement/acknowledgeMany'].put
$.paths['/acknowledgement/unacknowledge'].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 Acknowledgement API
version: 1.0.0
extends: openapi/adobe-suite-acknowledgement-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: 13
- target: $.paths['/acknowledgement/{id}'].get
update:
x-apievangelist-phrasing:
intent: Look up one acknowledgement record
effect: read
questions:
- How do I fetch a single acknowledgement record in Workfront by ID?
- Can I limit which fields come back for one acknowledgement?
instructions:
- text: Show acknowledgement {id}.
slots:
id: path.id
- text: Get acknowledgement {id} with fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update one acknowledgement record
effect: write
questions:
- Can I edit an existing acknowledgement record directly?
- What's the call to change a single acknowledgement by its ID?
instructions:
- text: Edit acknowledgement {id} with my changes.
slots:
id: path.id
- text: Update acknowledgement {id} and return {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one acknowledgement record
effect: destructive
questions:
- How do I delete a single acknowledgement record?
- Is there a force flag for deleting an acknowledgement?
instructions:
- text: Delete acknowledgement {id}.
slots:
id: path.id
- text: Force delete acknowledgement {id} with force={force}.
slots:
id: path.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement'].get
update:
x-apievangelist-phrasing:
intent: Fetch several acknowledgements by ID
effect: read
questions:
- Can I pull a batch of acknowledgement records if I have their IDs?
- Which call returns multiple known acknowledgements in one request?
instructions:
- text: Fetch acknowledgements {id}.
slots:
id: query.id
- text: Get the acknowledgement records {id} showing only {fields}.
slots:
id: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement'].put
update:
x-apievangelist-phrasing:
intent: Update many acknowledgement records at once
effect: write
questions:
- Is there a bulk edit for acknowledgement records?
- Can I change a set of acknowledgements in a single request?
instructions:
- text: Bulk edit these acknowledgement records with my changes.
- text: Apply updates to several acknowledgements and return {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement'].post
update:
x-apievangelist-phrasing:
intent: Create an acknowledgement record
effect: write
questions:
- How do I create a new acknowledgement record directly?
- What does the raw acknowledgement create call return?
instructions:
- text: Create a new acknowledgement record from the details I give.
- text: Add an acknowledgement record and return {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement'].delete
update:
x-apievangelist-phrasing:
intent: Delete many acknowledgement records
effect: destructive
questions:
- Can I bulk delete acknowledgement records by ID?
- Is there a way to remove several acknowledgements in one call?
instructions:
- text: Delete acknowledgements {id}.
slots:
id: query.id
- text: Bulk force delete acknowledgement records {id} with force={force}.
slots:
id: query.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/count'].get
update:
x-apievangelist-phrasing:
intent: Count acknowledgement records
effect: read
questions:
- How many acknowledgement records match a filter?
- Can I get a count of acknowledgements without listing them?
instructions:
- text: Count acknowledgements matching {filters}.
slots:
filters: query.filters
- text: Tell me how many acknowledgement records exist.
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/search'].get
update:
x-apievangelist-phrasing:
intent: Search acknowledgement records
effect: read
questions:
- How do I find acknowledgements for a particular object or user?
- Can I search acknowledgement records with filters and paging?
instructions:
- text: Search acknowledgements where {filters}.
slots:
filters: query.filters
- text: Find acknowledgement records matching {filters} with list options {listOptions}.
slots:
filters: query.filters
listOptions: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/report'].get
update:
x-apievangelist-phrasing:
intent: Run an aggregate report on acknowledgements
effect: read
questions:
- Can I get grouped totals of acknowledgements rather than a list?
- What gives me a report-style summary of acknowledgement records?
instructions:
- text: Run an acknowledgement report filtered by {filters}.
slots:
filters: query.filters
- text: Summarize acknowledgements as a report using {listOptions}.
slots:
listOptions: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/acknowledge'].put
update:
x-apievangelist-phrasing:
intent: Acknowledge an update or object
effect: write
questions:
- How do I mark a notification or update as acknowledged?
- Can I acknowledge a specific object, like an issue, by its type and ID?
instructions:
- text: Acknowledge {objCode} {objID}.
slots:
objCode: query.objCode
objID: query.objID
- text: Mark object {objID} as acknowledged.
slots:
objID: query.objID
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/acknowledgeMany'].put
update:
x-apievangelist-phrasing:
intent: Acknowledge several objects at once
effect: write
questions:
- Can I acknowledge a whole batch of updates in one call?
- Is there a way to clear many unacknowledged items together?
instructions:
- text: 'Acknowledge all of these objects: {objCodeIDs}.'
slots:
objCodeIDs: query.objCodeIDs
- text: Mark {objCodeIDs} acknowledged in one go.
slots:
objCodeIDs: query.objCodeIDs
method: generated
generated: '2026-09-26'
- target: $.paths['/acknowledgement/unacknowledge'].put
update:
x-apievangelist-phrasing:
intent: Undo an acknowledgement
effect: write
questions:
- I acknowledged something by mistake — can I unacknowledge it?
- How do I mark an object as not acknowledged again?
instructions:
- text: Unacknowledge {objCode} {objID}.
slots:
objCode: query.objCode
objID: query.objID
- text: Remove my acknowledgement from object {objID}.
slots:
objID: query.objID
method: generated
generated: '2026-09-26'