Adobe Campaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Campaign Classic Workflow API

4 actions 4 updates phrasing extends openapi/adobe-campaign-workflow-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Campaign's API. It is a proposal applied on top of the contract, not a document Adobe Campaign publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/nl/jsp/soaprouter.jsp/xtk-workflow/Start'].post

$.paths['/nl/jsp/soaprouter.jsp/xtk-workflow/Stop'].post

$.paths['/nl/jsp/soaprouter.jsp/xtk-workflow/PostEvent'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Campaign Classic Workflow API
  version: 1.0.0
extends: openapi/adobe-campaign-workflow-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: 3
- target: $.paths['/nl/jsp/soaprouter.jsp/xtk-workflow/Start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a stopped workflow over SOAP
      effect: write
      questions:
      - How do I start a stopped workflow by its internal ID using the SOAP API?
      - Does a workflow have to be stopped before the xtk:workflow Start call works?
      instructions:
      - text: Start workflow {workflow_id} via xtk:workflow Start.
        slots:
          workflow_id: requestBody.workflowId
      - text: Launch the stopped SOAP workflow {workflow_id}.
        slots:
          workflow_id: requestBody.workflowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/nl/jsp/soaprouter.jsp/xtk-workflow/Stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running workflow over SOAP
      effect: destructive
      questions:
      - How do I stop a running workflow by internal ID over SOAP?
      - Which xtk:workflow call halts a workflow that's currently executing?
      instructions:
      - text: Stop running workflow {workflow_id} via xtk:workflow Stop.
        slots:
          workflow_id: requestBody.workflowId
      - text: Halt SOAP workflow {workflow_id} now.
        slots:
          workflow_id: requestBody.workflowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/nl/jsp/soaprouter.jsp/xtk-workflow/PostEvent'].post
  update:
    x-apievangelist-phrasing:
      intent: Signal a workflow's external signal activity
      effect: write
      questions:
      - How do I trigger an external signal activity inside a running workflow?
      - Can I pass variables into a workflow when signalling it?
      instructions:
      - text: Signal activity {activity} in workflow {workflow_id}.
        slots:
          activity: requestBody.activity
          workflow_id: requestBody.workflowId
      - text: Post a signal to {activity} of workflow {workflow_id} with variables {variables}.
        slots:
          activity: requestBody.activity
          workflow_id: requestBody.workflowId
          variables: requestBody.variables
      method: generated
      generated: '2026-09-26'