Transaction Workflows

Export a transaction workflow

GET/transaction-workflows/{id}/export
transaction-workflows:readexport_transaction_workflowRead-only

Returns the workflow in the app's export format: its name, label, description and status, and its steps in order with temporary ids (step_0, step_1, ...), their fields, requirements, triggers and links. Links and step ids in trigger config use the temporary ids. POST /transaction-workflows/import and the app both accept it. Nothing is changed.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

200

The portable workflow definition.

TransactionWorkflowExport
{
  "data": {
    "workflow": {
      "name": "string",
      "label": "string",
      "description": "string",
      "status": "draft",
      "isDefault": true
    },
    "steps": [
      {
        "id": "string",
        "name": "string",
        "label": "string",
        "description": "string",
        "type": "default",
        "isProtected": true,
        "isFloating": true,
        "showDefaultInternalMessage": true,
        "stepFields": [],
        "workflowCustomStepRequirements": [],
        "workflowCustomStepTriggers": [],
        "nextStepLinks": []
      }
    ]
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/transaction-workflows/{id}/export\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"