# 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 Uigroupby API
  version: 1.0.0
extends: openapi/adobe-suite-uigroupby-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: 20
- target: $.paths['/uigroupby/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one list grouping
      effect: read
      questions:
      - How do I read the definition of one saved grouping used in Workfront lists?
      - Can I choose which fields come back for a single grouping?
      instructions:
      - text: Show grouping {id}.
        slots:
          id: path.id
      - text: Get UI grouping {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one list grouping
      effect: write
      questions:
      - What's the call to change how an existing grouping organizes list rows?
      - Can I rename or adjust a single saved grouping?
      instructions:
      - text: Edit grouping {id} with the changes I describe.
        slots:
          id: path.id
      - text: Update UI grouping {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one list grouping
      effect: destructive
      questions:
      - Can I delete a grouping nobody uses anymore?
      - Is there a force flag for removing a single grouping?
      instructions:
      - text: Delete grouping {id}.
        slots:
          id: path.id
      - text: Remove UI grouping {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several list groupings by ID
      effect: read
      questions:
      - Can I load multiple groupings at once when I have their IDs?
      - Which call returns a batch of known list groupings?
      instructions:
      - text: Fetch groupings {id}.
        slots:
          id: query.id
      - text: Get the UI groupings {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many list groupings at once
      effect: write
      questions:
      - How do I bulk edit several groupings in one request?
      - Can I apply the same change to a set of groupings together?
      instructions:
      - text: Apply these edits to every grouping I list.
      - text: Bulk update the UI groupings and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a list grouping
      effect: write
      questions:
      - How do I create a new grouping for organizing list views?
      - Can I make a new grouping by copying an existing one?
      instructions:
      - text: Create a new UI grouping with the settings I give you.
      - text: Copy grouping {copySourceID} into a new grouping.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many list groupings at once
      effect: destructive
      questions:
      - Can I bulk delete a list of groupings by ID?
      - What removes several groupings in a single call?
      instructions:
      - text: Bulk delete groupings {id}.
        slots:
          id: query.id
      - text: Remove every UI grouping in {id} using force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count list groupings
      effect: read
      questions:
      - How many groupings match a given filter?
      - Can I get just the total of saved groupings?
      instructions:
      - text: Count groupings where {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many UI groupings exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search list groupings
      effect: read
      questions:
      - What's the way to find groupings by name or object type?
      - Can I search groupings with paging and sort options?
      instructions:
      - text: Search groupings matching {filters}.
        slots:
          filters: query.filters
      - text: Find UI groupings where {filters} and list {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on list groupings
      effect: read
      questions:
      - Can I get grouped totals of groupings as a report?
      - Which call gives a report-style summary of UI groupings?
      instructions:
      - text: Run a grouping report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Summarize UI groupings as a report with {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share one list grouping with a user or team
      effect: write
      questions:
      - How do I let a teammate use one of my saved groupings?
      - Can I share a grouping with view rights but forbid certain actions?
      instructions:
      - text: Share grouping {id} with {accessorObjCode} {accessorID} at {coreAction} access.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Grant {accessorID} {coreAction} on grouping {id} but forbid {forbiddenActions}.
        slots:
          accessorID: query.accessorID
          coreAction: query.coreAction
          id: path.id
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several list groupings at once
      effect: write
      questions:
      - Can I share a set of groupings with the same person in one request?
      - Is there a batch call to grant access to multiple groupings?
      instructions:
      - text: Share groupings {id} with {accessorObjCode} {accessorID} as {coreAction}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch share UI groupings {id} to {accessorID} with {coreAction} rights.
        slots:
          id: query.id
          accessorID: query.accessorID
          coreAction: query.coreAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove someone's access to one list grouping
      effect: destructive
      questions:
      - How do I stop sharing a grouping with a particular user?
      - Can I revoke a team's access to a single grouping?
      instructions:
      - text: Unshare grouping {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke {accessorID}'s access to UI grouping {id}.
        slots:
          accessorID: query.accessorID
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove access to several list groupings
      effect: destructive
      questions:
      - Can I pull one user's access from many groupings in a single call?
      - Which call batch-revokes sharing across a list of groupings?
      instructions:
      - text: Unshare groupings {id} from {accessorObjCode} {accessorID}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Batch revoke {accessorID} from every UI grouping in {id}.
        slots:
          accessorID: query.accessorID
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make one list grouping publicly shared
      effect: write
      questions:
      - Can I make one grouping public for everyone in the organization?
      - Is it possible to publicly share a grouping while blocking some actions?
      instructions:
      - text: Share grouping {id} publicly with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make UI grouping {id} public as {coreAction}, forbidding {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make several list groupings publicly shared
      effect: write
      questions:
      - Can I publish a whole set of groupings publicly in one request?
      - What's the batch call for public sharing of many groupings?
      instructions:
      - text: Publicly share groupings {id} with {coreAction} access.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Batch publish UI groupings {id} as {coreAction} but block {forbiddenActions}.
        slots:
          id: query.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove the public share from one list grouping
      effect: destructive
      questions:
      - What takes a single grouping out of public view?
      - Can I turn off public sharing on just one grouping?
      instructions:
      - text: Remove the public share from grouping {id}.
        slots:
          id: path.id
      - text: Make UI grouping {id} private again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public shares from several list groupings
      effect: destructive
      questions:
      - Can I switch off public sharing for many groupings at once?
      - Which call batch-removes public access from a list of groupings?
      instructions:
      - text: Remove public sharing from groupings {id}.
        slots:
          id: query.id
      - text: Take UI groupings {id} out of public view in one batch.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/disableSystemWideVisibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Hide groupings from everyone system-wide
      effect: write
      questions:
      - How do I stop certain groupings from appearing for all users?
      - Can I turn off system-wide visibility for a set of groupings?
      instructions:
      - text: Disable system-wide visibility for groupings {groupByIDs}.
        slots:
          groupByIDs: query.groupByIDs
      - text: Hide groupings {groupByIDs} from every user's list options.
        slots:
          groupByIDs: query.groupByIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uigroupby/enableSystemWideVisibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Show groupings to everyone system-wide
      effect: write
      questions:
      - Is there a way to make certain groupings available to all users?
      - Can I turn on system-wide visibility for selected groupings?
      instructions:
      - text: Enable system-wide visibility for groupings {groupByIDs}.
        slots:
          groupByIDs: query.groupByIDs
      - text: Make groupings {groupByIDs} visible to every user in the system.
        slots:
          groupByIDs: query.groupByIDs
      method: generated
      generated: '2026-09-26'