2023-10-28
▼ ▲ workflowexecutions.projects.locations.workflows.executions.stepEntries.list
Path: v1/{+parent}/stepEntries
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}/stepEntries
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/
Pattern: ^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Number of step entries to return per call. The default max is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListStepEntries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStepEntries` must match the call that provided the page token.
Location: query
Type: string
skip
Description: Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.
Location: query
Type: integer
Format: int32
filter
Description: Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime>"2023-08-01" AND state="FAILED"`
Location: query
Type: string
orderBy
Description: Optional. Comma-separated list of fields that specify the ordering applied to the `[StepEntries.ListStepEntries]` results. By default the ordering is based on ascending `entryId`. The following fields are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-132.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.
▼ ▲ workflowexecutions.projects.locations.workflows.executions.stepEntries.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}/stepEntries/{stepEntriesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}
Pattern: ^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+/stepEntries/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a step entry.