API Reference

Automations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

GetWorkflowExecution

client.Automations.GetExecution(ctx, body) (*AutomationGetExecutionResponse, error)

POST/gitpod.v1.WorkflowService/GetWorkflowExecution

Gets details about a specific workflow execution.

Use this method to:

• Check execution status
• View execution results
• Monitor execution progress

Examples

• Get execution details:

  Retrieves information about a specific execution.

  workflowExecutionId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"

ParametersExpand Collapse

body AutomationGetExecutionParams

WorkflowExecutionID param.Field[string]Optional

formatuuid

ReturnsExpand Collapse

type AutomationGetExecutionResponse struct{…}

WorkflowExecution WorkflowExecutionOptional

WorkflowExecution represents a workflow execution instance.

ID stringOptional

formatuuid

Metadata WorkflowExecutionMetadataOptional

WorkflowExecutionMetadata contains workflow execution metadata.

Creator SubjectOptional

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

Executor SubjectOptional

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

FinishedAt TimeOptional

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

StartedAt TimeOptional

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

WorkflowID stringOptional

formatuuid

Spec WorkflowExecutionSpecOptional

WorkflowExecutionSpec contains the specification used for this execution.

Action WorkflowActionOptional

WorkflowAction defines the actions to be executed in a workflow.

Limits WorkflowActionLimits

Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit:

this.max_parallel <= this.max_total

MaxParallel int64Optional

Maximum parallel actions must be between 1 and 25:

this >= 1 && this <= 25

formatint32

MaxTotal int64Optional

Maximum total actions must be between 1 and 100:

this >= 1 && this <= 100

formatint32

PerExecution WorkflowActionLimitsPerExecutionOptional

PerExecution defines limits per execution action.

MaxTime stringOptional

Maximum time allowed for a single execution action. Use standard duration format (e.g., “30m” for 30 minutes, “2h” for 2 hours).

formatregex

Steps []WorkflowStepOptional

Automation must have between 1 and 50 steps:

size(this) >= 1 && size(this) <= 50

Agent WorkflowStepAgentOptional

WorkflowAgentStep represents an agent step that executes with a prompt.

Prompt stringOptional

Prompt must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

PullRequest WorkflowStepPullRequestOptional

WorkflowPullRequestStep represents a pull request creation step.

Branch stringOptional

Branch name must be between 1 and 255 characters:

size(this) >= 1 && size(this) <= 255

Description stringOptional

Description must be at most 20,000 characters:

size(this) <= 20000

Draft boolOptional

Title stringOptional

Title must be between 1 and 500 characters:

size(this) >= 1 && size(this) <= 500

Task WorkflowStepTaskOptional

WorkflowTaskStep represents a task step that executes a command.

Command stringOptional

Command must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

Report WorkflowActionOptional

WorkflowAction defines the actions to be executed in a workflow.

Limits WorkflowActionLimits

Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit:

this.max_parallel <= this.max_total

MaxParallel int64Optional

Maximum parallel actions must be between 1 and 25:

this >= 1 && this <= 25

formatint32

MaxTotal int64Optional

Maximum total actions must be between 1 and 100:

this >= 1 && this <= 100

formatint32

PerExecution WorkflowActionLimitsPerExecutionOptional

PerExecution defines limits per execution action.

MaxTime stringOptional

Maximum time allowed for a single execution action. Use standard duration format (e.g., “30m” for 30 minutes, “2h” for 2 hours).

formatregex

Steps []WorkflowStepOptional

Automation must have between 1 and 50 steps:

size(this) >= 1 && size(this) <= 50

Agent WorkflowStepAgentOptional

WorkflowAgentStep represents an agent step that executes with a prompt.

Prompt stringOptional

Prompt must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

PullRequest WorkflowStepPullRequestOptional

WorkflowPullRequestStep represents a pull request creation step.

Branch stringOptional

Branch name must be between 1 and 255 characters:

size(this) >= 1 && size(this) <= 255

Description stringOptional

Description must be at most 20,000 characters:

size(this) <= 20000

Draft boolOptional

Title stringOptional

Title must be between 1 and 500 characters:

size(this) >= 1 && size(this) <= 500

Task WorkflowStepTaskOptional

WorkflowTaskStep represents a task step that executes a command.

Command stringOptional

Command must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

Trigger WorkflowExecutionSpecTriggerOptional

WorkflowExecutionTrigger represents a workflow execution trigger instance.

Context WorkflowTriggerContext

Context from the workflow trigger - copied at execution time for immutability. This allows the reconciler to create actions without fetching the workflow definition.

Agent WorkflowTriggerContextAgentOptional

Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context.

Prompt stringOptional

Agent prompt must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

FromTrigger unknownOptional

Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context.

Projects WorkflowTriggerContextProjectsOptional

