Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Company API

13 actions 13 updates phrasing extends openapi/adobe-suite-company-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 13

$.info
$.paths['/company/{id}'].get
$.paths['/company/{id}'].put
$.paths['/company/{id}'].delete
$.paths['/company'].get
$.paths['/company'].put
$.paths['/company'].post
$.paths['/company'].delete
$.paths['/company/replace'].put
$.paths['/company/count'].get
$.paths['/company/search'].get
$.paths['/company/report'].get
$.paths['/company/calculateDataExtension'].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 Company API
  version: 1.0.0
extends: openapi/adobe-suite-company-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: 12
- target: $.paths['/company/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single company record
      effect: read
      questions:
      - How do I look up one client or vendor company by its ID?
      - Can I pick which fields come back when I fetch a company?
      instructions:
      - text: Show me company {id}.
        slots:
          id: path.id
      - text: Fetch company {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single company
      effect: write
      questions:
      - How can I update the details of one company in Workfront?
      - Is it possible to edit a company and get certain fields back?
      instructions:
      - text: Edit company {id}.
        slots:
          id: path.id
      - text: Update company {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single company
      effect: destructive
      questions:
      - How do I delete a company we no longer work with?
      - Can I force delete a company that is still linked to projects?
      instructions:
      - text: Delete company {id}.
        slots:
          id: path.id
      - text: Force delete company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several companies by ID at once
      effect: read
      questions:
      - Can I load multiple companies in one request using their IDs?
      - What's the quickest way to fetch a known list of companies?
      instructions:
      - text: Get companies {id}.
        slots:
          id: query.id
      - text: Bulk fetch companies {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many companies in one request
      effect: write
      questions:
      - Is there a way to bulk update several companies?
      - Can I change a batch of company records at the same time?
      instructions:
      - text: Bulk edit the companies I send.
      - text: Apply edits to multiple companies and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company
      effect: write
      questions:
      - How do I add a new client company?
      - Can I create a company record and choose the response fields?
      instructions:
      - text: Create a new company.
      - text: Create a company and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several companies at once
      effect: destructive
      questions:
      - Can I bulk delete companies by listing their IDs?
      - Does deleting companies in bulk support a force option?
      instructions:
      - text: Delete companies {id} in bulk.
        slots:
          id: query.id
      - text: Bulk force-delete companies {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/replace'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a company with another everywhere
      effect: write
      questions:
      - How do I merge a duplicate company into the one we want to keep?
      - Can I swap all references to one company for a replacement company?
      instructions:
      - text: Replace company {id} with company {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      - text: Repoint everything using company {id} to {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count companies matching a filter
      effect: read
      questions:
      - How many companies are set up in Workfront?
      - Can I count only companies that match certain criteria?
      instructions:
      - text: Count all companies.
      - text: Count companies matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search companies with filters
      effect: read
      questions:
      - How do I search companies by name?
      - Can I page through company search results?
      instructions:
      - text: Search companies where {filters}.
        slots:
          filters: query.filters
      - text: Find companies matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on companies
      effect: read
      questions:
      - Can I get grouped report data about our companies?
      - What does a company report return with a filter?
      instructions:
      - text: Run a company report.
      - text: Report on companies filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/calculateDataExtension'].put
  update:
    x-apievangelist-phrasing:
      intent: Recalculate a company's custom form fields
      effect: write
      questions:
      - How do I force calculated custom fields on a company to refresh?
      - Can I recompute the data extension values for one company?
      instructions:
      - text: Recalculate custom data for company {ID}.
        slots:
          ID: query.ID
      - text: Refresh the calculated fields on company {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'