# 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 Customlabel API
  version: 1.0.0
extends: openapi/adobe-suite-customlabel-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: 13
- target: $.paths['/customlabel/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom label
      effect: read
      questions:
      - How do I look up a single custom label in Workfront?
      - Can I choose which fields to return for a custom label?
      instructions:
      - text: Show custom label {id}.
        slots:
          id: path.id
      - text: Get custom label {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom label
      effect: destructive
      questions:
      - How do I delete a custom label record by ID?
      - Can I force removal of a custom label?
      instructions:
      - text: Delete custom label {id}.
        slots:
          id: path.id
      - text: Delete custom label {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several custom labels by ID
      effect: read
      questions:
      - Can I load a batch of custom labels by their IDs?
      - Is there a bulk get for custom labels?
      instructions:
      - text: Fetch custom labels {id}.
        slots:
          id: query.id
      - text: Bulk-load custom labels {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom label
      effect: write
      questions:
      - How do I create a new custom label?
      - Can I add a custom label record through the API?
      instructions:
      - text: Create a custom label.
      - text: Add a new custom label and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete custom labels
      effect: destructive
      questions:
      - Can I delete several custom labels at once?
      - How do I remove a batch of custom labels by ID?
      instructions:
      - text: Delete custom labels {id}.
        slots:
          id: query.id
      - text: Bulk-delete custom labels {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom labels
      effect: read
      questions:
      - How many custom labels exist that match a filter?
      - Can I get a count of custom labels only?
      instructions:
      - text: Count custom labels matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many custom label records there are.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search custom labels
      effect: read
      questions:
      - What's the way to search custom label records by field?
      - Can I page through custom label search results?
      instructions:
      - text: Search custom labels where {filters}.
        slots:
          filters: query.filters
      - text: Find custom labels matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on custom labels
      effect: read
      questions:
      - Can I produce an aggregate report over custom labels?
      - How do I group custom label records in a report?
      instructions:
      - text: Run a custom label report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a custom label report with options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/checkDelete'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if a custom label can be deleted
      effect: read
      questions:
      - Is it safe to delete a custom label from a layout template?
      - Can I verify a custom label is deletable before removing it?
      instructions:
      - text: Check whether custom label {id} can be deleted from layout template {layoutTemplateID}.
        slots:
          id: query.id
          layoutTemplateID: query.layoutTemplateID
      - text: Run a delete check on custom label {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/inUseByOtherLayoutTemplates'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if a label is used by other layout templates
      effect: read
      questions:
      - Is this custom label also used by other layout templates?
      - How can I tell whether a label is shared beyond one layout template?
      instructions:
      - text: Check if custom label {id} is used by layout templates other than {layoutTemplateID}.
        slots:
          id: query.id
          layoutTemplateID: query.layoutTemplateID
      - text: Tell me whether custom label {id} is in use elsewhere.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/removeCustomLabel'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom label from a layout template
      effect: destructive
      questions:
      - How do I take a custom label off a layout template?
      - Can I detach a label from one layout template only?
      instructions:
      - text: Remove custom label {id} from layout template {layoutTemplateID}.
        slots:
          id: query.id
          layoutTemplateID: query.layoutTemplateID
      - text: Detach label {id} from its layout template.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/customLabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List all custom labels defined
      effect: read
      questions:
      - What custom labels are defined in my Workfront instance?
      - Can I list every custom label without passing IDs?
      instructions:
      - text: List all custom labels.
      - text: Show every defined custom label.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customlabel/usedCustomLabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom labels currently in use
      effect: read
      questions:
      - Which custom labels are actually being used?
      - Can I see only the labels that are in use on layouts?
      instructions:
      - text: List the custom labels in use.
      - text: Show which custom labels are currently used.
      method: generated
      generated: '2026-09-26'