hi-jira2 0.0.1

Jira rest api v2
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

# \ProjectRoleActorsApi

All URIs are relative to *https://your-domain.atlassian.net*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_actor_users**](ProjectRoleActorsApi.md#add_actor_users) | **POST** /rest/api/2/project/{projectIdOrKey}/role/{id} | Add actors to project role
[**add_project_role_actors_to_role**](ProjectRoleActorsApi.md#add_project_role_actors_to_role) | **POST** /rest/api/2/role/{id}/actors | Add default actors to project role
[**delete_actor**](ProjectRoleActorsApi.md#delete_actor) | **DELETE** /rest/api/2/project/{projectIdOrKey}/role/{id} | Delete actors from project role
[**delete_project_role_actors_from_role**](ProjectRoleActorsApi.md#delete_project_role_actors_from_role) | **DELETE** /rest/api/2/role/{id}/actors | Delete default actors from project role
[**get_project_role_actors_for_role**](ProjectRoleActorsApi.md#get_project_role_actors_for_role) | **GET** /rest/api/2/role/{id}/actors | Get default actors for project role
[**set_actors**](ProjectRoleActorsApi.md#set_actors) | **PUT** /rest/api/2/project/{projectIdOrKey}/role/{id} | Set actors for project role



## add_actor_users

> crate::models::ProjectRole add_actor_users(project_id_or_key, id, actors_map)
Add actors to project role

Adds actors to a project role for the project.  To replace all actors for the project, use [Set actors for project role](#api-rest-api-2-project-projectIdOrKey-role-id-put).  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id_or_key** | **String** | The project ID or project key (case sensitive). | [required] |
**id** | **i64** | The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. | [required] |
**actors_map** | [**ActorsMap**](ActorsMap.md) | The groups or users to associate with the project role for this project. Provide the user account ID or group name. | [required] |

### Return type

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

### Authorization

[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)

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


## add_project_role_actors_to_role

> crate::models::ProjectRole add_project_role_actors_to_role(id, actor_input_bean)
Add default actors to project role

Adds [default actors](#api-rest-api-2-resolution-get) to a role. You may add groups or users, but you cannot add groups and users in the same request.  Changing a project role's default actors does not affect project role members for projects already created.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i64** | The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. | [required] |
**actor_input_bean** | [**ActorInputBean**](ActorInputBean.md) |  | [required] |

### Return type

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

### Authorization

[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)

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

> delete_actor(project_id_or_key, id, user, group)
Delete actors from project role

Deletes actors from a project role for the project.  To remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-2-role-id-actors-delete).  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id_or_key** | **String** | The project ID or project key (case sensitive). | [required] |
**id** | **i64** | The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. | [required] |
**user** | Option<**String**> | The user account ID of the user to remove from the project role. |  |
**group** | Option<**String**> | The name of the group to remove from the project role. |  |

### Return type

 (empty response body)

### Authorization

[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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_project_role_actors_from_role

> crate::models::ProjectRole delete_project_role_actors_from_role(id, user, group)
Delete default actors from project role

Deletes the [default actors](#api-rest-api-2-resolution-get) from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.  Changing a project role's default actors does not affect project role members for projects already created.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i64** | The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. | [required] |
**user** | Option<**String**> | The user account ID of the user to remove as a default actor. |  |
**group** | Option<**String**> | The group name of the group to be removed as a default actor. |  |

### Return type

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

### Authorization

[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)

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

> crate::models::ProjectRole get_project_role_actors_for_role(id)
Get default actors for project role

Returns the [default actors](#api-rest-api-2-resolution-get) for the project role.  **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i64** | The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. | [required] |

### Return type

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

### Authorization

[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)

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

> crate::models::ProjectRole set_actors(project_id_or_key, id, project_role_actors_update_bean)
Set actors for project role

Sets the actors for a project role for a project, replacing all existing actors.  To add actors to the project without overwriting the existing list, use [Add actors to project role](#api-rest-api-2-project-projectIdOrKey-role-id-post).  **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id_or_key** | **String** | The project ID or project key (case sensitive). | [required] |
**id** | **i64** | The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. | [required] |
**project_role_actors_update_bean** | [**ProjectRoleActorsUpdateBean**](ProjectRoleActorsUpdateBean.md) | The groups or users to associate with the project role for this project. Provide the user account ID or group name. | [required] |

### Return type

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

### Authorization

[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)

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