API Evangelist conversational phrasing for Adobe Workfront Uifilter API

# 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 Uifilter API
  version: 1.0.0
extends: openapi/adobe-suite-uifilter-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: 22
- target: $.paths['/uifilter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved UI filter by ID
      effect: read
      questions:
      - What conditions and settings does a specific saved filter in Workfront contain?
      - Can I choose which fields come back when I fetch one UI filter?
      instructions:
      - text: Show me UI filter {id}.
        slots:
          id: path.id
      - text: Fetch filter {id} and return only the {fields} fields.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved UI filter
      effect: write
      questions:
      - How do I change the definition of an existing saved filter?
      - Can I rename a UI filter that was already created?
      instructions:
      - text: Update UI filter {id} with my new filter rules.
        slots:
          id: path.id
      - text: Edit filter {id} and give me back {fields} after the change.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved UI filter
      effect: destructive
      questions:
      - How do I remove a saved filter I no longer need?
      - Is there a way to force-delete a single UI filter that is still in use?
      instructions:
      - text: Delete UI filter {id}.
        slots:
          id: path.id
      - text: Force-delete filter {id} with force set to {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several UI filters by their IDs
      effect: read
      questions:
      - Can I load multiple saved filters in a single request?
      - What's the way to fetch a batch of UI filters when I already have their IDs?
      instructions:
      - text: Get the UI filters with IDs {id}.
        slots:
          id: query.id
      - text: Fetch filters {id} in one call, returning fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update several UI filters
      effect: write
      questions:
      - Can I edit many saved filters at once instead of one by one?
      - Is there a bulk update for UI filters?
      instructions:
      - text: Apply these changes to all the UI filters in my list in one bulk edit.
      - text: Bulk-edit my UI filters and return the {fields} fields for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a UI filter
      effect: write
      questions:
      - How do I create a new saved filter for a list view?
      - Can I make a new UI filter by copying an existing one?
      instructions:
      - text: Create a new UI filter with these conditions.
      - text: Copy UI filter {copySourceID} into a brand-new filter.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several UI filters at once
      effect: destructive
      questions:
      - Can I delete a batch of saved filters in one request?
      - What happens if I bulk-delete filters with the force option?
      instructions:
      - text: Delete UI filters {id} in bulk.
        slots:
          id: query.id
      - text: Force-remove the filters {id} together, with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count UI filters matching criteria
      effect: read
      questions:
      - How many saved filters exist in our Workfront instance?
      - Can I count only the UI filters that match certain criteria?
      instructions:
      - text: Count all UI filters.
      - text: Count the UI filters matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search UI filters
      effect: read
      questions:
      - How do I find saved filters by name or owner?
      - Can I page through UI filter search results?
      instructions:
      - text: Search UI filters where {filters}.
        slots:
          filters: query.filters
      - text: Find UI filters matching {filters}, return fields {fields} and use list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over UI filters
      effect: read
      questions:
      - Can I get an aggregated, grouped report of saved filters?
      - Which call gives report-style output for UI filters rather than raw records?
      instructions:
      - text: Run a UI filter report for {filters}.
        slots:
          filters: query.filters
      - text: Build a report on UI filters with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a UI filter with a user or team
      effect: write
      questions:
      - How do I give a colleague access to one of my saved filters?
      - Can I share a filter with a team but forbid them from deleting it?
      instructions:
      - text: Share UI filter {id} with {accessorObjCode} {accessorID}, granting {coreAction} access.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Share filter {id} with {accessorObjCode} {accessorID} at {coreAction} level 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['/uifilter/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several UI filters at once
      effect: write
      questions:
      - Can I share a whole set of saved filters with the same team in one call?
      - Is there a batch way to grant view access to many UI filters?
      instructions:
      - text: Share UI filters {id} with {accessorObjCode} {accessorID} at {coreAction} access in one batch.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch-share filters {id} to accessor {accessorID} of type {accessorObjCode} with {coreAction} rights.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a UI filter with someone
      effect: destructive
      questions:
      - How do I revoke a colleague's access to my saved filter?
      - Can I remove a single team from one filter's sharing list?
      instructions:
      - text: Unshare UI filter {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke {accessorID}'s access to filter {id}; they are a {accessorObjCode}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke access to several UI filters
      effect: destructive
      questions:
      - Can I remove someone's access to many saved filters at once?
      - Is there a bulk unshare for UI filters?
      instructions:
      - text: Unshare UI filters {id} from {accessorObjCode} {accessorID} in one batch.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke access for accessor {accessorID} ({accessorObjCode}) across all of filters {id}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a UI filter public
      effect: write
      questions:
      - How do I make a saved filter available to everyone in the system?
      - Can a publicly shared filter be view-only for everybody?
      instructions:
      - text: Share UI filter {id} publicly with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make filter {id} public at {coreAction} level, forbidding {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make several UI filters public
      effect: write
      questions:
      - Can I publish a group of saved filters to all users in one step?
      - Is there a batch public-share option for UI filters?
      instructions:
      - text: Publicly share the UI filters {id} with {coreAction} access in one batch.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Make filters {id} public in bulk at {coreAction}, blocking {forbiddenActions}.
        slots:
          id: query.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public access from a UI filter
      effect: destructive
      questions:
      - How do I make a public saved filter private again?
      - Can I stop everyone from seeing a filter I shared publicly?
      instructions:
      - text: Remove public sharing from UI filter {id}.
        slots:
          id: path.id
      - text: Make filter {id} private again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public access from several UI filters
      effect: destructive
      questions:
      - Can I take a batch of public filters private at once?
      - Is there a bulk way to revoke public sharing on UI filters?
      instructions:
      - text: Remove public sharing from UI filters {id} in one batch.
        slots:
          id: query.id
      - text: Take filters {id} private again, all at once.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/addJoinForNullableFields'].put
  update:
    x-apievangelist-phrasing:
      intent: Add joins for nullable fields to a filter map
      effect: write
      questions:
      - Can I add joins for nullable fields to a filter map for a given object type?
      - What adjusts a UI filter map so nullable reference fields get joined?
      instructions:
      - text: Add joins for nullable fields to filter map {filterMap} for object type {objCode}.
        slots:
          filterMap: query.filterMap
          objCode: query.objCode
      - text: Adjust filter map {filterMap} so its nullable fields are joined.
        slots:
          filterMap: query.filterMap
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/disableSystemWideVisibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Hide UI filters system-wide
      effect: write
      questions:
      - How do I stop certain saved filters from being visible across the whole system?
      - Can I turn off system-wide visibility for several filters at once?
      instructions:
      - text: Disable system-wide visibility for filters {filterIDs}.
        slots:
          filterIDs: query.filterIDs
      - text: Hide UI filters {filterIDs} from everyone system-wide.
        slots:
          filterIDs: query.filterIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/enableSystemWideVisibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Make UI filters visible system-wide
      effect: write
      questions:
      - How do I make selected saved filters visible to everyone in the system?
      - Can I turn system-wide visibility back on for a set of filters?
      instructions:
      - text: Enable system-wide visibility for filters {filterIDs}.
        slots:
          filterIDs: query.filterIDs
      - text: Show UI filters {filterIDs} to everyone system-wide.
        slots:
          filterIDs: query.filterIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uifilter/filtersForObjCode'].get
  update:
    x-apievangelist-phrasing:
      intent: List UI filters available for an object type
      effect: read
      questions:
      - Which saved filters exist for a given object type like tasks or projects?
      - Can I narrow the filters for an object type by filter type?
      instructions:
      - text: List the UI filters for object type {objCode}.
        slots:
          objCode: query.objCode
      - text: Show the {filterType} filters available for {objCode}.
        slots:
          filterType: query.filterType
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'