tapis-workflows 0.3.1

Create and manage pipelines
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

# \TaskExecutionsApi

All URIs are relative to *http://localhost:8000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_task_execution**](TaskExecutionsApi.md#create_task_execution) | **POST** /v3/workflows/executor/runs/{pipeline_run_uuid}/executions | Task Executions
[**get_task_execution**](TaskExecutionsApi.md#get_task_execution) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/executions/{task_execution_uuid} | Task Executions
[**list_task_executions**](TaskExecutionsApi.md#list_task_executions) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/executions | Task Executions
[**update_task_execution_status**](TaskExecutionsApi.md#update_task_execution_status) | **PATCH** /v3/workflows/executor/executions/{task_execution_uuid}/{status} | Task Executions



## create_task_execution

> models::RespResourceUrl create_task_execution(x_workflow_executor_token, pipeline_run_uuid, req_create_task_execution)
Task Executions

Create a task execution 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**x_workflow_executor_token** | **String** | an authorization header that contains the token that authroizes the workflow executor to create a task execution  | [required] |
**pipeline_run_uuid** | **uuid::Uuid** |  | [required] |
**req_create_task_execution** | [**ReqCreateTaskExecution**](ReqCreateTaskExecution.md) | A JSON object for the createTaskExecution operation. | [required] |

### Return type

[**models::RespResourceUrl**](RespResourceURL.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_task_execution

> models::RespTaskExecution get_task_execution(group_id, pipeline_id, pipeline_run_uuid, task_execution_uuid)
Task Executions

Get a Task Execution 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**pipeline_id** | **String** |  | [required] |
**pipeline_run_uuid** | **uuid::Uuid** |  | [required] |
**task_execution_uuid** | **uuid::Uuid** |  | [required] |

### Return type

[**models::RespTaskExecution**](RespTaskExecution.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_task_executions

> models::RespTaskExecutionList list_task_executions(group_id, pipeline_id, pipeline_run_uuid)
Task Executions

List Task Executions for a pipeline run 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**pipeline_id** | **String** |  | [required] |
**pipeline_run_uuid** | **uuid::Uuid** |  | [required] |

### Return type

[**models::RespTaskExecutionList**](RespTaskExecutionList.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_task_execution_status

> models::RespString update_task_execution_status(x_workflow_executor_token, task_execution_uuid, status, req_patch_task_execution)
Task Executions

update a task execution status 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**x_workflow_executor_token** | **String** | an authorization header that contains the token that authroizes the workflow executor to update the pipeline run status  | [required] |
**task_execution_uuid** | **uuid::Uuid** |  | [required] |
**status** | [**EnumRunStatus**](.md) |  | [required] |
**req_patch_task_execution** | Option<[**ReqPatchTaskExecution**](ReqPatchTaskExecution.md)> | Empty JSON object. |  |

### Return type

[**models::RespString**](RespString.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)