windmill-api 1.680.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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

# \MetricsApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_job_metrics**](MetricsApi.md#get_job_metrics) | **POST** /w/{workspace}/job_metrics/get/{id} | get job metrics
[**get_job_progress**](MetricsApi.md#get_job_progress) | **GET** /w/{workspace}/job_metrics/get_progress/{id} | get job progress
[**set_job_progress**](MetricsApi.md#set_job_progress) | **POST** /w/{workspace}/job_metrics/set_progress/{id} | set job metrics



## get_job_metrics

> models::GetJobMetrics200Response get_job_metrics(workspace, id, get_job_metrics_request)
get job metrics

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**get_job_metrics_request** | [**GetJobMetricsRequest**](GetJobMetricsRequest.md) | parameters for statistics retrieval | [required] |

### Return type

[**models::GetJobMetrics200Response**](getJobMetrics_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

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

> i32 get_job_progress(workspace, id)
get job progress

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**i32**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

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


## set_job_progress

> serde_json::Value set_job_progress(workspace, id, set_job_progress_request)
set job metrics

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**set_job_progress_request** | [**SetJobProgressRequest**](SetJobProgressRequest.md) | parameters for statistics retrieval | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

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