Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Uiview API

22 actions 22 updates phrasing extends openapi/adobe-suite-uiview-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 22 · first 16 shown; the file carries all of them

$.info
$.paths['/uiview/{id}'].get
$.paths['/uiview/{id}'].put
$.paths['/uiview/{id}'].delete
$.paths['/uiview'].get
$.paths['/uiview'].put
$.paths['/uiview'].post
$.paths['/uiview'].delete
$.paths['/uiview/count'].get
$.paths['/uiview/search'].get
$.paths['/uiview/report'].get
$.paths['/uiview/{id}/share'].put
$.paths['/uiview/share'].put
$.paths['/uiview/{id}/unshare'].put
$.paths['/uiview/unshare'].put
$.paths['/uiview/{id}/sharePublic'].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 Uiview API
  version: 1.0.0
extends: openapi/adobe-suite-uiview-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: 21
- target: $.paths['/uiview/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single UI view
      effect: read
      questions:
      - How do I fetch one saved UI view by its ID in Workfront?
      - Can I choose which fields come back when I read a single UI view?
      instructions:
      - text: Show me UI view {id}.
        slots:
          id: path.id
      - text: Get UI view {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single UI view
      effect: write
      questions:
      - How can I change the settings of one existing UI view?
      - Is it possible to update a single view and get specific fields back afterwards?
      instructions:
      - text: Update UI view {id} with my new settings.
        slots:
          id: path.id
      - text: Edit UI view {id} and return the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single UI view
      effect: destructive
      questions:
      - How do I remove one UI view I no longer need?
      - Can I force-delete a UI view that won't delete normally?
      instructions:
      - text: Delete UI view {id}.
        slots:
          id: path.id
      - text: Force delete UI view {id} using force={force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several UI views by their IDs
      effect: read
      questions:
      - Can I load several UI views at once if I have their IDs?
      - What's the way to bulk-fetch a list of views in one call?
      instructions:
      - text: Fetch the UI views with IDs {id}.
        slots:
          id: query.id
      - text: Bulk get UI views {id} returning only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit multiple UI views
      effect: write
      questions:
      - How do I update many UI views in a single request?
      - Can I apply edits to a batch of views at once?
      instructions:
      - text: Apply these edits to all the UI views in my list in one bulk update.
      - text: Bulk edit my UI views and return the fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a UI view
      effect: write
      questions:
      - How do I create a new UI view in Workfront?
      - Can I make a new view by copying an existing one?
      instructions:
      - text: Create a new UI view from the definition I give you.
      - text: Create a UI view as a copy of view {copySourceID}.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete multiple UI views
      effect: destructive
      questions:
      - Can I delete several UI views in one call?
      - How do I clear out a batch of old views at once?
      instructions:
      - text: Delete the UI views with IDs {id}.
        slots:
          id: query.id
      - text: Force bulk-delete UI views {id} with force={force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count UI views matching filters
      effect: read
      questions:
      - How many UI views exist in our instance?
      - Can I count only the views that match certain filter conditions?
      instructions:
      - text: Count all UI views.
      - text: Count the UI views matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search UI views with filters
      effect: read
      questions:
      - How do I find UI views that match specific conditions?
      - Can I page and sort through UI view search results?
      instructions:
      - text: Search UI views where {filters}.
        slots:
          filters: query.filters
      - text: Search UI views matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over UI views
      effect: read
      questions:
      - Can I get an aggregated report of UI views instead of a raw list?
      - What does a report query over our views return?
      instructions:
      - text: Run a UI view report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Generate a UI view report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a UI view with a user or group
      effect: write
      questions:
      - How do I share one UI view with a specific user or team?
      - Can I share a view but forbid certain actions on it?
      instructions:
      - text: Share UI view {id} with {accessorObjCode} {accessorID} granting {coreAction}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Share view {id} with {accessorObjCode} {accessorID} as {coreAction} but forbid {forbiddenActions}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several UI views with an accessor at once
      effect: write
      questions:
      - Can I share a whole set of UI views with one user in a single call?
      - Is there a batch way to grant a team access to multiple views?
      instructions:
      - text: Share UI views {id} with {accessorObjCode} {accessorID} granting {coreAction}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch share views {id} to {accessorObjCode} {accessorID} as {coreAction}, forbidding {forbiddenActions}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a UI view with someone
      effect: destructive
      questions:
      - How do I revoke someone's access to one of my UI views?
      - Can I unshare a single view from just one user or group?
      instructions:
      - text: Unshare UI view {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Remove {accessorID}'s access to view {id} (accessor type {accessorObjCode}).
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Unshare several UI views from someone
      effect: destructive
      questions:
      - Can I revoke one user's access to many UI views at once?
      - How do I batch-remove a team from a set of shared views?
      instructions:
      - text: Unshare UI views {id} from {accessorObjCode} {accessorID}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Batch revoke {accessorID}'s access to views {id} (type {accessorObjCode}).
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a UI view publicly
      effect: write
      questions:
      - How do I make one UI view available to everyone?
      - Can a public share of a view restrict which actions people can take?
      instructions:
      - text: Publicly share UI view {id} with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make view {id} public as {coreAction} but forbid {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Publicly share several UI views at once
      effect: write
      questions:
      - Can I make a group of UI views public in a single request?
      - Is there a bulk public-share option for views?
      instructions:
      - text: Publicly share UI views {id} with {coreAction} access.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Batch make views {id} public as {coreAction}, forbidding {forbiddenActions}.
        slots:
          id: query.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove the public share from a UI view
      effect: destructive
      questions:
      - How do I make a public UI view private again?
      - Can I take one view out of public sharing without touching other shares?
      instructions:
      - text: Remove public sharing from UI view {id}.
        slots:
          id: path.id
      - text: Make view {id} no longer public.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public sharing from several UI views
      effect: destructive
      questions:
      - Can I un-publish a batch of public UI views at once?
      - What's the bulk way to stop sharing many views publicly?
      instructions:
      - text: Remove public sharing from UI views {id}.
        slots:
          id: query.id
      - text: Batch make views {id} private again.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/disableSystemWideVisibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn off system-wide visibility for views
      effect: write
      questions:
      - How do I stop certain UI views from being visible across the whole system?
      - Can I hide views system-wide by their IDs?
      instructions:
      - text: Disable system-wide visibility for views {viewIDs}.
        slots:
          viewIDs: query.viewIDs
      - text: Hide UI views {viewIDs} from system-wide display.
        slots:
          viewIDs: query.viewIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/enableSystemWideVisibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn on system-wide visibility for views
      effect: write
      questions:
      - How do I make specific UI views visible system-wide?
      - Can I enable views for everyone in the system by ID?
      instructions:
      - text: Enable system-wide visibility for views {viewIDs}.
        slots:
          viewIDs: query.viewIDs
      - text: Make UI views {viewIDs} visible across the whole system.
        slots:
          viewIDs: query.viewIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uiview/viewsForObjCode'].get
  update:
    x-apievangelist-phrasing:
      intent: List views available for an object type
      effect: read
      questions:
      - Which UI views are available for a given object type like projects or tasks?
      - What views can I pick from for a particular objCode?
      instructions:
      - text: List the UI views for object type {objCode}.
        slots:
          objCode: query.objCode
      - text: Show which views exist for {objCode} objects.
        slots:
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'