Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Customenum API

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

$.info
$.paths['/customenum/{id}'].get
$.paths['/customenum/{id}'].put
$.paths['/customenum/{id}'].delete
$.paths['/customenum'].get
$.paths['/customenum'].put
$.paths['/customenum'].post
$.paths['/customenum'].delete
$.paths['/customenum/count'].get
$.paths['/customenum/search'].get
$.paths['/customenum/report'].get
$.paths['/customenum/getDefaultOpTaskConditionEnum'].put
$.paths['/customenum/getDefaultOpTaskPriorityEnum'].put
$.paths['/customenum/getDefaultProjectConditionEnum'].put
$.paths['/customenum/getDefaultProjectStatusEnum'].put
$.paths['/customenum/getDefaultProjectStatusEnumForGroup'].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 Customenum API
  version: 1.0.0
extends: openapi/adobe-suite-customenum-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: 36
- target: $.paths['/customenum/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom enum value by ID
      effect: read
      questions:
      - How can I look up a single custom status or priority value by its ID?
      - Can I limit which fields come back when fetching one custom enum entry?
      instructions:
      - text: Show me custom enum {id}.
        slots:
          id: path.id
      - text: Fetch custom enum entry {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single custom enum value
      effect: write
      questions:
      - How do I rename or recolor one existing custom status value in Workfront?
      - Is it possible to change a single custom enum entry without touching the others?
      instructions:
      - text: Edit custom enum {id}.
        slots:
          id: path.id
      - text: Update the custom enum value {id} and return fields {fields} afterwards.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one custom enum value
      effect: destructive
      questions:
      - Can I remove a single custom priority or status value I no longer use?
      - What happens if I force the deletion of a custom enum entry that is still referenced?
      instructions:
      - text: Delete custom enum {id}.
        slots:
          id: path.id
      - text: Force-delete the custom enum value {id} even if it is in use.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several custom enum values by ID
      effect: read
      questions:
      - Can I retrieve a batch of custom enum entries in one call by listing their IDs?
      - Which call returns multiple specific custom enums at once?
      instructions:
      - text: Get the custom enums with IDs {id} in one request.
        slots:
          id: query.id
      - text: Bulk fetch custom enum records {id}, returning just {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit many custom enum values
      effect: write
      questions:
      - How do I update a whole batch of custom enum values in a single request?
      - Can several custom statuses be edited together rather than one by one?
      instructions:
      - text: Apply a bulk edit to multiple custom enum values at once.
      - text: Bulk-edit the custom enums and return fields {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new custom enum value
      effect: write
      questions:
      - How do I add a new custom status, priority or condition value?
      - Can I create custom enum entries through the API?
      instructions:
      - text: Create a new custom enum value.
      - text: Add a customenum record and respond with fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete custom enum values
      effect: destructive
      questions:
      - Is there a way to delete many custom enum entries in one call?
      - Can I force-remove several custom statuses at once?
      instructions:
      - text: 'Delete all of these custom enums in bulk: {id}.'
        slots:
          id: query.id
      - text: Bulk force-delete custom enum records {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom enum values
      effect: read
      questions:
      - How many custom enum values are defined in my Workfront instance?
      - Can I count only the custom enums that match a filter?
      instructions:
      - text: Count the custom enums.
      - text: Give me the number of custom enums matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search custom enum values
      effect: read
      questions:
      - What's the way to search custom enum entries by their attributes?
      - Can I page and sort the results when searching custom enums?
      instructions:
      - text: Search custom enums where {filters}.
        slots:
          filters: query.filters
      - text: Find customenum records matching {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over custom enum values
      effect: read
      questions:
      - Can I get an aggregated report of custom enum values?
      - Is there a grouped summary report available for custom enums?
      instructions:
      - text: Run a custom enum report.
      - text: Generate a report on customenum entries filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultOpTaskConditionEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default issue condition
      effect: read
      questions:
      - Which condition is applied to a new issue by default?
      - What is the out-of-the-box condition value for issues (op tasks)?
      instructions:
      - text: Tell me the default condition for issues.
      - text: Look up which op task condition is the default.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultOpTaskPriorityEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default issue priority
      effect: read
      questions:
      - What priority does an issue get when nobody sets one?
      - Which op task priority value is marked as the default?
      instructions:
      - text: Get the default priority used for issues.
      - text: Show the op task priority that new issues start with.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultProjectConditionEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default project condition
      effect: read
      questions:
      - What condition do projects default to, like on target?
      - Which project condition value is the system default?
      instructions:
      - text: Return the default project condition.
      - text: Look up the condition a new project is assigned by default.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultProjectStatusEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default project status
      effect: read
      questions:
      - Which status is a new project created with by default?
      - What is the organization-wide default project status?
      instructions:
      - text: Get the default project status.
      - text: Tell me which status projects start in when none is chosen.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultProjectStatusEnumForGroup'].put
  update:
    x-apievangelist-phrasing:
      intent: Get a group's default project status
      effect: read
      questions:
      - Can a specific group have its own default project status?
      - What default project status applies within one particular group?
      instructions:
      - text: Get the default project status for group {groupID}.
        slots:
          groupID: query.groupID
      - text: Find out which project status group {groupID} uses by default.
        slots:
          groupID: query.groupID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultSeverityEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default issue severity
      effect: read
      questions:
      - What severity is assigned to issues by default?
      - Which severity value is flagged as the default one?
      instructions:
      - text: Show the default severity value.
      - text: Look up which severity new issues get automatically.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultTaskConditionEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default task condition
      effect: read
      questions:
      - Which condition do tasks default to?
      - What's the standard starting condition for a task?
      instructions:
      - text: Get the default condition for tasks.
      - text: Tell me the task condition used when none is set.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getDefaultTaskPriorityEnum'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the default task priority
      effect: read
      questions:
      - What priority do new tasks receive if I don't pick one?
      - Which task priority is configured as the default?
      instructions:
      - text: Return the default task priority.
      - text: Look up the priority a task gets automatically on creation.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getGroupDefaultProjectStatus'].put
  update:
    x-apievangelist-phrasing:
      intent: Get default status for a project's group
      effect: read
      questions:
      - Given a project, how do I find the default status defined by its group?
      - Can I resolve the group default project status starting from a project ID?
      instructions:
      - text: Get the group default project status that applies to project {projectID}.
        slots:
          projectID: query.projectID
      - text: For project {projectID}, tell me its group's default status.
        slots:
          projectID: query.projectID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/isPossibleToUnlockStatus'].put
  update:
    x-apievangelist-phrasing:
      intent: Check whether a status can be unlocked
      effect: read
      questions:
      - Can a locked status be unlocked, or is it prevented?
      - Is there a way to test if unlocking a given status key is allowed?
      instructions:
      - text: Check if status {statusKey} of type {type} can be unlocked.
        slots:
          statusKey: query.statusKey
          type: query.type
      - text: Verify whether unlocking the status {statusKey} is possible.
        slots:
          statusKey: query.statusKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/getGroupStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List the statuses available to a group
      effect: read
      questions:
      - Which statuses can a particular group use?
      - Can I include hidden statuses when listing a group's statuses?
      instructions:
      - text: List the statuses for group {groupID}.
        slots:
          groupID: query.groupID
      - text: Show every status of group {groupID}, hidden ones included.
        slots:
          groupID: query.groupID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/opTaskConditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue conditions
      effect: read
      questions:
      - What condition values exist for issues?
      - Can I see hidden op task conditions as well as the visible ones?
      instructions:
      - text: List all issue conditions.
      - text: 'Get the op task condition values, including hidden ones: {includeHidden}.'
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/opTaskGroupStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue statuses available in a group
      effect: read
      questions:
      - Which issue statuses are allowed within a given group?
      - Can I get the group-specific statuses for one particular issue?
      instructions:
      - text: List the issue statuses group {groupID} can use.
        slots:
          groupID: query.groupID
      - text: Get the group statuses applicable to issue {opTaskID}.
        slots:
          opTaskID: query.opTaskID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/opTaskPriorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue priorities
      effect: read
      questions:
      - What priority levels can an issue have?
      - Does the issue priority list show hidden priorities if I ask?
      instructions:
      - text: Show me every priority an issue can be given.
      - text: Get op task priorities with hidden values set to {includeHidden}.
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/opTaskSeverities'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue severities
      effect: read
      questions:
      - Which severity levels are defined for issues?
      - Can hidden severities be included in the list?
      instructions:
      - text: List the issue severity values.
      - text: 'Get all severities, including hidden ones: {includeHidden}.'
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/opTaskStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue statuses
      effect: read
      questions:
      - What statuses can an issue move through?
      - Can I narrow issue statuses to one issue type?
      instructions:
      - text: List every status an issue can have.
      - text: Get the issue statuses for issue type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/opTaskTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue types
      effect: read
      questions:
      - What kinds of issues can be logged, such as bug or change order?
      - Where do I get the list of op task types?
      instructions:
      - text: List the available issue types.
      - text: Show me all op task types defined in Workfront.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/projectConditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List project conditions
      effect: read
      questions:
      - What condition values can a project be in?
      - Are hidden project conditions returned when requested?
      instructions:
      - text: List the project condition values.
      - text: Get project conditions with includeHidden {includeHidden}.
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/projectGroupStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List project statuses for a group
      effect: read
      questions:
      - Which project statuses does a particular group allow?
      - Can I get the group statuses that apply to one specific project?
      instructions:
      - text: List the project statuses available to group {groupID}.
        slots:
          groupID: query.groupID
      - text: Show the group statuses valid for project {projectID}.
        slots:
          projectID: query.projectID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/projectPriorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List project priorities
      effect: read
      questions:
      - What priority levels are available for projects?
      - Can I see hidden project priorities too?
      instructions:
      - text: List the priorities a project can have.
      - text: 'Get project priority values, hidden included: {includeHidden}.'
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/projectStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List project statuses
      effect: read
      questions:
      - What statuses can a project have across the organization?
      - Do hidden project statuses show up in the full status list?
      instructions:
      - text: List all project statuses.
      - text: Get every project status, with includeHidden {includeHidden}.
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/taskConditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List task conditions
      effect: read
      questions:
      - Which condition values apply to tasks?
      - Can hidden task conditions be listed?
      instructions:
      - text: List the task condition values.
      - text: 'Get task conditions and include hidden ones: {includeHidden}.'
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/taskGroupStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List task statuses for a group
      effect: read
      questions:
      - Which task statuses can members of one group use?
      - Can I fetch the group statuses relevant to a specific task?
      instructions:
      - text: List task statuses available in group {groupID}.
        slots:
          groupID: query.groupID
      - text: Get the group statuses that apply to task {taskID}.
        slots:
          taskID: query.taskID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/taskPriorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List task priorities
      effect: read
      questions:
      - What priority levels can I assign to a task?
      - Are hidden task priorities available on request?
      instructions:
      - text: Show the priority options for tasks.
      - text: Get task priorities with hidden values {includeHidden}.
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/taskStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List task statuses
      effect: read
      questions:
      - Which statuses can a task be set to?
      - Can I include hidden statuses in the task status list?
      instructions:
      - text: List all task statuses.
      - text: 'Get task statuses including hidden ones: {includeHidden}.'
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customenum/templatetaskPriorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List template task priorities
      effect: read
      questions:
      - What priorities can tasks inside a project template use?
      - Where can I find the priority values for template tasks?
      instructions:
      - text: List the priorities available for template tasks.
      - text: 'Get template task priority values, hidden included: {includeHidden}.'
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-09-26'