# 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 Category API
  version: 1.0.0
extends: openapi/adobe-suite-category-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: 25
- target: $.paths['/category/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single custom form category
      effect: read
      questions:
      - What does one custom form category in Workfront look like when I fetch it by ID?
      - Can I choose which fields come back when I look up a single category?
      instructions:
      - text: Show me category {id}.
        slots:
          id: path.id
      - text: Fetch category {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single category
      effect: write
      questions:
      - How can I change the settings of one existing category?
      - Is it possible to edit a category and get specific fields back in the response?
      instructions:
      - text: Edit category {id}.
        slots:
          id: path.id
      - text: Update category {id} and return {fields} afterwards.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single category
      effect: destructive
      questions:
      - How do I remove one category I no longer use?
      - Can I force-delete a category that is still attached to objects?
      instructions:
      - text: Delete category {id}.
        slots:
          id: path.id
      - text: Force delete category {id} even if it is in use.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several categories by ID at once
      effect: read
      questions:
      - Can I fetch a handful of categories in one call by passing their IDs?
      - What is the quickest way to load multiple known categories together?
      instructions:
      - text: Get the categories with IDs {id}.
        slots:
          id: query.id
      - text: Bulk fetch categories {id} returning just {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many categories in one request
      effect: write
      questions:
      - Is there a way to update several categories in a single bulk request?
      - Can I apply the same change to a batch of categories at once?
      instructions:
      - text: Bulk edit the categories I send in one request.
      - text: Apply my edits to multiple categories and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a category
      effect: write
      questions:
      - How do I create a new custom form category?
      - Can I make a new category by copying an existing one?
      instructions:
      - text: Create a new category.
      - text: Create a category as a copy of category {copySourceID}.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several categories at once
      effect: destructive
      questions:
      - Can I delete a batch of categories in one go by listing their IDs?
      - What happens if I bulk delete categories with force turned on?
      instructions:
      - text: Delete the categories {id} in bulk.
        slots:
          id: query.id
      - text: Bulk force-delete categories {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count categories matching a filter
      effect: read
      questions:
      - How many categories exist in our Workfront instance?
      - Can I count only the categories that match certain filters?
      instructions:
      - text: Count all categories.
      - text: Count the categories matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search categories with filters
      effect: read
      questions:
      - How do I search categories by name or other field values?
      - Can I page through category search results and pick the returned fields?
      instructions:
      - text: Search categories where {filters}.
        slots:
          filters: query.filters
      - text: Find categories matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on categories
      effect: read
      questions:
      - Can I get grouped or aggregated report data about categories?
      - What does a category report return compared to a plain search?
      instructions:
      - text: Run a category report.
      - text: Report on categories filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a category with a user or team
      effect: write
      questions:
      - How do I give a specific user or team access to one category?
      - Can I share a category but forbid certain actions like delete?
      instructions:
      - text: Share category {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 category {id} but forbid {forbiddenActions}.
        slots:
          id: path.id
          accessorID: query.accessorID
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share many categories with one accessor
      effect: write
      questions:
      - Can I share several categories with the same person in one request?
      - Is there a batch way to grant a team access to multiple categories?
      instructions:
      - text: Share categories {id} with {accessorObjCode} {accessorID} at {coreAction} access.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch grant {coreAction} on categories {id} to {accessorID}.
        slots:
          id: query.id
          coreAction: query.coreAction
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove someone's access to a category
      effect: destructive
      questions:
      - How do I stop sharing one category with a particular user?
      - Can I revoke a team's access to a single category?
      instructions:
      - text: Unshare category {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke {accessorID}'s access to category {id}.
        slots:
          id: path.id
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove access to many categories at once
      effect: destructive
      questions:
      - Can I revoke one user's access to several categories in a single call?
      - What's the batch way to unshare a group of categories?
      instructions:
      - text: Unshare categories {id} from {accessorObjCode} {accessorID}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Batch revoke {accessorID}'s access to categories {id}.
        slots:
          id: query.id
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a category publicly shared
      effect: write
      questions:
      - How do I share one category publicly with everyone?
      - Can I make a category public while still blocking some actions?
      instructions:
      - text: Share category {id} publicly with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make category {id} public at {coreAction} access, forbidding {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make many categories public at once
      effect: write
      questions:
      - Can I publicly share a set of categories in one batch request?
      - Is there a bulk option to make several categories public?
      instructions:
      - text: Publicly share categories {id} with {coreAction} access.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Batch make categories {id} public at {coreAction}.
        slots:
          id: query.id
          coreAction: query.coreAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn off public sharing on a category
      effect: destructive
      questions:
      - How do I stop a single category from being publicly shared?
      - Can I make a public category private again?
      instructions:
      - text: Remove public sharing from category {id}.
        slots:
          id: path.id
      - text: Make category {id} private again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn off public sharing on many categories
      effect: destructive
      questions:
      - Can I remove public access from several categories in one request?
      - What's the bulk way to make a list of public categories private?
      instructions:
      - text: Remove public sharing from categories {id}.
        slots:
          id: query.id
      - text: Batch make categories {id} private.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/assignCategories'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach several custom forms to an object
      effect: write
      questions:
      - How do I attach multiple custom forms to a project or task at once?
      - Can I assign a list of categories to one object in a single call?
      instructions:
      - text: Attach categories {categoryIDs} to {objCode} {objID}.
        slots:
          categoryIDs: query.categoryIDs
          objCode: query.objCode
          objID: query.objID
      - text: Assign custom forms {categoryIDs} to object {objID}.
        slots:
          categoryIDs: query.categoryIDs
          objID: query.objID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/assignCategory'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach one custom form to an object
      effect: write
      questions:
      - How do I attach a single custom form to a specific task or project?
      - Can I add one category to an object without touching its other forms?
      instructions:
      - text: Attach category {categoryID} to {objCode} {objID}.
        slots:
          categoryID: query.categoryID
          objCode: query.objCode
          objID: query.objID
      - text: Add custom form {categoryID} to object {objID}.
        slots:
          categoryID: query.categoryID
          objID: query.objID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/getCascadingRules'].put
  update:
    x-apievangelist-phrasing:
      intent: Get cascading field rules for categories
      effect: read
      questions:
      - Which cascading parameter rules apply when certain custom forms are on an object?
      - Can I preview the cascading rules for categories inside a given project?
      instructions:
      - text: Get the cascading rules for categories {categoryIDs} on {objCode} {objID}.
        slots:
          categoryIDs: query.categoryIDs
          objCode: query.objCode
          objID: query.objID
      - text: Show cascading rules for categories {categoryIDs} in project {projectID}.
        slots:
          categoryIDs: query.categoryIDs
          projectID: query.projectID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/isObjectFrozenInPendingApprovalStatus'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if an object is frozen pending approval
      effect: read
      questions:
      - Is this object locked because it is waiting on an approval?
      - Can I tell whether a task's custom forms are frozen during pending approval?
      instructions:
      - text: Check whether {objCode} {objID} is frozen in pending approval.
        slots:
          objCode: query.objCode
          objID: query.objID
      - text: Tell me if object {objID} is locked awaiting approval.
        slots:
          objID: query.objID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/reorderCategories'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder the custom forms on an object
      effect: write
      questions:
      - How do I change the order custom forms appear in on a project?
      - Can I rearrange the categories attached to an object?
      instructions:
      - text: Reorder the categories on {objCode} {objID} to {categoryIDs}.
        slots:
          objCode: query.objCode
          objID: query.objID
          categoryIDs: query.categoryIDs
      - text: Put custom forms on object {objID} in the order {categoryIDs}.
        slots:
          objID: query.objID
          categoryIDs: query.categoryIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/unassignCategories'].put
  update:
    x-apievangelist-phrasing:
      intent: Detach several custom forms from an object
      effect: destructive
      questions:
      - How do I remove multiple custom forms from a task at once?
      - Can I detach a list of categories from one object in one call?
      instructions:
      - text: Detach categories {categoryIDs} from {objCode} {objID}.
        slots:
          categoryIDs: query.categoryIDs
          objCode: query.objCode
          objID: query.objID
      - text: Remove custom forms {categoryIDs} from object {objID}.
        slots:
          categoryIDs: query.categoryIDs
          objID: query.objID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/category/unassignCategory'].put
  update:
    x-apievangelist-phrasing:
      intent: Detach one custom form from an object
      effect: destructive
      questions:
      - How do I take a single custom form off a project?
      - What happens to the field values when I remove one category from an object?
      instructions:
      - text: Detach category {categoryID} from {objCode} {objID}.
        slots:
          categoryID: query.categoryID
          objCode: query.objCode
          objID: query.objID
      - text: Remove the single custom form {categoryID} from object {objID}.
        slots:
          categoryID: query.categoryID
          objID: query.objID
      method: generated
      generated: '2026-09-26'