# 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 Parameter API
  version: 1.0.0
extends: openapi/adobe-suite-parameter-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: 18
- target: $.paths['/parameter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field parameter by ID
      effect: read
      questions:
      - What type, label and options does a particular custom field parameter have?
      - Can I limit which properties come back when I look up one parameter?
      instructions:
      - text: Show me parameter {id}.
        slots:
          id: path.id
      - text: Look up custom field {id} and return just {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field parameter
      effect: write
      questions:
      - How do I change the label or settings of an existing custom field?
      - Can I edit one parameter without touching the forms that use it?
      instructions:
      - text: Update parameter {id} with the new settings I give you.
        slots:
          id: path.id
      - text: Edit custom field {id} and send back {fields} afterwards.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field parameter
      effect: destructive
      questions:
      - How do I remove a custom field parameter we no longer use?
      - Is force required to delete a parameter that is still attached somewhere?
      instructions:
      - text: Delete parameter {id}.
        slots:
          id: path.id
      - text: Force-delete custom field {id} using force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several parameters by their IDs
      effect: read
      questions:
      - Can I pull the definitions of several custom fields in one request?
      - What's the call for fetching a list of parameters when I know their IDs?
      instructions:
      - text: Get parameters {id}.
        slots:
          id: query.id
      - text: Fetch custom fields {id} together and include {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update several parameters
      effect: write
      questions:
      - Can I update many custom field parameters in one go?
      - Is there a bulk edit for parameters?
      instructions:
      - text: Apply these edits to every parameter in my list as one bulk update.
      - text: Bulk-edit my custom fields and return {fields} for each one.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a custom field parameter
      effect: write
      questions:
      - How do I create a new custom field in Workfront?
      - Can I clone an existing parameter to start a new one?
      instructions:
      - text: Create a new custom field parameter with this label and type.
      - text: Copy parameter {copySourceID} to make a new custom field.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several parameters at once
      effect: destructive
      questions:
      - Can I delete a group of custom fields in one request?
      - What does the force option do when bulk-deleting parameters?
      instructions:
      - text: Delete parameters {id} in bulk.
        slots:
          id: query.id
      - text: Force-remove custom fields {id} together, with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom field parameters
      effect: read
      questions:
      - How many custom fields have been defined in our instance?
      - Can I count only the parameters that match a filter?
      instructions:
      - text: Count all parameters.
      - text: Count the custom fields matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search custom field parameters
      effect: read
      questions:
      - How do I find a custom field by its name or type?
      - Can I sort and paginate parameter search results?
      instructions:
      - text: Search parameters where {filters}.
        slots:
          filters: query.filters
      - text: Find custom fields matching {filters}, returning {fields} with list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over custom field parameters
      effect: read
      questions:
      - Can I get a grouped or aggregated report of our custom fields?
      - Which call produces report output for parameters instead of plain records?
      instructions:
      - text: Run a parameter report for {filters}.
        slots:
          filters: query.filters
      - text: Build a custom field report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a parameter with a user or team
      effect: write
      questions:
      - How do I let a specific user manage one of our custom fields?
      - Can I share a parameter but block certain actions on it?
      instructions:
      - text: Share parameter {id} with {accessorObjCode} {accessorID}, granting {coreAction} access.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Give {accessorObjCode} {accessorID} {coreAction} rights on custom field {id} except {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['/parameter/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several parameters at once
      effect: write
      questions:
      - Can I share a batch of custom fields with one team in a single call?
      - Is there a bulk share for parameters?
      instructions:
      - text: Share parameters {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-grant {coreAction} on custom fields {id} to accessor {accessorID} of type {accessorObjCode}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a parameter with someone
      effect: destructive
      questions:
      - How do I take away a user's access to one custom field?
      - Can I remove a single group from a parameter's sharing?
      instructions:
      - text: Unshare parameter {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke {accessorID}'s access to custom field {id}; the accessor type is {accessorObjCode}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke access to several parameters
      effect: destructive
      questions:
      - Can I revoke someone's access to many custom fields at once?
      - Is there a bulk unshare for parameters?
      instructions:
      - text: Unshare parameters {id} from {accessorObjCode} {accessorID} in one batch.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Remove accessor {accessorID} ({accessorObjCode}) from all of custom fields {id}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a parameter public
      effect: write
      questions:
      - How do I make a custom field available to everyone?
      - Can a public parameter be restricted so nobody can delete it?
      instructions:
      - text: Share parameter {id} publicly with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make custom field {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['/parameter/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make several parameters public
      effect: write
      questions:
      - Can I make a whole set of custom fields public in one step?
      - Is there a batch public share for parameters?
      instructions:
      - text: Publicly share the parameters {id} with {coreAction} access in one batch.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Make custom fields {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['/parameter/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public access from a parameter
      effect: destructive
      questions:
      - How do I make a public custom field private again?
      - Can I stop everyone from seeing a parameter I made public?
      instructions:
      - text: Remove public sharing from parameter {id}.
        slots:
          id: path.id
      - text: Make custom field {id} private again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parameter/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public access from several parameters
      effect: destructive
      questions:
      - Can I take several public custom fields private at once?
      - Is there a bulk way to revoke public sharing on parameters?
      instructions:
      - text: Remove public sharing from parameters {id} in one batch.
        slots:
          id: query.id
      - text: Take custom fields {id} private again, all together.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'