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

# \TaskIdentityLinkApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_identity_link**](TaskIdentityLinkApi.md#add_identity_link) | **post** /task/{id}/identity-links | 
[**delete_identity_link**](TaskIdentityLinkApi.md#delete_identity_link) | **post** /task/{id}/identity-links/delete | 
[**get_identity_links**](TaskIdentityLinkApi.md#get_identity_links) | **get** /task/{id}/identity-links | 



## add_identity_link

> add_identity_link(id, identity_link_dto)


Adds an identity link to a task by id. Can be used to link any user or group to a task and specify a relation.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task to add a link to. | [required] |
**identity_link_dto** | Option<[**IdentityLinkDto**](IdentityLinkDto.md)> |  |  |

### Return type

 (empty response body)

### Authorization

No authorization required

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

> delete_identity_link(id, identity_link_dto)


Removes an identity link from a task by id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task to remove a link from. | [required] |
**identity_link_dto** | Option<[**IdentityLinkDto**](IdentityLinkDto.md)> |  |  |

### Return type

 (empty response body)

### Authorization

No authorization required

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

> Vec<crate::models::IdentityLinkDto> get_identity_links(id, _type)


Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The id of the task to retrieve the identity links for. | [required] |
**_type** | Option<**String**> | Filter by the type of links to include. |  |

### Return type

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