AMamperity
Workflow

Get workflow details

Return details for a specific workflow.

get/workflow/runs/{workflow-id}

Request

Path parameters

workflow-idstring required
Example:wf-20240905-66170-6HPlbJ

The workflow ID. Use GET /workflow/runs to list workflow IDs, or copy one from the Workflows page in Amperity.

Query parameters

api_versionstring

A supported version of the Amperity API. You may use the api-version request header instead of the api_version request parameter.

viewstring

Set to "overview" to return only "created_at", "ended_at", "id", "name", "state", "tenant", and "type". Set to "verbose" to return all response parameters, including for any tasks that were started by the workflow. Default: "overview". Any other value returns a 400 response.

Headers

Amperity-Tenantstring required

The ID for the tenant to which a request will be sent.

Api-Versionstring required

A supported version of the Amperity API.

Response

Workflow details

created_atstring date-time required

Time the workflow was created

current_versionstring

The current ent version associated with the workflow

ended_atstring date-time

Time the workflow reached a terminal state

idstring required

Unique identifier for the workflow

launched_versionstring

The ent version that was launched with the workflow

namestring

Human-readable identifier for the workflow

principal_emailstring

Email address for who or what created the workflow

principal_idstring

Principal id for who or what created the workflow

principal_namestring

Human-readable name for who or what created the workflow

statestring required

Current workflow state.

tenantstring required

The unique identifier for the tenant.

typestring required

Keyword identifying the type of workflow

warn_after_msnumber double

The time in milliseconds we should send a running long duration warning

Example response

{
  "created_at": "2024-06-19T04:00:18.764Z",
  "ended_at": "2024-06-19T04:03:10.119Z",
  "error": {
    "attribution": "customer",
    "data": {
      "error_code": "InvalidAccessKeyId",
      "id": "s3",
      "request_id": "Z47DXHNGJ7ZPMRVS",
      "retryable?": false
    },
    "message": "The credential does not provide access to the given resource. Please update\n                      the credential's access or try another credential.",
    "type": "amperity.plugin.error/invalid-credentials"
  },
  "id": "wf-20240619-14418-6UhqSe",
  "name": "Customer Attribute Daily",
  "state": "failed",
  "tenant": "acme2-max",
  "type": "campaign.send"
}

Changes

No recorded changes to this operation across all 1 revision of this API.