Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Group API

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

$.info
$.paths['/group/{id}'].get
$.paths['/group/{id}'].put
$.paths['/group/{id}'].delete
$.paths['/group'].get
$.paths['/group'].put
$.paths['/group'].post
$.paths['/group'].delete
$.paths['/group/replace'].put
$.paths['/group/count'].get
$.paths['/group/search'].get
$.paths['/group/report'].get
$.paths['/group/{id}/share'].put
$.paths['/group/share'].put
$.paths['/group/{id}/unshare'].put
$.paths['/group/unshare'].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 Group API
  version: 1.0.0
extends: openapi/adobe-suite-group-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: 32
- target: $.paths['/group/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one Workfront group
      effect: read
      questions:
      - What details can I see for a single Workfront group?
      - Can I pick which fields come back when I fetch one group by its ID?
      instructions:
      - text: Show me group {id}.
        slots:
          id: path.id
      - text: Get group {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single group
      effect: write
      questions:
      - How do I change the name or settings of one group?
      - Can I update a single group and get back just certain fields?
      instructions:
      - text: Update group {id} with the changes I give you.
        slots:
          id: path.id
      - text: Edit group {id} and return {fields} afterward.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single group
      effect: destructive
      questions:
      - Can I delete one group that is no longer used?
      - Is there a force option when removing a group that has dependencies?
      instructions:
      - text: Delete group {id}.
        slots:
          id: path.id
      - text: Force delete group {id} even if it is still referenced.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several groups by ID at once
      effect: read
      questions:
      - Can I retrieve a batch of groups in one call when I already know their IDs?
      - What is the quickest way to pull details for a handful of specific groups?
      instructions:
      - text: Get the groups with IDs {id}.
        slots:
          id: query.id
      - text: Fetch groups {id} returning only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many groups in one request
      effect: write
      questions:
      - Can I bulk update multiple groups in a single request?
      - Is there a way to apply the same edit across several groups together?
      instructions:
      - text: Bulk edit these groups with the changes I list.
      - text: Apply my updates to several groups at once and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a group
      effect: write
      questions:
      - How do I create a new group in Workfront?
      - Can I make a new group by copying an existing one?
      instructions:
      - text: Create a new group from the details I provide.
      - text: Create a group as a copy of group {copySourceID}.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several groups at once
      effect: destructive
      questions:
      - Can I remove a batch of groups in one call?
      - How would I bulk delete groups that are still referenced elsewhere?
      instructions:
      - text: Delete the groups {id}.
        slots:
          id: query.id
      - text: Force delete groups {id} in one go.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/replace'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace groups with another group
      effect: destructive
      questions:
      - Can I swap out old groups so their references point to a different group?
      - What happens to groups I replace with a single replacement group?
      instructions:
      - text: Replace groups {id} with group {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      - text: Merge the groups {id} into {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count groups matching a filter
      effect: read
      questions:
      - How many groups exist in our Workfront instance?
      - Can I get just a count of groups that match certain conditions?
      instructions:
      - text: Count all groups.
      - text: Count the groups matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search groups with filters
      effect: read
      questions:
      - Can I search groups by name or other conditions?
      - Which groups match a filter, and can I page through the results?
      instructions:
      - text: Search groups where {filters}.
        slots:
          filters: query.filters
      - text: Find groups matching {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over groups
      effect: read
      questions:
      - Can I get an aggregated report of groups instead of a plain list?
      - What does a group report return when I group or summarize results?
      instructions:
      - text: Run a group report.
      - text: Generate a report of groups filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a group with a user or team
      effect: write
      questions:
      - How do I give another user access to a group?
      - Can I share a group but forbid certain actions?
      instructions:
      - text: Share group {id} with {accessorObjCode} {accessorID} at access level {coreAction}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Grant {accessorID} {coreAction} on group {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['/group/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several groups with one accessor
      effect: write
      questions:
      - Can I share many groups with the same person in one request?
      - Is batch sharing of groups supported?
      instructions:
      - text: Share groups {id} with {accessorObjCode} {accessorID} as {coreAction}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch grant {coreAction} access on groups {id} to {accessorID}.
        slots:
          coreAction: query.coreAction
          id: query.id
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a group with someone
      effect: destructive
      questions:
      - How do I revoke someone's access to a group I shared?
      - Can I unshare one group from a specific team?
      instructions:
      - text: Unshare group {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Remove {accessorID}'s access to group {id}.
        slots:
          accessorID: query.accessorID
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke access to several groups
      effect: destructive
      questions:
      - Can I unshare a whole set of groups from one user at once?
      - Is there a batch way to pull someone's access from multiple groups?
      instructions:
      - text: Unshare groups {id} from {accessorObjCode} {accessorID}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke {accessorID}'s access across groups {id}.
        slots:
          accessorID: query.accessorID
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a group publicly
      effect: write
      questions:
      - Can I make a group visible to everyone?
      - How do I publicly share one group with a set access level?
      instructions:
      - text: Publicly share group {id} with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make group {id} public at {coreAction} but forbid {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several groups publicly
      effect: write
      questions:
      - Can I make many groups public in a single call?
      - What access level applies when I publicly share a batch of groups?
      instructions:
      - text: Publicly share groups {id} with {coreAction} access.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Make groups {id} public at access level {coreAction}.
        slots:
          id: query.id
          coreAction: query.coreAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove a group's public share
      effect: destructive
      questions:
      - How do I make a public group private again?
      - Can I turn off public sharing for one group?
      instructions:
      - text: Remove public sharing from group {id}.
        slots:
          id: path.id
      - text: Make group {id} no longer public.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public sharing from groups
      effect: destructive
      questions:
      - Can I take several groups out of public sharing at once?
      - Is there a bulk way to stop publicly sharing groups?
      instructions:
      - text: Remove public sharing from groups {id}.
        slots:
          id: query.id
      - text: Make groups {id} private again in one call.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/addRemoveLicenseTypeLimits'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or remove license type limits on groups
      effect: write
      questions:
      - Can I turn license type limits on for some groups and off for others?
      - Which groups have license limits enforced, and can I change that in bulk?
      instructions:
      - text: Add license type limits to groups {addGroupIDs}.
        slots:
          addGroupIDs: query.addGroupIDs
      - text: Remove license type limits from groups {removeGroupIDs}.
        slots:
          removeGroupIDs: query.removeGroupIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/addSubgroups'].put
  update:
    x-apievangelist-phrasing:
      intent: Add subgroups under a group
      effect: write
      questions:
      - How do I nest groups under a parent group?
      - Can I attach several existing groups as subgroups in one step?
      instructions:
      - text: Add groups {newSubgroupIDs} as subgroups of group {ID}.
        slots:
          newSubgroupIDs: query.newSubgroupIDs
          ID: query.ID
      - text: Nest {newSubgroupIDs} under parent group {ID}.
        slots:
          newSubgroupIDs: query.newSubgroupIDs
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/assignMultiple'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign users and roles to a group
      effect: write
      questions:
      - Can I assign several users with job roles to a group at once?
      - Is it possible to add people to a group together with a team assignment?
      instructions:
      - text: Assign users {userIDs} to group {ID}.
        slots:
          userIDs: query.userIDs
          ID: query.ID
      - text: Assign users {userIDs} with roles {roleIDs} and team {teamID} to group {ID}.
        slots:
          userIDs: query.userIDs
          roleIDs: query.roleIDs
          teamID: query.teamID
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/calculateDataExtension'].put
  update:
    x-apievangelist-phrasing:
      intent: Recalculate a group's custom data
      effect: write
      questions:
      - Can I force the calculated custom fields on a group to refresh?
      - How do I recompute custom form data for a group?
      instructions:
      - text: Recalculate the custom data on group {ID}.
        slots:
          ID: query.ID
      - text: Refresh calculated custom fields for group {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/checkDelete'].put
  update:
    x-apievangelist-phrasing:
      intent: Check whether groups can be deleted
      effect: read
      questions:
      - Before removing groups, can I check whether deleting them is allowed?
      - What would block a group from being deleted?
      instructions:
      - text: Check if groups {ids} can be deleted.
        slots:
          ids: query.ids
      - text: Run a delete check on groups {ids} before I remove them.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/completeGroupInfo'].put
  update:
    x-apievangelist-phrasing:
      intent: Get complete information for a group
      effect: read
      questions:
      - Can I pull the full, complete information for one group?
      - Where do I get everything Workfront knows about a group in one response?
      instructions:
      - text: Get the complete info for group {groupId}.
        slots:
          groupId: query.groupId
      - text: Show all information on group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/getGroupMembers'].put
  update:
    x-apievangelist-phrasing:
      intent: List the members of a group
      effect: read
      questions:
      - Who are the members of a particular group?
      - Can I list every user who belongs to a group?
      instructions:
      - text: List the members of group {ID}.
        slots:
          ID: query.ID
      - text: Show who belongs to group {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/getParents'].put
  update:
    x-apievangelist-phrasing:
      intent: List a group's parent groups
      effect: read
      questions:
      - Which parent groups sit above a given subgroup?
      - Can I see the group hierarchy upward from one group?
      instructions:
      - text: Get the parent groups of group {ID}.
        slots:
          ID: query.ID
      - text: Show the hierarchy above group {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/linkExternalObject'].put
  update:
    x-apievangelist-phrasing:
      intent: Link a group to an external object
      effect: write
      questions:
      - Can I link a Workfront group to an object in an external integration?
      - What do I need to connect a group to an external system record by URL?
      instructions:
      - text: Link group {objID} to external object {linkedObjectID} via {integrationType}.
        slots:
          objID: query.objID
          linkedObjectID: query.linkedObjectID
          integrationType: query.integrationType
      - text: Link group {objID} to the external item at {URL}.
        slots:
          objID: query.objID
          URL: query.URL
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/replaceDeleteGroups'].put
  update:
    x-apievangelist-phrasing:
      intent: Delete groups and reassign to a replacement
      effect: destructive
      questions:
      - Can I delete groups and move everything they owned to another group?
      - What replacement group takes over when I delete groups this way?
      instructions:
      - text: Delete groups {ids} and hand their references to group {replaceGroupID}.
        slots:
          ids: query.ids
          replaceGroupID: query.replaceGroupID
      - text: Remove groups {ids}, replacing them with {replaceGroupID}.
        slots:
          ids: query.ids
          replaceGroupID: query.replaceGroupID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/setLicenseTypeLimit'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a license type limit for a group
      effect: write
      questions:
      - Can I cap how many licenses of a certain type a group may use?
      - How do I set the limit for a license type on one group?
      instructions:
      - text: Set the {licenseType} license limit on group {groupID} to {ltLimit}.
        slots:
          licenseType: query.licenseType
          groupID: query.groupID
          ltLimit: query.ltLimit
      - text: Limit group {groupID} to {ltLimit} licenses.
        slots:
          groupID: query.groupID
          ltLimit: query.ltLimit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/unlinkExternalObject'].put
  update:
    x-apievangelist-phrasing:
      intent: Unlink a group from an external object
      effect: destructive
      questions:
      - How do I disconnect a group from an external integration object?
      - Can I remove an external link from a group?
      instructions:
      - text: Unlink group {objID} from external object {linkedObjectID}.
        slots:
          objID: query.objID
          linkedObjectID: query.linkedObjectID
      - text: Remove the {integrationType} link on group {objID}.
        slots:
          integrationType: query.integrationType
          objID: query.objID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/updateMembersList'].put
  update:
    x-apievangelist-phrasing:
      intent: Add and remove group members
      effect: write
      questions:
      - Can I add some members and remove others from a group in one update?
      - How do I change a group's membership list?
      instructions:
      - text: Add users {newMemberIDs} to group {ID}.
        slots:
          newMemberIDs: query.newMemberIDs
          ID: query.ID
      - text: Remove users {removedMemberIDs} from group {ID}.
        slots:
          removedMemberIDs: query.removedMemberIDs
          ID: query.ID
      method: generated
      generated: '2026-09-26'