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

# \ArchivesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_archive**](ArchivesApi.md#create_archive) | **POST** /v3/workflows/groups/{group_id}/archives | Create an archive
[**get_archive**](ArchivesApi.md#get_archive) | **GET** /v3/workflows/groups/{group_id}/archives/{archive_id} | Retrieve an archive
[**list_archives**](ArchivesApi.md#list_archives) | **GET** /v3/workflows/groups/{group_id}/archives | Retrieve archives



## create_archive

> models::RespResourceUrl create_archive(group_id, req_archive)
Create an archive

Create an Archive. Archives are used to persist the results of a pipeline run 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**req_archive** | [**ReqArchive**](ReqArchive.md) | A JSON object specifying information for the archive to be created. | [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_archive

> models::RespArchive get_archive(group_id, archive_id)
Retrieve an archive

Retrieve an archive

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**archive_id** | **String** |  | [required] |

### Return type

[**models::RespArchive**](RespArchive.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_archives

> models::RespArchiveList list_archives(group_id)
Retrieve archives

Retrieve a list of archives for in group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |

### Return type

[**models::RespArchiveList**](RespArchiveList.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)