Execute workflow in specific project environments. Creates environments for each specified project.

ProjectIDs []stringOptional

Repositories WorkflowTriggerContextRepositoriesOptional

Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns.

EnvironmentClassID stringOptional

formatuuid

RepoSelector WorkflowTriggerContextRepositoriesRepoSelectorOptional

RepositorySelector defines how to select repositories for workflow execution. Combines a search string with an SCM host to identify repositories.

RepoSearchString stringOptional

Search string to match repositories using SCM-specific search patterns. For GitHub: supports GitHub search syntax (e.g., “org:gitpod-io language:go”, “user:octocat stars:>100”) For GitLab: supports GitLab search syntax See SCM provider documentation for supported search patterns.

minLength1

ScmHost stringOptional

SCM host where the search should be performed (e.g., “github.com”, “gitlab.com”)

minLength1

RepositoryURLs WorkflowTriggerContextRepositoriesRepositoryURLsOptional

RepositoryURLs contains a list of explicit repository URLs. Creates one action per repository URL.

RepoURLs []stringOptional

Manual unknownOptional

Manual trigger - empty message since no additional data needed

PullRequest WorkflowExecutionSpecTriggerPullRequestOptional

PullRequest represents pull request metadata from source control systems. This message is used across workflow triggers, executions, and agent contexts to maintain consistent PR information throughout the system.

ID stringOptional

