Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Scheduledreport API

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

$.info
$.paths['/scheduledreport/{id}'].get
$.paths['/scheduledreport/{id}'].put
$.paths['/scheduledreport/{id}'].delete
$.paths['/scheduledreport'].get
$.paths['/scheduledreport'].put
$.paths['/scheduledreport'].post
$.paths['/scheduledreport'].delete
$.paths['/scheduledreport/count'].get
$.paths['/scheduledreport/search'].get
$.paths['/scheduledreport/report'].get
$.paths['/scheduledreport/sendReportDeliveryNow'].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 Scheduledreport API
  version: 1.0.0
extends: openapi/adobe-suite-scheduledreport-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: 11
- target: $.paths['/scheduledreport/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled report
      effect: read
      questions:
      - What schedule and recipients are set on a specific scheduled report?
      - Can I view a single report delivery schedule by its ID?
      instructions:
      - text: Show scheduled report {id}.
        slots:
          id: path.id
      - text: Get the {fields} of scheduled report {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single scheduled report
      effect: write
      questions:
      - How do I change when a scheduled report is delivered?
      - Can I update the recipients of one existing scheduled report?
      instructions:
      - text: Update scheduled report {id}.
        slots:
          id: path.id
      - text: Change the delivery schedule on scheduled report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single scheduled report
      effect: destructive
      questions:
      - Can I stop and remove one scheduled report delivery?
      - Does deleting a scheduled report require forcing it?
      instructions:
      - text: Delete scheduled report {id}.
        slots:
          id: path.id
      - text: Remove the report schedule {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several scheduled reports by ID
      effect: read
      questions:
      - Can I pull a batch of scheduled reports when I have their IDs?
      - What are the settings of these specific report schedules?
      instructions:
      - text: Get scheduled reports {ids}.
        slots:
          ids: query.id
      - text: 'Fetch these report schedules together: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many scheduled reports at once
      effect: write
      questions:
      - Is there a way to bulk update several scheduled reports?
      - Can I change the format on many report schedules in one call?
      instructions:
      - text: Bulk edit these scheduled reports.
      - text: Apply the same change to several report schedules at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a scheduled report
      effect: write
      questions:
      - How do I schedule a Workfront report to be emailed regularly?
      - Can I copy an existing scheduled report as a starting point?
      instructions:
      - text: Create a new weekly scheduled report.
      - text: Copy scheduled report {source} into a new schedule.
        slots:
          source: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several scheduled reports by ID
      effect: destructive
      questions:
      - Can I remove many scheduled reports in one request?
      - What is needed to bulk delete report schedules?
      instructions:
      - text: Delete scheduled reports {ids}.
        slots:
          ids: query.id
      - text: 'Remove all of these report schedules: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count scheduled reports matching filters
      effect: read
      questions:
      - How many scheduled reports are set up in our instance?
      - What number of report schedules match a given filter?
      instructions:
      - text: Count scheduled reports matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many scheduled reports exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search scheduled reports by criteria
      effect: read
      questions:
      - Which scheduled reports go out daily?
      - Can I search report schedules with filters and choose fields?
      instructions:
      - text: Search scheduled reports where {filters}.
        slots:
          filters: query.filters
      - text: Find scheduled reports matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on scheduled reports
      effect: read
      questions:
      - Can I get grouped totals of scheduled reports by owner?
      - What does an aggregated report across scheduled reports look like?
      instructions:
      - text: Run a grouped report over scheduled reports filtered on {filters}.
        slots:
          filters: query.filters
      - text: Summarize scheduled reports with {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduledreport/sendReportDeliveryNow'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a report delivery immediately
      effect: write
      questions:
      - Can I send a report to people right now instead of waiting for its schedule?
      - Which recipients can receive an immediate report delivery, like teams or outside emails?
      instructions:
      - text: Send the report now to users {users}.
        slots:
          users: query.userIDs
      - text: Deliver the report immediately to {emails}.
        slots:
          emails: query.externalEmails
      - text: Send the report now to team {teams} with options {options}.
        slots:
          teams: query.teamIDs
          options: query.deliveryOptions
      method: generated
      generated: '2026-09-26'