Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Portalsection API

26 actions 26 updates phrasing extends openapi/adobe-suite-portalsection-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 26 · first 16 shown; the file carries all of them

$.info
$.paths['/portalsection/{id}'].get
$.paths['/portalsection/{id}'].put
$.paths['/portalsection/{id}'].delete
$.paths['/portalsection'].get
$.paths['/portalsection'].put
$.paths['/portalsection'].post
$.paths['/portalsection'].delete
$.paths['/portalsection/count'].get
$.paths['/portalsection/search'].get
$.paths['/portalsection/report'].get
$.paths['/portalsection/{id}/share'].put
$.paths['/portalsection/share'].put
$.paths['/portalsection/{id}/unshare'].put
$.paths['/portalsection/unshare'].put
$.paths['/portalsection/{id}/sharePublic'].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 Portalsection API
  version: 1.0.0
extends: openapi/adobe-suite-portalsection-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: 25
- target: $.paths['/portalsection/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Workfront report (portal section)
      effect: read
      questions:
      - How do I pull up a single Workfront report by its ID?
      - Can I fetch just certain fields of one portal section report?
      instructions:
      - text: Show me portal section report {id}.
        slots:
          id: path.id
      - text: Get the {fields} fields of report {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one Workfront report
      effect: write
      questions:
      - Can I change the settings of one existing portal section report?
      - What is the call to edit a single Workfront report in place?
      instructions:
      - text: Edit portal section report {id} with my changes.
        slots:
          id: path.id
      - text: Update report {id} and return its {fields} afterwards.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one Workfront report
      effect: destructive
      questions:
      - How do I remove a single portal section report from Workfront?
      - Is there a force option when deleting one report that others depend on?
      instructions:
      - text: Delete portal section report {id}.
        slots:
          id: path.id
      - text: Force-delete report {id} even if it is referenced, force flag {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several Workfront reports by ID
      effect: read
      questions:
      - Can I load several portal section reports at once when I already know their IDs?
      - What returns a batch of reports for a list of IDs?
      instructions:
      - text: Fetch the portal section reports with IDs {id}.
        slots:
          id: query.id
      - text: Bulk-load reports {id}, returning only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many Workfront reports at once
      effect: write
      questions:
      - Can I apply edits to a batch of portal section reports in one request?
      - Which call bulk-updates multiple Workfront reports together?
      instructions:
      - text: Bulk-edit the portal section reports in my payload.
      - text: Apply these changes to several reports and return {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a Workfront report
      effect: write
      questions:
      - How do I create a new portal section report in Workfront?
      - Can I duplicate an existing report as the starting point for a new one?
      instructions:
      - text: Create a new portal section report from my definition.
      - text: Copy report {copySourceID} into a new portal section.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several Workfront reports
      effect: destructive
      questions:
      - Can I remove multiple portal section reports in a single call?
      - What bulk-deletes a list of Workfront reports by ID?
      instructions:
      - text: Delete all the portal section reports with IDs {id}.
        slots:
          id: query.id
      - text: Bulk force-delete reports {id} using force flag {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count Workfront reports
      effect: read
      questions:
      - How many portal section reports exist in our Workfront instance?
      - Can I count only the reports that match a filter?
      instructions:
      - text: Count all portal section reports.
      - text: Tell me how many reports match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Workfront reports
      effect: read
      questions:
      - How do I find portal section reports by name or owner?
      - Can I page and sort through report search results?
      instructions:
      - text: Search portal section reports matching {filters}.
        slots:
          filters: query.filters
      - text: Find reports where {filters}, sorted and paged with {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report over Workfront reports
      effect: read
      questions:
      - Can I get grouped totals across our portal section reports?
      - What gives an aggregated summary of reports rather than individual records?
      instructions:
      - text: Summarize portal section reports grouped by {listOptions}.
        slots:
          listOptions: query.listOptions
      - text: Produce aggregate totals for reports matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a Workfront report with a user or team
      effect: write
      questions:
      - How do I give a colleague access to one portal section report?
      - Can I share a report with view rights but forbid some actions?
      instructions:
      - text: Share report {id} with {accessorObjCode} {accessorID} at {coreAction} level.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Grant {accessorID} ({accessorObjCode}) {coreAction} on report {id} but block {forbiddenActions}.
        slots:
          accessorID: query.accessorID
          accessorObjCode: query.accessorObjCode
          coreAction: query.coreAction
          id: path.id
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several Workfront reports at once
      effect: write
      questions:
      - Can I share a whole batch of portal section reports with one team in a single call?
      - What grants the same access on many reports together?
      instructions:
      - text: Share reports {id} with {accessorObjCode} {accessorID} as {coreAction}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch-grant {coreAction} on reports {id} to {accessorID} of type {accessorObjCode}, forbidding {forbiddenActions}.
        slots:
          coreAction: query.coreAction
          id: query.id
          accessorID: query.accessorID
          accessorObjCode: query.accessorObjCode
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a Workfront report with someone
      effect: write
      questions:
      - How do I revoke one person's access to a single portal section report?
      - Can I remove a team from a report's sharing list?
      instructions:
      - text: Unshare report {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Take away {accessorID}'s access to portal section {id}; accessor type {accessorObjCode}.
        slots:
          accessorID: query.accessorID
          id: path.id
          accessorObjCode: query.accessorObjCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing several Workfront reports
      effect: write
      questions:
      - Can I revoke someone's access to many portal section reports in one go?
      - Which call removes a user from the sharing of a batch of reports?
      instructions:
      - text: Unshare reports {id} from {accessorObjCode} {accessorID}.
        slots:
          id: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Batch-revoke {accessorID} ({accessorObjCode}) from every report in {id}.
        slots:
          accessorID: query.accessorID
          accessorObjCode: query.accessorObjCode
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a Workfront report publicly shared
      effect: write
      questions:
      - How do I make one portal section report public to everyone?
      - Can a public report still forbid certain actions?
      instructions:
      - text: Publicly share report {id} with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Open portal section {id} to the public as {coreAction}, forbidding {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Make several Workfront reports public
      effect: write
      questions:
      - Can I publish a set of portal section reports publicly in one call?
      - What makes many reports public with the same access level?
      instructions:
      - text: Publicly share reports {id} at {coreAction} level.
        slots:
          id: query.id
          coreAction: query.coreAction
      - text: Batch-publish reports {id} to everyone as {coreAction} while forbidding {forbiddenActions}.
        slots:
          id: query.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public sharing from a Workfront report
      effect: write
      questions:
      - How do I make a public portal section report private again?
      - Can I withdraw public access on one report without touching user shares?
      instructions:
      - text: Remove public access from report {id}.
        slots:
          id: path.id
      - text: Make portal section {id} no longer public.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public sharing from several reports
      effect: write
      questions:
      - Can I take a batch of reports out of public sharing at once?
      - Which call un-publishes many portal section reports together?
      instructions:
      - text: Remove public access from reports {id}.
        slots:
          id: query.id
      - text: Batch-unpublish the public portal sections {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/exportFusionChartToPDF'].put
  update:
    x-apievangelist-phrasing:
      intent: Export a report chart image to PDF
      effect: write
      questions:
      - Can I turn a report's chart image into a PDF file?
      - How do I export a Workfront report chart as a PDF with a custom file name?
      instructions:
      - text: Export this chart PNG {pngByteArray} to a PDF named {fileName}.
        slots:
          pngByteArray: query.pngByteArray
          fileName: query.fileName
      - text: Make a PDF of the chart for report {reportName}.
        slots:
          reportName: query.reportName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/getPK'].put
  update:
    x-apievangelist-phrasing:
      intent: Look up the primary key for an object type
      effect: read
      questions:
      - What is the primary key field for a given Workfront object type in reports?
      - Can I ask which key a report uses for an object code?
      instructions:
      - text: Get the primary key for object code {objCode}.
        slots:
          objCode: query.objCode
      - text: Tell me the PK field reports use for {objCode}.
        slots:
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/getReportFromCache'].put
  update:
    x-apievangelist-phrasing:
      intent: Fetch a cached report result by background job
      effect: read
      questions:
      - Can I retrieve report output that a background job already produced?
      - How do I get cached report results once the job finishes?
      instructions:
      - text: Get the cached report produced by background job {backgroundJobID}.
        slots:
          backgroundJobID: query.backgroundJobID
      - text: Load report results from cache for job {backgroundJobID}.
        slots:
          backgroundJobID: query.backgroundJobID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/isReportFilterable'].put
  update:
    x-apievangelist-phrasing:
      intent: Check whether a report can be filtered
      effect: read
      questions:
      - Is a given report filterable for a particular object?
      - Can I check if a report on one object type supports filtering by another?
      instructions:
      - text: Check if a {queryClassObjCode} report is filterable for {objCode} {objID}.
        slots:
          queryClassObjCode: query.queryClassObjCode
          objCode: query.objCode
          objID: query.objID
      - text: Tell me whether {queryClassObjCode} reports can be filtered by object type {objCode}.
        slots:
          queryClassObjCode: query.queryClassObjCode
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/linkCustomer'].put
  update:
    x-apievangelist-phrasing:
      intent: Link a report to the customer
      effect: write
      questions:
      - How do I link a portal section report to the customer account?
      - Can a report be attached at the customer level?
      instructions:
      - text: Link portal section {ID} to the customer.
        slots:
          ID: query.ID
      - text: Attach report {ID} at the customer level.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/unlinkCustomer'].put
  update:
    x-apievangelist-phrasing:
      intent: Unlink a report from the customer
      effect: write
      questions:
      - How do I detach a portal section report from the customer account?
      - Can I undo a customer-level link on a report?
      instructions:
      - text: Unlink portal section {ID} from the customer.
        slots:
          ID: query.ID
      - text: Detach report {ID} from the customer level.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/portalsection/getReportAsUser'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report as another user
      effect: read
      questions:
      - Can I see what a report shows when a specific user runs it?
      - How do I preview a Workfront report from someone else's permissions?
      instructions:
      - text: Run report {ID} as user {userID}.
        slots:
          ID: query.ID
          userID: query.userID
      - text: Show me portal section {ID} the way {userID} would see it.
        slots:
          ID: query.ID
          userID: query.userID
      method: generated
      generated: '2026-09-26'