tapis-meta 0.3.0

The Tapis Meta API provides access to a MongoDB database. A standalone service which connects to a MongoDB database and immediately exposes all of MongoDB’s capabilities through a complete REST API, which allows the user to read and write JSON messages and binary data via HTTP.
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
143
144
145

# \AggregationApi

All URIs are relative to *http://localhost:8080/v3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_aggregation**](AggregationApi.md#add_aggregation) | **PUT** /meta/{db}/{collection}/_aggr/{aggregation} | addAggregation
[**delete_aggregation**](AggregationApi.md#delete_aggregation) | **DELETE** /meta/{db}/{collection}/_aggr/{aggregation} | deleteAggregation
[**submit_large_aggregation**](AggregationApi.md#submit_large_aggregation) | **POST** /meta/{db}/{collection}/_aggr/{aggregation} | submitLargeAggregation
[**use_aggregation**](AggregationApi.md#use_aggregation) | **GET** /meta/{db}/{collection}/_aggr/{aggregation} | useAggregation



## add_aggregation

> add_aggregation(db, collection, aggregation, body)
addAggregation

Create an aggregation that can be executed by users.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**db** | **String** |  | [required] |
**collection** | **String** |  | [required] |
**aggregation** | **String** |  | [required] |
**body** | Option<**serde_json::Value**> | the aggregation being defined for the collection |  |

### Return type

 (empty response body)

### 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)


## delete_aggregation

> delete_aggregation(db, collection, aggregation)
deleteAggregation

Delete an aggregation defined for a collection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**db** | **String** |  | [required] |
**collection** | **String** |  | [required] |
**aggregation** | **String** |  | [required] |

### Return type

 (empty response body)

### 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)


## submit_large_aggregation

> serde_json::Value submit_large_aggregation(db, collection, aggregation, page, pagesize, keys, body)
submitLargeAggregation

 This is a POST version of useAggregation on a collection with a avars value to large to submit in a query parameter. If the avars parameter is to large, it may exceed the HTTP header character limit. The HTTP server will throw a query header to large error.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**db** | **String** |  | [required] |
**collection** | **String** |  | [required] |
**aggregation** | **String** |  | [required] |
**page** | Option<**i32**> |  |  |[default to 1]
**pagesize** | Option<**i32**> |  |  |[default to 10]
**keys** | Option<[**Vec<String>**](String.md)> |  |  |
**body** | Option<**serde_json::Value**> | the json document for avars query parameter substitution |  |

### Return type

[**serde_json::Value**](serde_json::Value.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)


## use_aggregation

> use_aggregation(db, collection, aggregation)
useAggregation

Use an aggregation defined for a collection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**db** | **String** |  | [required] |
**collection** | **String** |  | [required] |
**aggregation** | **String** |  | [required] |

### Return type

 (empty response body)

### 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)