@resolution/jira-api-client 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/package.json +10 -3
- package/.eslintrc.js +0 -3
- package/config/api-typescript-generator.config.ts +0 -91
- package/config/compare-schemas.ts +0 -307
- package/src/index.ts +0 -47
- package/src/openapi/platform/base-jira-platform-api-client.ts +0 -2298
- package/src/openapi/platform/core/common-http-client.ts +0 -723
- package/src/openapi/platform/core/common-http-service.ts +0 -22
- package/src/openapi/platform/core/common-validation-schema-storage.ts +0 -105
- package/src/openapi/platform/models/announcement-banner.ts +0 -59
- package/src/openapi/platform/models/app-data-policies.ts +0 -79
- package/src/openapi/platform/models/app-migration.ts +0 -172
- package/src/openapi/platform/models/app-properties.ts +0 -32
- package/src/openapi/platform/models/audit-records.ts +0 -140
- package/src/openapi/platform/models/avatars.ts +0 -48
- package/src/openapi/platform/models/classification-levels.ts +0 -58
- package/src/openapi/platform/models/common.ts +0 -2669
- package/src/openapi/platform/models/dashboards.ts +0 -849
- package/src/openapi/platform/models/dynamic-modules.ts +0 -121
- package/src/openapi/platform/models/filter-sharing.ts +0 -103
- package/src/openapi/platform/models/filters.ts +0 -319
- package/src/openapi/platform/models/group-and-user-picker.ts +0 -85
- package/src/openapi/platform/models/groups.ts +0 -247
- package/src/openapi/platform/models/issue-attachments.ts +0 -290
- package/src/openapi/platform/models/issue-comment-properties.ts +0 -27
- package/src/openapi/platform/models/issue-comments.ts +0 -91
- package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +0 -96
- package/src/openapi/platform/models/issue-custom-field-contexts.ts +0 -1072
- package/src/openapi/platform/models/issue-custom-field-options-apps.ts +0 -273
- package/src/openapi/platform/models/issue-custom-field-options.ts +0 -283
- package/src/openapi/platform/models/issue-custom-field-values-apps.ts +0 -118
- package/src/openapi/platform/models/issue-field-configurations.ts +0 -435
- package/src/openapi/platform/models/issue-fields.ts +0 -392
- package/src/openapi/platform/models/issue-link-types.ts +0 -28
- package/src/openapi/platform/models/issue-links.ts +0 -185
- package/src/openapi/platform/models/issue-notification-schemes.ts +0 -370
- package/src/openapi/platform/models/issue-priorities.ts +0 -196
- package/src/openapi/platform/models/issue-properties.ts +0 -259
- package/src/openapi/platform/models/issue-remote-links.ts +0 -207
- package/src/openapi/platform/models/issue-resolutions.ts +0 -180
- package/src/openapi/platform/models/issue-search.ts +0 -367
- package/src/openapi/platform/models/issue-security-level.ts +0 -76
- package/src/openapi/platform/models/issue-security-schemes.ts +0 -496
- package/src/openapi/platform/models/issue-type-schemes.ts +0 -290
- package/src/openapi/platform/models/issue-type-screen-schemes.ts +0 -286
- package/src/openapi/platform/models/issue-types.ts +0 -66
- package/src/openapi/platform/models/issue-votes.ts +0 -38
- package/src/openapi/platform/models/issue-watchers.ts +0 -67
- package/src/openapi/platform/models/issue-worklogs.ts +0 -190
- package/src/openapi/platform/models/issues.ts +0 -1268
- package/src/openapi/platform/models/jira-expressions.ts +0 -578
- package/src/openapi/platform/models/jira-settings.ts +0 -118
- package/src/openapi/platform/models/jql-functions-apps.ts +0 -128
- package/src/openapi/platform/models/jql.ts +0 -783
- package/src/openapi/platform/models/labels.ts +0 -42
- package/src/openapi/platform/models/license-metrics.ts +0 -68
- package/src/openapi/platform/models/myself.ts +0 -29
- package/src/openapi/platform/models/permission-schemes.ts +0 -89
- package/src/openapi/platform/models/permissions.ts +0 -308
- package/src/openapi/platform/models/priority-schemes.ts +0 -527
- package/src/openapi/platform/models/project-avatars.ts +0 -29
- package/src/openapi/platform/models/project-classification-levels.ts +0 -24
- package/src/openapi/platform/models/project-components.ts +0 -231
- package/src/openapi/platform/models/project-email.ts +0 -27
- package/src/openapi/platform/models/project-features.ts +0 -78
- package/src/openapi/platform/models/project-permission-schemes.ts +0 -43
- package/src/openapi/platform/models/project-role-actors.ts +0 -107
- package/src/openapi/platform/models/project-roles.ts +0 -76
- package/src/openapi/platform/models/project-types.ts +0 -36
- package/src/openapi/platform/models/project-versions.ts +0 -216
- package/src/openapi/platform/models/projects.ts +0 -429
- package/src/openapi/platform/models/screen-schemes.ts +0 -192
- package/src/openapi/platform/models/screen-tab-fields.ts +0 -45
- package/src/openapi/platform/models/screens.ts +0 -171
- package/src/openapi/platform/models/server-info.ts +0 -100
- package/src/openapi/platform/models/service-registry.ts +0 -68
- package/src/openapi/platform/models/status.ts +0 -229
- package/src/openapi/platform/models/time-tracking.ts +0 -38
- package/src/openapi/platform/models/ui-modifications-apps.ts +0 -229
- package/src/openapi/platform/models/user-search.ts +0 -69
- package/src/openapi/platform/models/users.ts +0 -121
- package/src/openapi/platform/models/webhooks.ts +0 -307
- package/src/openapi/platform/models/workflow-scheme-drafts.ts +0 -58
- package/src/openapi/platform/models/workflow-scheme-project-associations.ts +0 -68
- package/src/openapi/platform/models/workflow-schemes.ts +0 -545
- package/src/openapi/platform/models/workflow-transition-properties.ts +0 -33
- package/src/openapi/platform/models/workflow-transition-rules.ts +0 -261
- package/src/openapi/platform/models/workflows.ts +0 -1943
- package/src/openapi/platform/services/announcement-banner-service.ts +0 -142
- package/src/openapi/platform/services/app-data-policies-service.ts +0 -136
- package/src/openapi/platform/services/app-migration-service.ts +0 -289
- package/src/openapi/platform/services/app-properties-service.ts +0 -441
- package/src/openapi/platform/services/application-roles-service.ts +0 -247
- package/src/openapi/platform/services/audit-records-service.ts +0 -164
- package/src/openapi/platform/services/avatars-service.ts +0 -769
- package/src/openapi/platform/services/classification-levels-service.ts +0 -131
- package/src/openapi/platform/services/dashboards-service.ts +0 -1721
- package/src/openapi/platform/services/dynamic-modules-service.ts +0 -127
- package/src/openapi/platform/services/filter-sharing-service.ts +0 -687
- package/src/openapi/platform/services/filters-service.ts +0 -1901
- package/src/openapi/platform/services/group-and-user-picker-service.ts +0 -224
- package/src/openapi/platform/services/groups-service.ts +0 -751
- package/src/openapi/platform/services/issue-attachments-service.ts +0 -900
- package/src/openapi/platform/services/issue-comment-properties-service.ts +0 -324
- package/src/openapi/platform/services/issue-comments-service.ts +0 -812
- package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +0 -277
- package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +0 -1339
- package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +0 -994
- package/src/openapi/platform/services/issue-custom-field-options-service.ts +0 -651
- package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +0 -201
- package/src/openapi/platform/services/issue-field-configurations-service.ts +0 -1294
- package/src/openapi/platform/services/issue-fields-service.ts +0 -837
- package/src/openapi/platform/services/issue-link-types-service.ts +0 -360
- package/src/openapi/platform/services/issue-links-service.ts +0 -345
- package/src/openapi/platform/services/issue-navigator-settings-service.ts +0 -119
- package/src/openapi/platform/services/issue-notification-schemes-service.ts +0 -1209
- package/src/openapi/platform/services/issue-priorities-service.ts +0 -575
- package/src/openapi/platform/services/issue-properties-service.ts +0 -606
- package/src/openapi/platform/services/issue-remote-links-service.ts +0 -597
- package/src/openapi/platform/services/issue-resolutions-service.ts +0 -534
- package/src/openapi/platform/services/issue-search-service.ts +0 -1139
- package/src/openapi/platform/services/issue-security-level-service.ts +0 -250
- package/src/openapi/platform/services/issue-security-schemes-service.ts +0 -1240
- package/src/openapi/platform/services/issue-type-properties-service.ts +0 -325
- package/src/openapi/platform/services/issue-type-schemes-service.ts +0 -940
- package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +0 -994
- package/src/openapi/platform/services/issue-types-service.ts +0 -679
- package/src/openapi/platform/services/issue-votes-service.ts +0 -221
- package/src/openapi/platform/services/issue-watchers-service.ts +0 -331
- package/src/openapi/platform/services/issue-worklog-properties-service.ts +0 -348
- package/src/openapi/platform/services/issue-worklogs-service.ts +0 -1089
- package/src/openapi/platform/services/issues-service.ts +0 -3346
- package/src/openapi/platform/services/jira-expressions-service.ts +0 -407
- package/src/openapi/platform/services/jira-settings-service.ts +0 -415
- package/src/openapi/platform/services/jql-functions-apps-service.ts +0 -219
- package/src/openapi/platform/services/jql-service.ts +0 -896
- package/src/openapi/platform/services/labels-service.ts +0 -89
- package/src/openapi/platform/services/license-metrics-service.ts +0 -216
- package/src/openapi/platform/services/myself-service.ts +0 -520
- package/src/openapi/platform/services/permission-schemes-service.ts +0 -926
- package/src/openapi/platform/services/permissions-service.ts +0 -407
- package/src/openapi/platform/services/priority-schemes-service.ts +0 -1001
- package/src/openapi/platform/services/project-avatars-service.ts +0 -341
- package/src/openapi/platform/services/project-categories-service.ts +0 -318
- package/src/openapi/platform/services/project-classification-levels-service.ts +0 -232
- package/src/openapi/platform/services/project-components-service.ts +0 -1332
- package/src/openapi/platform/services/project-email-service.ts +0 -161
- package/src/openapi/platform/services/project-features-service.ts +0 -207
- package/src/openapi/platform/services/project-key-and-name-validation-service.ts +0 -200
- package/src/openapi/platform/services/project-permission-schemes-service.ts +0 -384
- package/src/openapi/platform/services/project-properties-service.ts +0 -320
- package/src/openapi/platform/services/project-role-actors-service.ts +0 -627
- package/src/openapi/platform/services/project-roles-service.ts +0 -867
- package/src/openapi/platform/services/project-types-service.ts +0 -297
- package/src/openapi/platform/services/project-versions-service.ts +0 -1287
- package/src/openapi/platform/services/projects-service.ts +0 -2196
- package/src/openapi/platform/services/screen-schemes-service.ts +0 -334
- package/src/openapi/platform/services/screen-tab-fields-service.ts +0 -276
- package/src/openapi/platform/services/screen-tabs-service.ts +0 -421
- package/src/openapi/platform/services/screens-service.ts +0 -528
- package/src/openapi/platform/services/server-info-service.ts +0 -88
- package/src/openapi/platform/services/service-registry-service.ts +0 -89
- package/src/openapi/platform/services/status-service.ts +0 -498
- package/src/openapi/platform/services/tasks-service.ts +0 -159
- package/src/openapi/platform/services/time-tracking-service.ts +0 -386
- package/src/openapi/platform/services/ui-modifications-apps-service.ts +0 -403
- package/src/openapi/platform/services/user-properties-service.ts +0 -413
- package/src/openapi/platform/services/user-search-service.ts +0 -1214
- package/src/openapi/platform/services/users-service.ts +0 -1108
- package/src/openapi/platform/services/webhooks-service.ts +0 -458
- package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +0 -1313
- package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +0 -189
- package/src/openapi/platform/services/workflow-schemes-service.ts +0 -1617
- package/src/openapi/platform/services/workflow-status-categories-service.ts +0 -151
- package/src/openapi/platform/services/workflow-statuses-service.ts +0 -176
- package/src/openapi/platform/services/workflow-transition-properties-service.ts +0 -388
- package/src/openapi/platform/services/workflow-transition-rules-service.ts +0 -485
- package/src/openapi/platform/services/workflows-service.ts +0 -3477
- package/src/openapi/platform/validation-schema-storage.ts +0 -186
- package/src/openapi/software/base-jira-software-api-client.ts +0 -447
- package/src/openapi/software/core/common-http-client.ts +0 -723
- package/src/openapi/software/core/common-http-service.ts +0 -22
- package/src/openapi/software/core/common-validation-schema-storage.ts +0 -105
- package/src/openapi/software/models/board.ts +0 -918
- package/src/openapi/software/services/backlog-service.ts +0 -160
- package/src/openapi/software/services/board-service.ts +0 -4189
- package/src/openapi/software/services/builds-service.ts +0 -571
- package/src/openapi/software/services/deployments-service.ts +0 -403
- package/src/openapi/software/services/dev-ops-components-service.ts +0 -371
- package/src/openapi/software/services/development-information-service.ts +0 -2357
- package/src/openapi/software/services/epic-service.ts +0 -854
- package/src/openapi/software/services/feature-flags-service.ts +0 -303
- package/src/openapi/software/services/issue-service.ts +0 -529
- package/src/openapi/software/services/operations-service.ts +0 -741
- package/src/openapi/software/services/remote-links-service.ts +0 -653
- package/src/openapi/software/services/security-information-service.ts +0 -495
- package/src/openapi/software/services/sprint-service.ts +0 -969
- package/src/openapi/software/validation-schema-storage.ts +0 -186
- package/tsconfig.build.json +0 -7
- package/tsconfig.json +0 -4
|
@@ -1,994 +0,0 @@
|
|
|
1
|
-
// DO NOT EDIT!
|
|
2
|
-
// This file is generated by "api-typescript-generator".
|
|
3
|
-
// To update this file run "yarn build:openapi".
|
|
4
|
-
import { z } from "zod";
|
|
5
|
-
|
|
6
|
-
import * as commonHttpClient from "../core/common-http-client";
|
|
7
|
-
import { CommonHttpService } from "../core/common-http-service";
|
|
8
|
-
import {
|
|
9
|
-
type IssueFieldOption,
|
|
10
|
-
type IssueFieldOptionCreateBean,
|
|
11
|
-
type PageBeanIssueFieldOption,
|
|
12
|
-
registerIssueCustomFieldOptionsAppsValidationSchemas,
|
|
13
|
-
} from "../models/issue-custom-field-options-apps";
|
|
14
|
-
import { validationSchemaStorage } from "../validation-schema-storage";
|
|
15
|
-
/**
|
|
16
|
-
* This resource represents custom issue field select list options created by a
|
|
17
|
-
* Connect app. See [Issue custom field
|
|
18
|
-
* options](#api-group-Issue-custom-field-options) to manipulate options created
|
|
19
|
-
* in Jira or using the REST API.
|
|
20
|
-
*
|
|
21
|
-
* A select list issue field is a type of [issue
|
|
22
|
-
* field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
|
|
23
|
-
* that enables a user to select an option from a list. Use it to add, remove, and
|
|
24
|
-
* update the options of a select list issue field.
|
|
25
|
-
*/
|
|
26
|
-
export class IssueCustomFieldOptionsAppsService extends CommonHttpService {
|
|
27
|
-
/**
|
|
28
|
-
* Creates an option for a select list issue field.
|
|
29
|
-
*
|
|
30
|
-
* Note that this operation **only works for issue field select list options added
|
|
31
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
32
|
-
* created in Jira or using operations from the [Issue custom field
|
|
33
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
34
|
-
*
|
|
35
|
-
* Each field can have a maximum of 10000 options, and each option can have a
|
|
36
|
-
* maximum of 10000 scopes.
|
|
37
|
-
*
|
|
38
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
39
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
|
|
40
|
-
* not required for the app providing the field.
|
|
41
|
-
*
|
|
42
|
-
* @returns Returned if the request is successful.
|
|
43
|
-
*
|
|
44
|
-
* example: {
|
|
45
|
-
* "id": 1,
|
|
46
|
-
* "value": "Team 1",
|
|
47
|
-
* "properties": {
|
|
48
|
-
* "leader": {
|
|
49
|
-
* "name": "Leader Name",
|
|
50
|
-
* "email": "lname@example.com"
|
|
51
|
-
* },
|
|
52
|
-
* "members": 42,
|
|
53
|
-
* "description": "The team's description",
|
|
54
|
-
* "founded": "2016-06-06"
|
|
55
|
-
* },
|
|
56
|
-
* "config": {
|
|
57
|
-
* "scope": {
|
|
58
|
-
* "projects": [],
|
|
59
|
-
* "projects2": [
|
|
60
|
-
* {
|
|
61
|
-
* "id": 1001,
|
|
62
|
-
* "attributes": [
|
|
63
|
-
* "notSelectable"
|
|
64
|
-
* ]
|
|
65
|
-
* },
|
|
66
|
-
* {
|
|
67
|
-
* "id": 1002,
|
|
68
|
-
* "attributes": [
|
|
69
|
-
* "notSelectable"
|
|
70
|
-
* ]
|
|
71
|
-
* }
|
|
72
|
-
* ],
|
|
73
|
-
* "global": {}
|
|
74
|
-
* },
|
|
75
|
-
* "attributes": []
|
|
76
|
-
* }
|
|
77
|
-
* }
|
|
78
|
-
* @path {POST} /rest/api/3/field/{fieldKey}/option
|
|
79
|
-
* @scopes-current manage:jira-configuration
|
|
80
|
-
* @scopes-beta write:field.option:jira
|
|
81
|
-
*/
|
|
82
|
-
createIssueFieldOption({
|
|
83
|
-
fieldKey,
|
|
84
|
-
issueFieldOptionCreateBean,
|
|
85
|
-
}: {
|
|
86
|
-
/**
|
|
87
|
-
* The field key is specified in the following format:
|
|
88
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
89
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
90
|
-
* one of the following:
|
|
91
|
-
*
|
|
92
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
93
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
94
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
95
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
96
|
-
* value is returned in `key`. For example, `"key":
|
|
97
|
-
* "teams-add-on__team-issue-field"`
|
|
98
|
-
*/
|
|
99
|
-
fieldKey: string;
|
|
100
|
-
/**
|
|
101
|
-
* @example {
|
|
102
|
-
* "config": {
|
|
103
|
-
* "attributes": [],
|
|
104
|
-
* "scope": {
|
|
105
|
-
* "global": {},
|
|
106
|
-
* "projects": [],
|
|
107
|
-
* "projects2": [
|
|
108
|
-
* {
|
|
109
|
-
* "attributes": [
|
|
110
|
-
* "notSelectable"
|
|
111
|
-
* ],
|
|
112
|
-
* "id": 1001
|
|
113
|
-
* },
|
|
114
|
-
* {
|
|
115
|
-
* "attributes": [
|
|
116
|
-
* "notSelectable"
|
|
117
|
-
* ],
|
|
118
|
-
* "id": 1002
|
|
119
|
-
* }
|
|
120
|
-
* ]
|
|
121
|
-
* }
|
|
122
|
-
* },
|
|
123
|
-
* "properties": {
|
|
124
|
-
* "description": "The team's description",
|
|
125
|
-
* "founded": "2016-06-06",
|
|
126
|
-
* "leader": {
|
|
127
|
-
* "email": "lname@example.com",
|
|
128
|
-
* "name": "Leader Name"
|
|
129
|
-
* },
|
|
130
|
-
* "members": 42
|
|
131
|
-
* },
|
|
132
|
-
* "value": "Team 1"
|
|
133
|
-
* }
|
|
134
|
-
*/
|
|
135
|
-
issueFieldOptionCreateBean: IssueFieldOptionCreateBean;
|
|
136
|
-
}): Promise<IssueFieldOption> {
|
|
137
|
-
return this.getClientInstance()
|
|
138
|
-
.request({
|
|
139
|
-
path: "/rest/api/3/field/{fieldKey}/option",
|
|
140
|
-
method: "POST",
|
|
141
|
-
pathParams: {
|
|
142
|
-
fieldKey,
|
|
143
|
-
},
|
|
144
|
-
headers: {
|
|
145
|
-
"Content-Type": "application/json",
|
|
146
|
-
},
|
|
147
|
-
body: issueFieldOptionCreateBean,
|
|
148
|
-
})
|
|
149
|
-
.then(
|
|
150
|
-
this.getClientInstance().responseHandler({
|
|
151
|
-
200: {
|
|
152
|
-
"application/json": "json",
|
|
153
|
-
},
|
|
154
|
-
}),
|
|
155
|
-
)
|
|
156
|
-
.then(
|
|
157
|
-
commonHttpClient.castResponse<{
|
|
158
|
-
status: 200;
|
|
159
|
-
mediaType: "application/json";
|
|
160
|
-
body: IssueFieldOption;
|
|
161
|
-
}>(),
|
|
162
|
-
)
|
|
163
|
-
.then(
|
|
164
|
-
validationSchemaStorage.validator(
|
|
165
|
-
"IssueCustomFieldOptionsAppsService.createIssueFieldOption.response",
|
|
166
|
-
),
|
|
167
|
-
)
|
|
168
|
-
.then(commonHttpClient.getBody);
|
|
169
|
-
}
|
|
170
|
-
/**
|
|
171
|
-
* Deletes an option from a select list issue field.
|
|
172
|
-
*
|
|
173
|
-
* Note that this operation **only works for issue field select list options added
|
|
174
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
175
|
-
* created in Jira or using operations from the [Issue custom field
|
|
176
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
177
|
-
*
|
|
178
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
179
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
|
|
180
|
-
* not required for the app providing the field.
|
|
181
|
-
*
|
|
182
|
-
* @returns Returned if the field option is deleted.
|
|
183
|
-
* @path {DELETE} /rest/api/3/field/{fieldKey}/option/{optionId}
|
|
184
|
-
* @scopes-current manage:jira-configuration
|
|
185
|
-
* @scopes-beta delete:field.option:jira
|
|
186
|
-
*/
|
|
187
|
-
deleteIssueFieldOption({
|
|
188
|
-
fieldKey,
|
|
189
|
-
optionId,
|
|
190
|
-
}: {
|
|
191
|
-
/**
|
|
192
|
-
* The field key is specified in the following format:
|
|
193
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
194
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
195
|
-
* one of the following:
|
|
196
|
-
*
|
|
197
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
198
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
199
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
200
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
201
|
-
* value is returned in `key`. For example, `"key":
|
|
202
|
-
* "teams-add-on__team-issue-field"`
|
|
203
|
-
*/
|
|
204
|
-
fieldKey: string;
|
|
205
|
-
/** The ID of the option to be deleted. */
|
|
206
|
-
optionId: number;
|
|
207
|
-
}): Promise<void> {
|
|
208
|
-
return this.getClientInstance()
|
|
209
|
-
.request({
|
|
210
|
-
path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
|
|
211
|
-
method: "DELETE",
|
|
212
|
-
pathParams: {
|
|
213
|
-
fieldKey,
|
|
214
|
-
optionId,
|
|
215
|
-
},
|
|
216
|
-
})
|
|
217
|
-
.then(
|
|
218
|
-
this.getClientInstance().responseHandler({
|
|
219
|
-
204: {
|
|
220
|
-
"application/json": "json",
|
|
221
|
-
},
|
|
222
|
-
}),
|
|
223
|
-
)
|
|
224
|
-
.then(
|
|
225
|
-
commonHttpClient.castResponse<{
|
|
226
|
-
status: 204;
|
|
227
|
-
mediaType: "application/json";
|
|
228
|
-
body: void;
|
|
229
|
-
}>(),
|
|
230
|
-
)
|
|
231
|
-
.then(
|
|
232
|
-
validationSchemaStorage.validator(
|
|
233
|
-
"IssueCustomFieldOptionsAppsService.deleteIssueFieldOption.response",
|
|
234
|
-
),
|
|
235
|
-
)
|
|
236
|
-
.then(commonHttpClient.getBody);
|
|
237
|
-
}
|
|
238
|
-
/**
|
|
239
|
-
* Returns a [paginated](#pagination) list of all the options of a select list
|
|
240
|
-
* issue field. A select list issue field is a type of [issue
|
|
241
|
-
* field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
|
|
242
|
-
* that enables a user to select a value from a list of options.
|
|
243
|
-
*
|
|
244
|
-
* Note that this operation **only works for issue field select list options added
|
|
245
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
246
|
-
* created in Jira or using operations from the [Issue custom field
|
|
247
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
248
|
-
*
|
|
249
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
250
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
|
|
251
|
-
* not required for the app providing the field.
|
|
252
|
-
*
|
|
253
|
-
* @returns Returned if the request is successful.
|
|
254
|
-
*
|
|
255
|
-
* example: {
|
|
256
|
-
* "isLast": false,
|
|
257
|
-
* "maxResults": 1,
|
|
258
|
-
* "nextPage":
|
|
259
|
-
* "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=1&maxResults=1",
|
|
260
|
-
* "self":
|
|
261
|
-
* "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1",
|
|
262
|
-
* "startAt": 0,
|
|
263
|
-
* "total": 10,
|
|
264
|
-
* "values": [
|
|
265
|
-
* {
|
|
266
|
-
* "id": 1,
|
|
267
|
-
* "value": "Team 1",
|
|
268
|
-
* "properties": {
|
|
269
|
-
* "leader": {
|
|
270
|
-
* "name": "Leader Name",
|
|
271
|
-
* "email": "lname@example.com"
|
|
272
|
-
* },
|
|
273
|
-
* "members": 42,
|
|
274
|
-
* "description": "The team's description",
|
|
275
|
-
* "founded": "2016-06-06"
|
|
276
|
-
* },
|
|
277
|
-
* "config": {
|
|
278
|
-
* "scope": {
|
|
279
|
-
* "projects": [],
|
|
280
|
-
* "projects2": [
|
|
281
|
-
* {
|
|
282
|
-
* "id": 1001,
|
|
283
|
-
* "attributes": [
|
|
284
|
-
* "notSelectable"
|
|
285
|
-
* ]
|
|
286
|
-
* },
|
|
287
|
-
* {
|
|
288
|
-
* "id": 1002,
|
|
289
|
-
* "attributes": [
|
|
290
|
-
* "notSelectable"
|
|
291
|
-
* ]
|
|
292
|
-
* }
|
|
293
|
-
* ],
|
|
294
|
-
* "global": {}
|
|
295
|
-
* },
|
|
296
|
-
* "attributes": []
|
|
297
|
-
* }
|
|
298
|
-
* }
|
|
299
|
-
* ]
|
|
300
|
-
* }
|
|
301
|
-
* @path {GET} /rest/api/3/field/{fieldKey}/option
|
|
302
|
-
* @scopes-current manage:jira-configuration
|
|
303
|
-
* @scopes-beta read:field.option:jira
|
|
304
|
-
*/
|
|
305
|
-
getAllIssueFieldOptions({
|
|
306
|
-
fieldKey,
|
|
307
|
-
startAt,
|
|
308
|
-
maxResults,
|
|
309
|
-
}: {
|
|
310
|
-
/**
|
|
311
|
-
* The field key is specified in the following format:
|
|
312
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
313
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
314
|
-
* one of the following:
|
|
315
|
-
*
|
|
316
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
317
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
318
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
319
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
320
|
-
* value is returned in `key`. For example, `"key":
|
|
321
|
-
* "teams-add-on__team-issue-field"`
|
|
322
|
-
*/
|
|
323
|
-
fieldKey: string;
|
|
324
|
-
/** The index of the first item to return in a page of results (page offset). */
|
|
325
|
-
startAt?: number;
|
|
326
|
-
/** The maximum number of items to return per page. */
|
|
327
|
-
maxResults?: number;
|
|
328
|
-
}): Promise<PageBeanIssueFieldOption> {
|
|
329
|
-
return this.getClientInstance()
|
|
330
|
-
.request({
|
|
331
|
-
path: "/rest/api/3/field/{fieldKey}/option",
|
|
332
|
-
method: "GET",
|
|
333
|
-
pathParams: {
|
|
334
|
-
fieldKey,
|
|
335
|
-
},
|
|
336
|
-
query: {
|
|
337
|
-
startAt,
|
|
338
|
-
maxResults,
|
|
339
|
-
},
|
|
340
|
-
})
|
|
341
|
-
.then(
|
|
342
|
-
this.getClientInstance().responseHandler({
|
|
343
|
-
200: {
|
|
344
|
-
"application/json": "json",
|
|
345
|
-
},
|
|
346
|
-
}),
|
|
347
|
-
)
|
|
348
|
-
.then(
|
|
349
|
-
commonHttpClient.castResponse<{
|
|
350
|
-
status: 200;
|
|
351
|
-
mediaType: "application/json";
|
|
352
|
-
body: PageBeanIssueFieldOption;
|
|
353
|
-
}>(),
|
|
354
|
-
)
|
|
355
|
-
.then(
|
|
356
|
-
validationSchemaStorage.validator(
|
|
357
|
-
"IssueCustomFieldOptionsAppsService.getAllIssueFieldOptions.response",
|
|
358
|
-
),
|
|
359
|
-
)
|
|
360
|
-
.then(commonHttpClient.getBody);
|
|
361
|
-
}
|
|
362
|
-
/**
|
|
363
|
-
* Returns an option from a select list issue field.
|
|
364
|
-
*
|
|
365
|
-
* Note that this operation **only works for issue field select list options added
|
|
366
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
367
|
-
* created in Jira or using operations from the [Issue custom field
|
|
368
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
369
|
-
*
|
|
370
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
371
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
|
|
372
|
-
* not required for the app providing the field.
|
|
373
|
-
*
|
|
374
|
-
* @returns Returned if the requested option is returned.
|
|
375
|
-
*
|
|
376
|
-
* example: {
|
|
377
|
-
* "id": 1,
|
|
378
|
-
* "value": "Team 1",
|
|
379
|
-
* "properties": {
|
|
380
|
-
* "leader": {
|
|
381
|
-
* "name": "Leader Name",
|
|
382
|
-
* "email": "lname@example.com"
|
|
383
|
-
* },
|
|
384
|
-
* "members": 42,
|
|
385
|
-
* "description": "The team's description",
|
|
386
|
-
* "founded": "2016-06-06"
|
|
387
|
-
* },
|
|
388
|
-
* "config": {
|
|
389
|
-
* "scope": {
|
|
390
|
-
* "projects": [],
|
|
391
|
-
* "projects2": [
|
|
392
|
-
* {
|
|
393
|
-
* "id": 1001,
|
|
394
|
-
* "attributes": [
|
|
395
|
-
* "notSelectable"
|
|
396
|
-
* ]
|
|
397
|
-
* },
|
|
398
|
-
* {
|
|
399
|
-
* "id": 1002,
|
|
400
|
-
* "attributes": [
|
|
401
|
-
* "notSelectable"
|
|
402
|
-
* ]
|
|
403
|
-
* }
|
|
404
|
-
* ],
|
|
405
|
-
* "global": {}
|
|
406
|
-
* },
|
|
407
|
-
* "attributes": []
|
|
408
|
-
* }
|
|
409
|
-
* }
|
|
410
|
-
* @path {GET} /rest/api/3/field/{fieldKey}/option/{optionId}
|
|
411
|
-
* @scopes-current manage:jira-configuration
|
|
412
|
-
* @scopes-beta read:field.option:jira
|
|
413
|
-
*/
|
|
414
|
-
getIssueFieldOption({
|
|
415
|
-
fieldKey,
|
|
416
|
-
optionId,
|
|
417
|
-
}: {
|
|
418
|
-
/**
|
|
419
|
-
* The field key is specified in the following format:
|
|
420
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
421
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
422
|
-
* one of the following:
|
|
423
|
-
*
|
|
424
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
425
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
426
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
427
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
428
|
-
* value is returned in `key`. For example, `"key":
|
|
429
|
-
* "teams-add-on__team-issue-field"`
|
|
430
|
-
*/
|
|
431
|
-
fieldKey: string;
|
|
432
|
-
/** The ID of the option to be returned. */
|
|
433
|
-
optionId: number;
|
|
434
|
-
}): Promise<IssueFieldOption> {
|
|
435
|
-
return this.getClientInstance()
|
|
436
|
-
.request({
|
|
437
|
-
path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
|
|
438
|
-
method: "GET",
|
|
439
|
-
pathParams: {
|
|
440
|
-
fieldKey,
|
|
441
|
-
optionId,
|
|
442
|
-
},
|
|
443
|
-
})
|
|
444
|
-
.then(
|
|
445
|
-
this.getClientInstance().responseHandler({
|
|
446
|
-
200: {
|
|
447
|
-
"application/json": "json",
|
|
448
|
-
},
|
|
449
|
-
}),
|
|
450
|
-
)
|
|
451
|
-
.then(
|
|
452
|
-
commonHttpClient.castResponse<{
|
|
453
|
-
status: 200;
|
|
454
|
-
mediaType: "application/json";
|
|
455
|
-
body: IssueFieldOption;
|
|
456
|
-
}>(),
|
|
457
|
-
)
|
|
458
|
-
.then(
|
|
459
|
-
validationSchemaStorage.validator(
|
|
460
|
-
"IssueCustomFieldOptionsAppsService.getIssueFieldOption.response",
|
|
461
|
-
),
|
|
462
|
-
)
|
|
463
|
-
.then(commonHttpClient.getBody);
|
|
464
|
-
}
|
|
465
|
-
/**
|
|
466
|
-
* Returns a [paginated](#pagination) list of options for a select list issue
|
|
467
|
-
* field that can be viewed and selected by the user.
|
|
468
|
-
*
|
|
469
|
-
* Note that this operation **only works for issue field select list options added
|
|
470
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
471
|
-
* created in Jira or using operations from the [Issue custom field
|
|
472
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
473
|
-
*
|
|
474
|
-
* **[Permissions](#permissions) required:** Permission to access Jira.
|
|
475
|
-
*
|
|
476
|
-
* @returns Returned if the request is successful.
|
|
477
|
-
*
|
|
478
|
-
* example: {
|
|
479
|
-
* "isLast": false,
|
|
480
|
-
* "maxResults": 1,
|
|
481
|
-
* "nextPage":
|
|
482
|
-
* "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1",
|
|
483
|
-
* "self":
|
|
484
|
-
* "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1",
|
|
485
|
-
* "startAt": 0,
|
|
486
|
-
* "total": 10,
|
|
487
|
-
* "values": [
|
|
488
|
-
* {
|
|
489
|
-
* "id": 1,
|
|
490
|
-
* "value": "Team 1",
|
|
491
|
-
* "properties": {
|
|
492
|
-
* "leader": {
|
|
493
|
-
* "name": "Leader Name",
|
|
494
|
-
* "email": "lname@example.com"
|
|
495
|
-
* },
|
|
496
|
-
* "members": 42,
|
|
497
|
-
* "description": "The team's description",
|
|
498
|
-
* "founded": "2016-06-06"
|
|
499
|
-
* }
|
|
500
|
-
* }
|
|
501
|
-
* ]
|
|
502
|
-
* }
|
|
503
|
-
* @path {GET} /rest/api/3/field/{fieldKey}/option/suggestions/edit
|
|
504
|
-
* @scopes-current read:jira-work
|
|
505
|
-
* @scopes-beta read:field.option:jira
|
|
506
|
-
*/
|
|
507
|
-
getSelectableIssueFieldOptions({
|
|
508
|
-
fieldKey,
|
|
509
|
-
startAt,
|
|
510
|
-
maxResults,
|
|
511
|
-
projectId,
|
|
512
|
-
}: {
|
|
513
|
-
/**
|
|
514
|
-
* The field key is specified in the following format:
|
|
515
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
516
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
517
|
-
* one of the following:
|
|
518
|
-
*
|
|
519
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
520
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
521
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
522
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
523
|
-
* value is returned in `key`. For example, `"key":
|
|
524
|
-
* "teams-add-on__team-issue-field"`
|
|
525
|
-
*/
|
|
526
|
-
fieldKey: string;
|
|
527
|
-
/** The index of the first item to return in a page of results (page offset). */
|
|
528
|
-
startAt?: number;
|
|
529
|
-
/** The maximum number of items to return per page. */
|
|
530
|
-
maxResults?: number;
|
|
531
|
-
/** Filters the results to options that are only available in the specified project. */
|
|
532
|
-
projectId?: number;
|
|
533
|
-
}): Promise<PageBeanIssueFieldOption> {
|
|
534
|
-
return this.getClientInstance()
|
|
535
|
-
.request({
|
|
536
|
-
path: "/rest/api/3/field/{fieldKey}/option/suggestions/edit",
|
|
537
|
-
method: "GET",
|
|
538
|
-
pathParams: {
|
|
539
|
-
fieldKey,
|
|
540
|
-
},
|
|
541
|
-
query: {
|
|
542
|
-
startAt,
|
|
543
|
-
maxResults,
|
|
544
|
-
projectId,
|
|
545
|
-
},
|
|
546
|
-
})
|
|
547
|
-
.then(
|
|
548
|
-
this.getClientInstance().responseHandler({
|
|
549
|
-
200: {
|
|
550
|
-
"application/json": "json",
|
|
551
|
-
},
|
|
552
|
-
}),
|
|
553
|
-
)
|
|
554
|
-
.then(
|
|
555
|
-
commonHttpClient.castResponse<{
|
|
556
|
-
status: 200;
|
|
557
|
-
mediaType: "application/json";
|
|
558
|
-
body: PageBeanIssueFieldOption;
|
|
559
|
-
}>(),
|
|
560
|
-
)
|
|
561
|
-
.then(
|
|
562
|
-
validationSchemaStorage.validator(
|
|
563
|
-
"IssueCustomFieldOptionsAppsService.getSelectableIssueFieldOptions.response",
|
|
564
|
-
),
|
|
565
|
-
)
|
|
566
|
-
.then(commonHttpClient.getBody);
|
|
567
|
-
}
|
|
568
|
-
/**
|
|
569
|
-
* Returns a [paginated](#pagination) list of options for a select list issue
|
|
570
|
-
* field that can be viewed by the user.
|
|
571
|
-
*
|
|
572
|
-
* Note that this operation **only works for issue field select list options added
|
|
573
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
574
|
-
* created in Jira or using operations from the [Issue custom field
|
|
575
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
576
|
-
*
|
|
577
|
-
* **[Permissions](#permissions) required:** Permission to access Jira.
|
|
578
|
-
*
|
|
579
|
-
* @returns Returned if the request is successful.
|
|
580
|
-
*
|
|
581
|
-
* example: {
|
|
582
|
-
* "isLast": false,
|
|
583
|
-
* "maxResults": 1,
|
|
584
|
-
* "nextPage":
|
|
585
|
-
* "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1",
|
|
586
|
-
* "self":
|
|
587
|
-
* "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1",
|
|
588
|
-
* "startAt": 0,
|
|
589
|
-
* "total": 10,
|
|
590
|
-
* "values": [
|
|
591
|
-
* {
|
|
592
|
-
* "id": 1,
|
|
593
|
-
* "value": "Team 1",
|
|
594
|
-
* "properties": {
|
|
595
|
-
* "leader": {
|
|
596
|
-
* "name": "Leader Name",
|
|
597
|
-
* "email": "lname@example.com"
|
|
598
|
-
* },
|
|
599
|
-
* "members": 42,
|
|
600
|
-
* "description": "The team's description",
|
|
601
|
-
* "founded": "2016-06-06"
|
|
602
|
-
* }
|
|
603
|
-
* }
|
|
604
|
-
* ]
|
|
605
|
-
* }
|
|
606
|
-
* @path {GET} /rest/api/3/field/{fieldKey}/option/suggestions/search
|
|
607
|
-
* @scopes-current read:jira-work
|
|
608
|
-
* @scopes-beta read:field.option:jira
|
|
609
|
-
*/
|
|
610
|
-
getVisibleIssueFieldOptions({
|
|
611
|
-
fieldKey,
|
|
612
|
-
startAt,
|
|
613
|
-
maxResults,
|
|
614
|
-
projectId,
|
|
615
|
-
}: {
|
|
616
|
-
/**
|
|
617
|
-
* The field key is specified in the following format:
|
|
618
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
619
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
620
|
-
* one of the following:
|
|
621
|
-
*
|
|
622
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
623
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
624
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
625
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
626
|
-
* value is returned in `key`. For example, `"key":
|
|
627
|
-
* "teams-add-on__team-issue-field"`
|
|
628
|
-
*/
|
|
629
|
-
fieldKey: string;
|
|
630
|
-
/** The index of the first item to return in a page of results (page offset). */
|
|
631
|
-
startAt?: number;
|
|
632
|
-
/** The maximum number of items to return per page. */
|
|
633
|
-
maxResults?: number;
|
|
634
|
-
/** Filters the results to options that are only available in the specified project. */
|
|
635
|
-
projectId?: number;
|
|
636
|
-
}): Promise<PageBeanIssueFieldOption> {
|
|
637
|
-
return this.getClientInstance()
|
|
638
|
-
.request({
|
|
639
|
-
path: "/rest/api/3/field/{fieldKey}/option/suggestions/search",
|
|
640
|
-
method: "GET",
|
|
641
|
-
pathParams: {
|
|
642
|
-
fieldKey,
|
|
643
|
-
},
|
|
644
|
-
query: {
|
|
645
|
-
startAt,
|
|
646
|
-
maxResults,
|
|
647
|
-
projectId,
|
|
648
|
-
},
|
|
649
|
-
})
|
|
650
|
-
.then(
|
|
651
|
-
this.getClientInstance().responseHandler({
|
|
652
|
-
200: {
|
|
653
|
-
"application/json": "json",
|
|
654
|
-
},
|
|
655
|
-
}),
|
|
656
|
-
)
|
|
657
|
-
.then(
|
|
658
|
-
commonHttpClient.castResponse<{
|
|
659
|
-
status: 200;
|
|
660
|
-
mediaType: "application/json";
|
|
661
|
-
body: PageBeanIssueFieldOption;
|
|
662
|
-
}>(),
|
|
663
|
-
)
|
|
664
|
-
.then(
|
|
665
|
-
validationSchemaStorage.validator(
|
|
666
|
-
"IssueCustomFieldOptionsAppsService.getVisibleIssueFieldOptions.response",
|
|
667
|
-
),
|
|
668
|
-
)
|
|
669
|
-
.then(commonHttpClient.getBody);
|
|
670
|
-
}
|
|
671
|
-
/**
|
|
672
|
-
* Deselects an issue-field select-list option from all issues where it is
|
|
673
|
-
* selected. A different option can be selected to replace the deselected option.
|
|
674
|
-
* The update can also be limited to a smaller set of issues by using a JQL query.
|
|
675
|
-
*
|
|
676
|
-
* Connect and Forge app users with *Administer Jira* [global
|
|
677
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg) can override the screen
|
|
678
|
-
* security configuration using `overrideScreenSecurity` and
|
|
679
|
-
* `overrideEditableFlag`.
|
|
680
|
-
*
|
|
681
|
-
* This is an [asynchronous operation](#async). The response object contains a
|
|
682
|
-
* link to the long-running task.
|
|
683
|
-
*
|
|
684
|
-
* Note that this operation **only works for issue field select list options added
|
|
685
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
686
|
-
* created in Jira or using operations from the [Issue custom field
|
|
687
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
688
|
-
*
|
|
689
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
690
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
|
|
691
|
-
* not required for the app providing the field.
|
|
692
|
-
*
|
|
693
|
-
* @path {DELETE} /rest/api/3/field/{fieldKey}/option/{optionId}/issue
|
|
694
|
-
* @scopes-current manage:jira-configuration
|
|
695
|
-
* @scopes-beta write:field.option:jira, delete:field.option:jira
|
|
696
|
-
*/
|
|
697
|
-
replaceIssueFieldOption({
|
|
698
|
-
fieldKey,
|
|
699
|
-
optionId,
|
|
700
|
-
replaceWith,
|
|
701
|
-
jql,
|
|
702
|
-
overrideScreenSecurity,
|
|
703
|
-
overrideEditableFlag,
|
|
704
|
-
}: {
|
|
705
|
-
/**
|
|
706
|
-
* The field key is specified in the following format:
|
|
707
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
708
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
709
|
-
* one of the following:
|
|
710
|
-
*
|
|
711
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
712
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
713
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
714
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
715
|
-
* value is returned in `key`. For example, `"key":
|
|
716
|
-
* "teams-add-on__team-issue-field"`
|
|
717
|
-
*/
|
|
718
|
-
fieldKey: string;
|
|
719
|
-
/** The ID of the option to be deselected. */
|
|
720
|
-
optionId: number;
|
|
721
|
-
/** The ID of the option that will replace the currently selected option. */
|
|
722
|
-
replaceWith?: number;
|
|
723
|
-
/**
|
|
724
|
-
* A JQL query that specifies the issues to be updated. For example,
|
|
725
|
-
* *project=10000*.
|
|
726
|
-
*/
|
|
727
|
-
jql?: string;
|
|
728
|
-
/**
|
|
729
|
-
* Whether screen security is overridden to enable hidden fields to be edited.
|
|
730
|
-
* Available to Connect and Forge app users with admin permission.
|
|
731
|
-
*/
|
|
732
|
-
overrideScreenSecurity?: boolean;
|
|
733
|
-
/**
|
|
734
|
-
* Whether screen security is overridden to enable uneditable fields to be edited.
|
|
735
|
-
* Available to Connect and Forge app users with *Administer Jira* [global
|
|
736
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
737
|
-
*/
|
|
738
|
-
overrideEditableFlag?: boolean;
|
|
739
|
-
}): Promise<void> {
|
|
740
|
-
return this.getClientInstance()
|
|
741
|
-
.request({
|
|
742
|
-
path: "/rest/api/3/field/{fieldKey}/option/{optionId}/issue",
|
|
743
|
-
method: "DELETE",
|
|
744
|
-
pathParams: {
|
|
745
|
-
fieldKey,
|
|
746
|
-
optionId,
|
|
747
|
-
},
|
|
748
|
-
query: {
|
|
749
|
-
replaceWith,
|
|
750
|
-
jql,
|
|
751
|
-
overrideScreenSecurity,
|
|
752
|
-
overrideEditableFlag,
|
|
753
|
-
},
|
|
754
|
-
})
|
|
755
|
-
.then(commonHttpClient.discardResult);
|
|
756
|
-
}
|
|
757
|
-
/**
|
|
758
|
-
* Updates or creates an option for a select list issue field. This operation
|
|
759
|
-
* requires that the option ID is provided when creating an option, therefore, the
|
|
760
|
-
* option ID needs to be specified as a path and body parameter. The option ID
|
|
761
|
-
* provided in the path and body must be identical.
|
|
762
|
-
*
|
|
763
|
-
* Note that this operation **only works for issue field select list options added
|
|
764
|
-
* by Connect apps**, it cannot be used with issue field select list options
|
|
765
|
-
* created in Jira or using operations from the [Issue custom field
|
|
766
|
-
* options](#api-group-Issue-custom-field-options) resource.
|
|
767
|
-
*
|
|
768
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
769
|
-
* permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
|
|
770
|
-
* not required for the app providing the field.
|
|
771
|
-
*
|
|
772
|
-
* @returns Returned if the option is updated or created.
|
|
773
|
-
*
|
|
774
|
-
* example: {
|
|
775
|
-
* "id": 1,
|
|
776
|
-
* "value": "Team 1",
|
|
777
|
-
* "properties": {
|
|
778
|
-
* "leader": {
|
|
779
|
-
* "name": "Leader Name",
|
|
780
|
-
* "email": "lname@example.com"
|
|
781
|
-
* },
|
|
782
|
-
* "members": 42,
|
|
783
|
-
* "description": "The team's description",
|
|
784
|
-
* "founded": "2016-06-06"
|
|
785
|
-
* },
|
|
786
|
-
* "config": {
|
|
787
|
-
* "scope": {
|
|
788
|
-
* "projects": [],
|
|
789
|
-
* "projects2": [
|
|
790
|
-
* {
|
|
791
|
-
* "id": 1001,
|
|
792
|
-
* "attributes": [
|
|
793
|
-
* "notSelectable"
|
|
794
|
-
* ]
|
|
795
|
-
* },
|
|
796
|
-
* {
|
|
797
|
-
* "id": 1002,
|
|
798
|
-
* "attributes": [
|
|
799
|
-
* "notSelectable"
|
|
800
|
-
* ]
|
|
801
|
-
* }
|
|
802
|
-
* ],
|
|
803
|
-
* "global": {}
|
|
804
|
-
* },
|
|
805
|
-
* "attributes": []
|
|
806
|
-
* }
|
|
807
|
-
* }
|
|
808
|
-
* @path {PUT} /rest/api/3/field/{fieldKey}/option/{optionId}
|
|
809
|
-
* @scopes-current manage:jira-configuration
|
|
810
|
-
* @scopes-beta write:field.option:jira
|
|
811
|
-
*/
|
|
812
|
-
updateIssueFieldOption({
|
|
813
|
-
fieldKey,
|
|
814
|
-
optionId,
|
|
815
|
-
issueFieldOption,
|
|
816
|
-
}: {
|
|
817
|
-
/**
|
|
818
|
-
* The field key is specified in the following format:
|
|
819
|
-
* **$(app-key)\_\_$(field-key)**. For example,
|
|
820
|
-
* *example-add-on\_\_example-issue-field*. To determine the `fieldKey` value, do
|
|
821
|
-
* one of the following:
|
|
822
|
-
*
|
|
823
|
-
* * open the app's plugin descriptor, then **app-key** is the key at the top
|
|
824
|
-
* and **field-key** is the key in the `jiraIssueFields` module. **app-key** can
|
|
825
|
-
* also be found in the app listing in the Atlassian Universal Plugin Manager.
|
|
826
|
-
* * run [Get fields](#api-rest-api-3-field-get) and in the field details the
|
|
827
|
-
* value is returned in `key`. For example, `"key":
|
|
828
|
-
* "teams-add-on__team-issue-field"`
|
|
829
|
-
*/
|
|
830
|
-
fieldKey: string;
|
|
831
|
-
/** The ID of the option to be updated. */
|
|
832
|
-
optionId: number;
|
|
833
|
-
/**
|
|
834
|
-
* @example {
|
|
835
|
-
* "config": {
|
|
836
|
-
* "attributes": [],
|
|
837
|
-
* "scope": {
|
|
838
|
-
* "global": {},
|
|
839
|
-
* "projects": [],
|
|
840
|
-
* "projects2": [
|
|
841
|
-
* {
|
|
842
|
-
* "attributes": [
|
|
843
|
-
* "notSelectable"
|
|
844
|
-
* ],
|
|
845
|
-
* "id": 1001
|
|
846
|
-
* },
|
|
847
|
-
* {
|
|
848
|
-
* "attributes": [
|
|
849
|
-
* "notSelectable"
|
|
850
|
-
* ],
|
|
851
|
-
* "id": 1002
|
|
852
|
-
* }
|
|
853
|
-
* ]
|
|
854
|
-
* }
|
|
855
|
-
* },
|
|
856
|
-
* "id": 1,
|
|
857
|
-
* "properties": {
|
|
858
|
-
* "description": "The team's description",
|
|
859
|
-
* "founded": "2016-06-06",
|
|
860
|
-
* "leader": {
|
|
861
|
-
* "email": "lname@example.com",
|
|
862
|
-
* "name": "Leader Name"
|
|
863
|
-
* },
|
|
864
|
-
* "members": 42
|
|
865
|
-
* },
|
|
866
|
-
* "value": "Team 1"
|
|
867
|
-
* }
|
|
868
|
-
*/
|
|
869
|
-
issueFieldOption: IssueFieldOption;
|
|
870
|
-
}): Promise<IssueFieldOption> {
|
|
871
|
-
return this.getClientInstance()
|
|
872
|
-
.request({
|
|
873
|
-
path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
|
|
874
|
-
method: "PUT",
|
|
875
|
-
pathParams: {
|
|
876
|
-
fieldKey,
|
|
877
|
-
optionId,
|
|
878
|
-
},
|
|
879
|
-
headers: {
|
|
880
|
-
"Content-Type": "application/json",
|
|
881
|
-
},
|
|
882
|
-
body: issueFieldOption,
|
|
883
|
-
})
|
|
884
|
-
.then(
|
|
885
|
-
this.getClientInstance().responseHandler({
|
|
886
|
-
200: {
|
|
887
|
-
"application/json": "json",
|
|
888
|
-
},
|
|
889
|
-
}),
|
|
890
|
-
)
|
|
891
|
-
.then(
|
|
892
|
-
commonHttpClient.castResponse<{
|
|
893
|
-
status: 200;
|
|
894
|
-
mediaType: "application/json";
|
|
895
|
-
body: IssueFieldOption;
|
|
896
|
-
}>(),
|
|
897
|
-
)
|
|
898
|
-
.then(
|
|
899
|
-
validationSchemaStorage.validator(
|
|
900
|
-
"IssueCustomFieldOptionsAppsService.updateIssueFieldOption.response",
|
|
901
|
-
),
|
|
902
|
-
)
|
|
903
|
-
.then(commonHttpClient.getBody);
|
|
904
|
-
}
|
|
905
|
-
static initialize() {
|
|
906
|
-
validationSchemaStorage.registerExtensible(
|
|
907
|
-
"IssueCustomFieldOptionsAppsService.getAllIssueFieldOptions.response",
|
|
908
|
-
z
|
|
909
|
-
.object({
|
|
910
|
-
status: z.literal(200),
|
|
911
|
-
mediaType: z.literal("application/json"),
|
|
912
|
-
body: validationSchemaStorage.lazy("PageBeanIssueFieldOption"),
|
|
913
|
-
})
|
|
914
|
-
.describe(
|
|
915
|
-
"IssueCustomFieldOptionsAppsService.getAllIssueFieldOptions.response",
|
|
916
|
-
),
|
|
917
|
-
);
|
|
918
|
-
validationSchemaStorage.registerExtensible(
|
|
919
|
-
"IssueCustomFieldOptionsAppsService.createIssueFieldOption.response",
|
|
920
|
-
z
|
|
921
|
-
.object({
|
|
922
|
-
status: z.literal(200),
|
|
923
|
-
mediaType: z.literal("application/json"),
|
|
924
|
-
body: validationSchemaStorage.lazy("IssueFieldOption"),
|
|
925
|
-
})
|
|
926
|
-
.describe(
|
|
927
|
-
"IssueCustomFieldOptionsAppsService.createIssueFieldOption.response",
|
|
928
|
-
),
|
|
929
|
-
);
|
|
930
|
-
validationSchemaStorage.registerExtensible(
|
|
931
|
-
"IssueCustomFieldOptionsAppsService.getIssueFieldOption.response",
|
|
932
|
-
z
|
|
933
|
-
.object({
|
|
934
|
-
status: z.literal(200),
|
|
935
|
-
mediaType: z.literal("application/json"),
|
|
936
|
-
body: validationSchemaStorage.lazy("IssueFieldOption"),
|
|
937
|
-
})
|
|
938
|
-
.describe(
|
|
939
|
-
"IssueCustomFieldOptionsAppsService.getIssueFieldOption.response",
|
|
940
|
-
),
|
|
941
|
-
);
|
|
942
|
-
validationSchemaStorage.registerExtensible(
|
|
943
|
-
"IssueCustomFieldOptionsAppsService.updateIssueFieldOption.response",
|
|
944
|
-
z
|
|
945
|
-
.object({
|
|
946
|
-
status: z.literal(200),
|
|
947
|
-
mediaType: z.literal("application/json"),
|
|
948
|
-
body: validationSchemaStorage.lazy("IssueFieldOption"),
|
|
949
|
-
})
|
|
950
|
-
.describe(
|
|
951
|
-
"IssueCustomFieldOptionsAppsService.updateIssueFieldOption.response",
|
|
952
|
-
),
|
|
953
|
-
);
|
|
954
|
-
validationSchemaStorage.registerExtensible(
|
|
955
|
-
"IssueCustomFieldOptionsAppsService.deleteIssueFieldOption.response",
|
|
956
|
-
z
|
|
957
|
-
.object({
|
|
958
|
-
status: z.literal(204),
|
|
959
|
-
mediaType: z.literal("application/json"),
|
|
960
|
-
body: z.unknown(),
|
|
961
|
-
})
|
|
962
|
-
.describe(
|
|
963
|
-
"IssueCustomFieldOptionsAppsService.deleteIssueFieldOption.response",
|
|
964
|
-
),
|
|
965
|
-
);
|
|
966
|
-
validationSchemaStorage.registerExtensible(
|
|
967
|
-
"IssueCustomFieldOptionsAppsService.getSelectableIssueFieldOptions.response",
|
|
968
|
-
z
|
|
969
|
-
.object({
|
|
970
|
-
status: z.literal(200),
|
|
971
|
-
mediaType: z.literal("application/json"),
|
|
972
|
-
body: validationSchemaStorage.lazy("PageBeanIssueFieldOption"),
|
|
973
|
-
})
|
|
974
|
-
.describe(
|
|
975
|
-
"IssueCustomFieldOptionsAppsService.getSelectableIssueFieldOptions.response",
|
|
976
|
-
),
|
|
977
|
-
);
|
|
978
|
-
validationSchemaStorage.registerExtensible(
|
|
979
|
-
"IssueCustomFieldOptionsAppsService.getVisibleIssueFieldOptions.response",
|
|
980
|
-
z
|
|
981
|
-
.object({
|
|
982
|
-
status: z.literal(200),
|
|
983
|
-
mediaType: z.literal("application/json"),
|
|
984
|
-
body: validationSchemaStorage.lazy("PageBeanIssueFieldOption"),
|
|
985
|
-
})
|
|
986
|
-
.describe(
|
|
987
|
-
"IssueCustomFieldOptionsAppsService.getVisibleIssueFieldOptions.response",
|
|
988
|
-
),
|
|
989
|
-
);
|
|
990
|
-
validationSchemaStorage.registerOnce([
|
|
991
|
-
registerIssueCustomFieldOptionsAppsValidationSchemas,
|
|
992
|
-
]);
|
|
993
|
-
}
|
|
994
|
-
}
|