camunda-client 0.1.2

Rust client for camunda Rest API
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

# \TaskAttachmentApi

All URIs are relative to *http://localhost:8080/engine-rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_attachment**](TaskAttachmentApi.md#add_attachment) | **post** /task/{id}/attachment/create | 
[**delete_attachment**](TaskAttachmentApi.md#delete_attachment) | **delete** /task/{id}/attachment/{attachmentId} | 
[**get_attachment**](TaskAttachmentApi.md#get_attachment) | **get** /task/{id}/attachment/{attachmentId} | 
[**get_attachment_data**](TaskAttachmentApi.md#get_attachment_data) | **get** /task/{id}/attachment/{attachmentId}/data | 
[**get_attachments**](TaskAttachmentApi.md#get_attachments) | **get** /task/{id}/attachment | 



## add_attachment

> crate::models::AttachmentDto add_attachment(id, attachment_name, attachment_description, attachment_type, url, content)


Creates an attachment for a task.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task to add the attachment to. | [required] |
**attachment_name** | Option<**String**> | The name of the attachment. |  |
**attachment_description** | Option<**String**> | The description of the attachment. |  |
**attachment_type** | Option<**String**> | The type of the attachment. |  |
**url** | Option<**String**> | The url to the remote content of the attachment. |  |
**content** | Option<**std::path::PathBuf**> | The content of the attachment. |  |

### Return type

[**crate::models::AttachmentDto**](AttachmentDto.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: multipart/form-data
- **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_attachment

> delete_attachment(id, attachment_id)


Removes an attachment from a task by id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task. | [required] |
**attachment_id** | **String** | The id of the attachment to be removed. | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

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


## get_attachment

> crate::models::AttachmentDto get_attachment(id, attachment_id)


Retrieves a task attachment by task id and attachment id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task. | [required] |
**attachment_id** | **String** | The id of the attachment to be retrieved. | [required] |

### Return type

[**crate::models::AttachmentDto**](AttachmentDto.md)

### Authorization

No authorization required

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


## get_attachment_data

> std::path::PathBuf get_attachment_data(id, attachment_id)


Retrieves the binary content of a task attachment by task id and attachment id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task. | [required] |
**attachment_id** | **String** | The id of the attachment to be retrieved. | [required] |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream, text/plain, 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_attachments

> Vec<crate::models::AttachmentDto> get_attachments(id)


Gets the attachments for a task.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task to retrieve the attachments for. | [required] |

### Return type

[**Vec<crate::models::AttachmentDto>**](AttachmentDto.md)

### Authorization

No authorization required

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