Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Objectcategory API

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

$.info
$.paths['/objectcategory/{id}'].get
$.paths['/objectcategory'].get
$.paths['/objectcategory/count'].get
$.paths['/objectcategory/search'].get
$.paths['/objectcategory/report'].get
$.paths['/objectcategory/getForObject'].get

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 Objectcategory API
  version: 1.0.0
extends: openapi/adobe-suite-objectcategory-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: 6
- target: $.paths['/objectcategory/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object-to-form attachment
      effect: read
      questions:
      - Which custom form is attached to an object according to a specific object category record?
      - Can I look up a single object category by ID?
      instructions:
      - text: Show object category {id}.
        slots:
          id: path.id
      - text: Get the {fields} of object category {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objectcategory'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several object categories by ID
      effect: read
      questions:
      - Can I retrieve multiple object category records at once by ID?
      - What forms are linked in these object category records?
      instructions:
      - text: Get object categories {ids}.
        slots:
          ids: query.id
      - text: 'Fetch these object category records together: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objectcategory/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count object categories
      effect: read
      questions:
      - How many custom form attachments exist across objects?
      - What number of object categories match my filter?
      instructions:
      - text: Count object categories matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many object category records exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objectcategory/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search object categories
      effect: read
      questions:
      - Which objects have a particular custom form attached?
      - Can I search object categories with filters and pick fields?
      instructions:
      - text: Search object categories where {filters}.
        slots:
          filters: query.filters
      - text: Find object categories matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objectcategory/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on object categories
      effect: read
      questions:
      - Can I get grouped counts of form attachments by object type?
      - What does an aggregated object category report return?
      instructions:
      - text: Run a grouped report on object categories filtered on {filters}.
        slots:
          filters: query.filters
      - text: Summarize object categories with {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objectcategory/getForObject'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms attached to a specific object
      effect: read
      questions:
      - Which custom forms are attached to a given project or task?
      - Can I get the object categories for one object code and ID?
      instructions:
      - text: Show custom forms attached to object {objID} of type {objCode}.
        slots:
          objID: query.objID
          objCode: query.objCode
      - text: Get the object categories for object {objID}.
        slots:
          objID: query.objID
      method: generated
      generated: '2026-09-26'