Unique identifier from the source system (e.g., “123” for GitHub PR #123)

Author stringOptional

Author name as provided by the SCM system

Draft boolOptional

Whether this is a draft pull request

FromBranch stringOptional

Source branch name (the branch being merged from)

Repository WorkflowExecutionSpecTriggerPullRequestRepositoryOptional

Repository information

CloneURL stringOptional

Host stringOptional

Name stringOptional

Owner stringOptional

State StateOptional

Current state of the pull request

One of the following:

const StateUnspecified State = "STATE_UNSPECIFIED"

const StateOpen State = "STATE_OPEN"

const StateClosed State = "STATE_CLOSED"

const StateMerged State = "STATE_MERGED"

Title stringOptional

Pull request title

ToBranch stringOptional

Target branch name (the branch being merged into)

URL stringOptional

Pull request URL (e.g., “https://github.com/owner/repo/pull/123”)

Time WorkflowExecutionSpecTriggerTimeOptional

Time trigger - just the timestamp when it was triggered

TriggeredAt TimeOptional

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

Status WorkflowExecutionStatusOptional

WorkflowExecutionStatus contains the current status of a workflow execution.

DoneActionCount int64Optional

formatint32

FailedActionCount int64Optional

formatint32

Failures []WorkflowExecutionStatusFailureOptional

Structured failures that caused the workflow execution to fail. Provides detailed error codes, messages, and retry information.

Code WorkflowExecutionStatusFailuresCodeOptional

Error code identifying the type of error.

One of the following:

const WorkflowExecutionStatusFailuresCodeWorkflowErrorCodeUnspecified WorkflowExecutionStatusFailuresCode = "WORKFLOW_ERROR_CODE_UNSPECIFIED"

const WorkflowExecutionStatusFailuresCodeWorkflowErrorCodeEnvironmentError WorkflowExecutionStatusFailuresCode = "WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR"

const WorkflowExecutionStatusFailuresCodeWorkflowErrorCodeAgentError WorkflowExecutionStatusFailuresCode = "WORKFLOW_ERROR_CODE_AGENT_ERROR"

Message stringOptional

Human-readable error message.

Meta map[string, string]Optional

Additional metadata about the error. Common keys include:

• environment_id: ID of the environment
• task_id: ID of the task
• service_id: ID of the service
• workflow_id: ID of the workflow
• workflow_execution_id: ID of the workflow execution

Reason stringOptional

Reason explaining why the error occurred. Examples: “not_found”, “stopped”, “deleted”, “creation_failed”, “start_failed”

Retry WorkflowExecutionStatusFailuresRetryOptional

Retry configuration. If not set, the error is considered non-retriable.

Retriable boolOptional

Whether the error is retriable.

RetryAfter stringOptional

Suggested duration to wait before retrying. Only meaningful when retriable is true.

formatregex

PendingActionCount int64Optional

formatint32

Phase WorkflowExecutionStatusPhaseOptional

One of the following:

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseUnspecified WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhasePending WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_PENDING"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseRunning WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_RUNNING"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseStopping WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_STOPPING"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseStopped WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_STOPPED"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseDeleting WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_DELETING"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseDeleted WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_DELETED"

const WorkflowExecutionStatusPhaseWorkflowExecutionPhaseCompleted WorkflowExecutionStatusPhase = "WORKFLOW_EXECUTION_PHASE_COMPLETED"

RunningActionCount int64Optional

formatint32

StoppedActionCount int64Optional

formatint32

Warnings []WorkflowExecutionStatusWarningOptional

Structured warnings about the workflow execution. Provides detailed warning codes and messages.

Code WorkflowExecutionStatusWarningsCodeOptional

Error code identifying the type of error.

One of the following:

const WorkflowExecutionStatusWarningsCodeWorkflowErrorCodeUnspecified WorkflowExecutionStatusWarningsCode = "WORKFLOW_ERROR_CODE_UNSPECIFIED"

const WorkflowExecutionStatusWarningsCodeWorkflowErrorCodeEnvironmentError WorkflowExecutionStatusWarningsCode = "WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR"

const WorkflowExecutionStatusWarningsCodeWorkflowErrorCodeAgentError WorkflowExecutionStatusWarningsCode = "WORKFLOW_ERROR_CODE_AGENT_ERROR"

Message stringOptional

Human-readable error message.

Meta map[string, string]Optional

Additional metadata about the error. Common keys include:

• environment_id: ID of the environment
• task_id: ID of the task
• service_id: ID of the service
• workflow_id: ID of the workflow
• workflow_execution_id: ID of the workflow execution

Reason stringOptional

Reason explaining why the error occurred. Examples: “not_found”, “stopped”, “deleted”, “creation_failed”, “start_failed”

Retry WorkflowExecutionStatusWarningsRetryOptional

Retry configuration. If not set, the error is considered non-retriable.

Retriable boolOptional

Whether the error is retriable.

RetryAfter stringOptional

Suggested duration to wait before retrying. Only meaningful when retriable is true.

formatregex

GetWorkflowExecution

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Automations.GetExecution(context.TODO(), gitpod.AutomationGetExecutionParams{
    WorkflowExecutionID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.WorkflowExecution)
}

200 example

{
  "workflowExecution": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "metadata": {
      "creator": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "executor": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "finishedAt": "2019-12-27T18:11:19.117Z",
      "startedAt": "2019-12-27T18:11:19.117Z",
      "workflowId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    },
    "spec": {
      "action": {
        "limits": {
          "maxParallel": 0,
          "maxTotal": 0,
          "perExecution": {
            "maxTime": "+9125115.360s"
          }
        },
        "steps": [
          {
            "agent": {
              "prompt": "prompt"
            },
            "pullRequest": {
              "branch": "branch",
              "description": "description",
              "draft": true,
              "title": "title"
            },
            "report": {
              "outputs": [
                {
                  "acceptanceCriteria": "acceptanceCriteria",
                  "boolean": {},
                  "command": "command",
                  "float": {
                    "max": 0,
                    "min": 0
                  },
                  "integer": {
                    "max": 0,
                    "min": 0
                  },
                  "key": "key",
                  "prompt": "prompt",
                  "string": {
                    "pattern": "pattern"
                  },
                  "title": "title"
                }
              ]
            },
            "task": {
              "command": "command"
            }
          }
        ]
      },
      "desiredPhase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
      "report": {
        "limits": {
          "maxParallel": 0,
          "maxTotal": 0,
          "perExecution": {
            "maxTime": "+9125115.360s"
          }
        },
        "steps": [
          {
            "agent": {
              "prompt": "prompt"
            },
            "pullRequest": {
              "branch": "branch",
              "description": "description",
              "draft": true,
              "title": "title"
            },
            "report": {
              "outputs": [
                {
                  "acceptanceCriteria": "acceptanceCriteria",
                  "boolean": {},
                  "command": "command",
                  "float": {
                    "max": 0,
                    "min": 0
                  },
                  "integer": {
                    "max": 0,
                    "min": 0
                  },
                  "key": "key",
                  "prompt": "prompt",
                  "string": {
                    "pattern": "pattern"
                  },
                  "title": "title"
                }
              ]
            },
            "task": {
              "command": "command"
            }
          }
        ]
      },
      "session": "session",
      "trigger": {
        "context": {
          "agent": {
            "prompt": "prompt"
          },
          "fromTrigger": {},
          "projects": {
            "projectIds": [
              "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
            ]
          },
          "repositories": {
            "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "repoSelector": {
              "repoSearchString": "x",
              "scmHost": "x"
            },
            "repositoryUrls": {
              "repoUrls": [
                "x"
              ]
            }
          }
        },
        "manual": {},
        "pullRequest": {
          "id": "id",
          "author": "author",
          "draft": true,
          "fromBranch": "fromBranch",
          "repository": {
            "cloneUrl": "cloneUrl",
            "host": "host",
            "name": "name",
            "owner": "owner"
          },
          "state": "STATE_UNSPECIFIED",
          "title": "title",
          "toBranch": "toBranch",
          "url": "url"
        },
        "time": {
          "triggeredAt": "2019-12-27T18:11:19.117Z"
        }
      }
    },
    "status": {
      "doneActionCount": 0,
      "failedActionCount": 0,
      "failureMessage": "failureMessage",
      "failures": [
        {
          "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
          "message": "message",
          "meta": {
            "foo": "string"
          },
          "reason": "reason",
          "retry": {
            "retriable": true,
            "retryAfter": "+9125115.360s"
          }
        }
      ],
      "pendingActionCount": 0,
      "phase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
      "runningActionCount": 0,
      "session": "session",
      "stoppedActionCount": 0,
      "warningMessage": "warningMessage",
      "warnings": [
        {
          "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
          "message": "message",
          "meta": {
            "foo": "string"
          },
          "reason": "reason",
          "retry": {
            "retriable": true,
            "retryAfter": "+9125115.360s"
          }
        }
      ]
    }
  }
}

Returns Examples

200 example

{
  "workflowExecution": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "metadata": {
      "creator": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "executor": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "finishedAt": "2019-12-27T18:11:19.117Z",
      "startedAt": "2019-12-27T18:11:19.117Z",
      "workflowId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    },
    "spec": {
      "action": {
        "limits": {
          "maxParallel": 0,
          "maxTotal": 0,
          "perExecution": {
            "maxTime": "+9125115.360s"
          }
        },
        "steps": [
          {
            "agent": {
              "prompt": "prompt"
            },
            "pullRequest": {
              "branch": "branch",
              "description": "description",
              "draft": true,
              "title": "title"
            },
            "report": {
              "outputs": [
                {
                  "acceptanceCriteria": "acceptanceCriteria",
                  "boolean": {},
                  "command": "command",
                  "float": {
                    "max": 0,
                    "min": 0
                  },
                  "integer": {
                    "max": 0,
                    "min": 0
                  },
                  "key": "key",
                  "prompt": "prompt",
                  "string": {
                    "pattern": "pattern"
                  },
                  "title": "title"
                }
              ]
            },
            "task": {
              "command": "command"
            }
          }
        ]
      },
      "desiredPhase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
      "report": {
        "limits": {
          "maxParallel": 0,
          "maxTotal": 0,
          "perExecution": {
            "maxTime": "+9125115.360s"
          }
        },
        "steps": [
          {
            "agent": {
              "prompt": "prompt"
            },
            "pullRequest": {
              "branch": "branch",
              "description": "description",
              "draft": true,
              "title": "title"
            },
            "report": {
              "outputs": [
                {
                  "acceptanceCriteria": "acceptanceCriteria",
                  "boolean": {},
                  "command": "command",
                  "float": {
                    "max": 0,
                    "min": 0
                  },
                  "integer": {
                    "max": 0,
                    "min": 0
                  },
                  "key": "key",
                  "prompt": "prompt",
                  "string": {
                    "pattern": "pattern"
                  },
                  "title": "title"
                }
              ]
            },
            "task": {
              "command": "command"
            }
          }
        ]
      },
      "session": "session",
      "trigger": {
        "context": {
          "agent": {
            "prompt": "prompt"
          },
          "fromTrigger": {},
          "projects": {
            "projectIds": [
              "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
            ]
          },
          "repositories": {
            "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "repoSelector": {
              "repoSearchString": "x",
              "scmHost": "x"
            },
            "repositoryUrls": {
              "repoUrls": [
                "x"
              ]
            }
          }
        },
        "manual": {},
        "pullRequest": {
          "id": "id",
          "author": "author",
          "draft": true,
          "fromBranch": "fromBranch",
          "repository": {
            "cloneUrl": "cloneUrl",
            "host": "host",
            "name": "name",
            "owner": "owner"
          },
          "state": "STATE_UNSPECIFIED",
          "title": "title",
          "toBranch": "toBranch",
          "url": "url"
        },
        "time": {
          "triggeredAt": "2019-12-27T18:11:19.117Z"
        }
      }
    },
    "status": {
      "doneActionCount": 0,
      "failedActionCount": 0,
      "failureMessage": "failureMessage",
      "failures": [
        {
          "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
          "message": "message",
          "meta": {
            "foo": "string"
          },
          "reason": "reason",
          "retry": {
            "retriable": true,
            "retryAfter": "+9125115.360s"
          }
        }
      ],
      "pendingActionCount": 0,
      "phase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
      "runningActionCount": 0,
      "session": "session",
      "stoppedActionCount": 0,
      "warningMessage": "warningMessage",
      "warnings": [
        {
          "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
          "message": "message",
          "meta": {
            "foo": "string"
          },
          "reason": "reason",
          "retry": {
            "retriable": true,
            "retryAfter": "+9125115.360s"
          }
        }
      ]
    }
  }
}