# 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 Backgroundjob API
  version: 1.0.0
extends: openapi/adobe-suite-background-job-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/backgroundjob/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a background job
      effect: read
      questions:
      - How do I check on one background job by its ID?
      - Can I limit the fields returned for a single background job?
      instructions:
      - text: Show background job {id}.
        slots:
          id: path.id
      - text: Fetch background job {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a background job
      effect: destructive
      questions:
      - Can I remove a single background job record?
      - Is force deletion available for one background job?
      instructions:
      - text: Delete background job {id}.
        slots:
          id: path.id
      - text: Force remove the one background job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several background jobs by ID
      effect: read
      questions:
      - Can I retrieve multiple background jobs in one call using their IDs?
      - Which call returns a batch of specific background jobs?
      instructions:
      - text: Get background jobs {id} together.
        slots:
          id: query.id
      - text: Bulk fetch the background jobs {id} with only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a background job
      effect: write
      questions:
      - How do I create a new background job?
      - Can background jobs be added through the API?
      instructions:
      - text: Create a background job.
      - text: Add a backgroundjob and return fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete background jobs
      effect: destructive
      questions:
      - Is it possible to delete many background jobs in one request?
      - What's the call for removing background jobs in bulk?
      instructions:
      - text: Bulk delete background jobs {id}.
        slots:
          id: query.id
      - text: 'Remove these background jobs all at once: {id}.'
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count background jobs
      effect: read
      questions:
      - How many background jobs are there?
      - Can I count only background jobs that match a filter?
      instructions:
      - text: Count background jobs.
      - text: Give me the number of background jobs matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search background jobs
      effect: read
      questions:
      - What's the way to search background jobs by status or other attributes?
      - Can I sort and page background job search results?
      instructions:
      - text: Search background jobs where {filters}.
        slots:
          filters: query.filters
      - text: Find background jobs matching {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/backgroundjob/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on background jobs
      effect: read
      questions:
      - Can I get an aggregated report of background jobs?
      - Is there a grouped summary of background jobs?
      instructions:
      - text: Run a background job report.
      - text: Generate a report of background jobs filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'