@knpkv/jira-api-client 0.3.0 → 0.3.1
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/.specs/VERSION_V3 +1 -1
- package/.specs/jira-v3-1001.0.0-SNAPSHOT-05f20e18d9bde3de68f911b4915970482f536d4e.json +56275 -0
- package/.specs/jira-v3-1001.0.0-SNAPSHOT-d7cd03e966bb408ad32ffe870114289c528f56fd.json +56129 -0
- package/CHANGELOG.md +6 -0
- package/dist/generated/v3/schema.d.ts +1537 -1436
- package/package.json +6 -6
- package/scripts/regenerate.ts +74 -40
- package/src/generated/v3/schema.d.ts +1537 -1436
- package/test/JiraApiClient.test.ts +14 -7
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -1212,6 +1212,28 @@ export interface paths {
|
|
|
1212
1212
|
patch?: never;
|
|
1213
1213
|
trace?: never;
|
|
1214
1214
|
};
|
|
1215
|
+
"/rest/api/3/config/fieldschemes/{id}/clone": {
|
|
1216
|
+
parameters: {
|
|
1217
|
+
query?: never;
|
|
1218
|
+
header?: never;
|
|
1219
|
+
path?: never;
|
|
1220
|
+
cookie?: never;
|
|
1221
|
+
};
|
|
1222
|
+
get?: never;
|
|
1223
|
+
put?: never;
|
|
1224
|
+
/**
|
|
1225
|
+
* Clone field scheme
|
|
1226
|
+
* @description Endpoint for cloning an existing field association scheme into a new one.
|
|
1227
|
+
*
|
|
1228
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
1229
|
+
*/
|
|
1230
|
+
post: operations["cloneFieldAssociationScheme"];
|
|
1231
|
+
delete?: never;
|
|
1232
|
+
options?: never;
|
|
1233
|
+
head?: never;
|
|
1234
|
+
patch?: never;
|
|
1235
|
+
trace?: never;
|
|
1236
|
+
};
|
|
1215
1237
|
"/rest/api/3/config/fieldschemes/{id}/fields": {
|
|
1216
1238
|
parameters: {
|
|
1217
1239
|
query?: never;
|
|
@@ -1925,6 +1947,7 @@ export interface paths {
|
|
|
1925
1947
|
* * Fields that cannot be added to the issue navigator are always returned.
|
|
1926
1948
|
* * Fields that cannot be placed on an issue screen are always returned.
|
|
1927
1949
|
* * Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
|
|
1950
|
+
* * Fields that are not associated to any used field configurations or screens are not returned.
|
|
1928
1951
|
* * For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.)
|
|
1929
1952
|
*
|
|
1930
1953
|
* This operation can be accessed anonymously.
|
|
@@ -2063,6 +2086,28 @@ export interface paths {
|
|
|
2063
2086
|
patch?: never;
|
|
2064
2087
|
trace?: never;
|
|
2065
2088
|
};
|
|
2089
|
+
"/rest/api/3/field/{fieldId}/association/project": {
|
|
2090
|
+
parameters: {
|
|
2091
|
+
query?: never;
|
|
2092
|
+
header?: never;
|
|
2093
|
+
path?: never;
|
|
2094
|
+
cookie?: never;
|
|
2095
|
+
};
|
|
2096
|
+
/**
|
|
2097
|
+
* Get field project associations
|
|
2098
|
+
* @description Returns a [paginated](#pagination) list of project associations for the given custom field. Each association contains the ID of a project the field is associated with.
|
|
2099
|
+
*
|
|
2100
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2101
|
+
*/
|
|
2102
|
+
get: operations["getFieldProjectAssociations"];
|
|
2103
|
+
put?: never;
|
|
2104
|
+
post?: never;
|
|
2105
|
+
delete?: never;
|
|
2106
|
+
options?: never;
|
|
2107
|
+
head?: never;
|
|
2108
|
+
patch?: never;
|
|
2109
|
+
trace?: never;
|
|
2110
|
+
};
|
|
2066
2111
|
"/rest/api/3/field/{fieldId}/context": {
|
|
2067
2112
|
parameters: {
|
|
2068
2113
|
query?: never;
|
|
@@ -2107,6 +2152,7 @@ export interface paths {
|
|
|
2107
2152
|
};
|
|
2108
2153
|
/**
|
|
2109
2154
|
* Get custom field contexts default values
|
|
2155
|
+
* @deprecated
|
|
2110
2156
|
* @description Returns a [paginated](#pagination) list of defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
|
|
2111
2157
|
* The returned object depends on type of the custom field:
|
|
2112
2158
|
*
|
|
@@ -2141,11 +2187,14 @@ export interface paths {
|
|
|
2141
2187
|
* * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for Forge user fields.
|
|
2142
2188
|
* * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type `forge.user.list`) for Forge user collection fields.
|
|
2143
2189
|
*
|
|
2190
|
+
* **Deprecated:** This API is deprecated and will be removed in October 2026. A replacement API that supports multiple default values per issue type within a context is coming soon. See the deprecation notice [CHANGE-3082](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3082) for more details.
|
|
2191
|
+
*
|
|
2144
2192
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2145
2193
|
*/
|
|
2146
2194
|
get: operations["getDefaultValues"];
|
|
2147
2195
|
/**
|
|
2148
2196
|
* Set custom field contexts default values
|
|
2197
|
+
* @deprecated
|
|
2149
2198
|
* @description Sets default for contexts of a custom field. Default are defined using these objects:
|
|
2150
2199
|
*
|
|
2151
2200
|
* * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
|
|
@@ -2181,6 +2230,8 @@ export interface paths {
|
|
|
2181
2230
|
*
|
|
2182
2231
|
* Only one type of default object can be included in a request. To remove a default for a context, set the default parameter to `null`.
|
|
2183
2232
|
*
|
|
2233
|
+
* **Deprecated:** This API is deprecated and will be removed in October 2026. A replacement API that supports multiple default values per issue type within a context is coming soon. See the deprecation notice [CHANGE-3082](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3082) for more details.
|
|
2234
|
+
*
|
|
2184
2235
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2185
2236
|
*/
|
|
2186
2237
|
put: operations["setDefaultValues"];
|
|
@@ -2191,6 +2242,34 @@ export interface paths {
|
|
|
2191
2242
|
patch?: never;
|
|
2192
2243
|
trace?: never;
|
|
2193
2244
|
};
|
|
2245
|
+
"/rest/api/3/field/{fieldId}/context/defaultValues": {
|
|
2246
|
+
parameters: {
|
|
2247
|
+
query?: never;
|
|
2248
|
+
header?: never;
|
|
2249
|
+
path?: never;
|
|
2250
|
+
cookie?: never;
|
|
2251
|
+
};
|
|
2252
|
+
/**
|
|
2253
|
+
* Get default values for a custom field grouped by context and issue type
|
|
2254
|
+
* @description Returns a paginated list of default values grouped by custom field context.
|
|
2255
|
+
*
|
|
2256
|
+
* Each returned \{@code ContextDefaultValuesBean\} has a \{@code contextId\} and a \{@code defaultValues\} list of \{@code IssueTypeDefaultValueBean\} entries \\u2014 one per issue-type-scoped default value configured for the context. An entry with \{@code "isAnyIssueType": true\} represents the catch-all default that applies to every issue type covered by the context that is not covered by a more specific entry; a non-null \{@code issueTypeId\} represents a default that only applies to that issue type.
|
|
2257
|
+
*
|
|
2258
|
+
* For contexts that have not been converted to the multiple-contexts data model, exactly one entry is returned per context with \{@code isAnyIssueType=true\}. For converted contexts, one entry is returned per configured per-issue-type default.
|
|
2259
|
+
*
|
|
2260
|
+
* The value object on each entry is the same polymorphic \{@code CustomFieldContextDefaultValueBean\} exposed by the deprecated \{@code GET /defaultValue\} endpoint \\u2014 its concrete subtype depends on the custom field's type (see the list of supported types on that endpoint).
|
|
2261
|
+
*
|
|
2262
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2263
|
+
*/
|
|
2264
|
+
get: operations["getContextDefaultValues"];
|
|
2265
|
+
put?: never;
|
|
2266
|
+
post?: never;
|
|
2267
|
+
delete?: never;
|
|
2268
|
+
options?: never;
|
|
2269
|
+
head?: never;
|
|
2270
|
+
patch?: never;
|
|
2271
|
+
trace?: never;
|
|
2272
|
+
};
|
|
2194
2273
|
"/rest/api/3/field/{fieldId}/context/issuetypemapping": {
|
|
2195
2274
|
parameters: {
|
|
2196
2275
|
query?: never;
|
|
@@ -2283,6 +2362,8 @@ export interface paths {
|
|
|
2283
2362
|
* Delete custom field context
|
|
2284
2363
|
* @description Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
|
|
2285
2364
|
*
|
|
2365
|
+
* This API will not allow removing the global context from April 2026. Instead, an HTTP 400 response will be returned. See [CHANGE-3019](https://developer.atlassian.com/changelog/#CHANGE-3019)
|
|
2366
|
+
*
|
|
2286
2367
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2287
2368
|
*/
|
|
2288
2369
|
delete: operations["deleteCustomFieldContext"];
|
|
@@ -2307,6 +2388,8 @@ export interface paths {
|
|
|
2307
2388
|
*
|
|
2308
2389
|
* If any of the issue types exists in the custom field context, the operation fails and no issue types are added.
|
|
2309
2390
|
*
|
|
2391
|
+
* This API will not allow adding issue types to the global context from April 2026. Instead, an HTTP 400 response will be returned. See [CHANGE-3019](https://developer.atlassian.com/changelog/#CHANGE-3019)
|
|
2392
|
+
*
|
|
2310
2393
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2311
2394
|
*/
|
|
2312
2395
|
put: operations["addIssueTypesToContext"];
|
|
@@ -2473,6 +2556,8 @@ export interface paths {
|
|
|
2473
2556
|
*
|
|
2474
2557
|
* If any project in the request is assigned to any context of the custom field, the operation fails.
|
|
2475
2558
|
*
|
|
2559
|
+
* This API will not allow adding projects to the global context from April 2026. Instead, an HTTP 400 response will be returned. See [CHANGE-3019](https://developer.atlassian.com/changelog/#CHANGE-3019)
|
|
2560
|
+
*
|
|
2476
2561
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2477
2562
|
*/
|
|
2478
2563
|
put: operations["assignProjectsToCustomFieldContext"];
|
|
@@ -2781,7 +2866,10 @@ export interface paths {
|
|
|
2781
2866
|
};
|
|
2782
2867
|
/**
|
|
2783
2868
|
* Get all field configurations
|
|
2784
|
-
* @
|
|
2869
|
+
* @deprecated
|
|
2870
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2871
|
+
*
|
|
2872
|
+
* Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
|
|
2785
2873
|
*
|
|
2786
2874
|
* * a list of field configuration item IDs.
|
|
2787
2875
|
* * whether the field configuration is a default.
|
|
@@ -2795,7 +2883,10 @@ export interface paths {
|
|
|
2795
2883
|
put?: never;
|
|
2796
2884
|
/**
|
|
2797
2885
|
* Create field configuration
|
|
2798
|
-
* @
|
|
2886
|
+
* @deprecated
|
|
2887
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2888
|
+
*
|
|
2889
|
+
* Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.
|
|
2799
2890
|
*
|
|
2800
2891
|
* This operation can only create configurations for use in company-managed (classic) projects.
|
|
2801
2892
|
*
|
|
@@ -2818,7 +2909,10 @@ export interface paths {
|
|
|
2818
2909
|
get?: never;
|
|
2819
2910
|
/**
|
|
2820
2911
|
* Update field configuration
|
|
2821
|
-
* @
|
|
2912
|
+
* @deprecated
|
|
2913
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2914
|
+
*
|
|
2915
|
+
* Updates a field configuration. The name and the description provided in the request override the existing values.
|
|
2822
2916
|
*
|
|
2823
2917
|
* This operation can only update configurations used in company-managed (classic) projects.
|
|
2824
2918
|
*
|
|
@@ -2828,7 +2922,10 @@ export interface paths {
|
|
|
2828
2922
|
post?: never;
|
|
2829
2923
|
/**
|
|
2830
2924
|
* Delete field configuration
|
|
2831
|
-
* @
|
|
2925
|
+
* @deprecated
|
|
2926
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2927
|
+
*
|
|
2928
|
+
* Deletes a field configuration.
|
|
2832
2929
|
*
|
|
2833
2930
|
* This operation can only delete configurations used in company-managed (classic) projects.
|
|
2834
2931
|
*
|
|
@@ -2849,7 +2946,10 @@ export interface paths {
|
|
|
2849
2946
|
};
|
|
2850
2947
|
/**
|
|
2851
2948
|
* Get field configuration items
|
|
2852
|
-
* @
|
|
2949
|
+
* @deprecated
|
|
2950
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2951
|
+
*
|
|
2952
|
+
* Returns a [paginated](#pagination) list of all fields for a configuration.
|
|
2853
2953
|
*
|
|
2854
2954
|
* Only the fields from configurations used in company-managed (classic) projects are returned.
|
|
2855
2955
|
*
|
|
@@ -2858,7 +2958,10 @@ export interface paths {
|
|
|
2858
2958
|
get: operations["getFieldConfigurationItems"];
|
|
2859
2959
|
/**
|
|
2860
2960
|
* Update field configuration items
|
|
2861
|
-
* @
|
|
2961
|
+
* @deprecated
|
|
2962
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2963
|
+
*
|
|
2964
|
+
* Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.
|
|
2862
2965
|
*
|
|
2863
2966
|
* This operation can only update field configurations used in company-managed (classic) projects.
|
|
2864
2967
|
*
|
|
@@ -2885,7 +2988,10 @@ export interface paths {
|
|
|
2885
2988
|
};
|
|
2886
2989
|
/**
|
|
2887
2990
|
* Get all field configuration schemes
|
|
2888
|
-
* @
|
|
2991
|
+
* @deprecated
|
|
2992
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
2993
|
+
*
|
|
2994
|
+
* Returns a [paginated](#pagination) list of field configuration schemes.
|
|
2889
2995
|
*
|
|
2890
2996
|
* Only field configuration schemes used in classic projects are returned.
|
|
2891
2997
|
*
|
|
@@ -2895,7 +3001,10 @@ export interface paths {
|
|
|
2895
3001
|
put?: never;
|
|
2896
3002
|
/**
|
|
2897
3003
|
* Create field configuration scheme
|
|
2898
|
-
* @
|
|
3004
|
+
* @deprecated
|
|
3005
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3006
|
+
*
|
|
3007
|
+
* Creates a field configuration scheme.
|
|
2899
3008
|
*
|
|
2900
3009
|
* This operation can only create field configuration schemes used in company-managed (classic) projects.
|
|
2901
3010
|
*
|
|
@@ -2917,7 +3026,10 @@ export interface paths {
|
|
|
2917
3026
|
};
|
|
2918
3027
|
/**
|
|
2919
3028
|
* Get field configuration issue type items
|
|
2920
|
-
* @
|
|
3029
|
+
* @deprecated
|
|
3030
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3031
|
+
*
|
|
3032
|
+
* Returns a [paginated](#pagination) list of field configuration issue type items.
|
|
2921
3033
|
*
|
|
2922
3034
|
* Only items used in classic projects are returned.
|
|
2923
3035
|
*
|
|
@@ -2941,7 +3053,10 @@ export interface paths {
|
|
|
2941
3053
|
};
|
|
2942
3054
|
/**
|
|
2943
3055
|
* Get field configuration schemes for projects
|
|
2944
|
-
* @
|
|
3056
|
+
* @deprecated
|
|
3057
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3058
|
+
*
|
|
3059
|
+
* Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it.
|
|
2945
3060
|
*
|
|
2946
3061
|
* The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.
|
|
2947
3062
|
*
|
|
@@ -2952,7 +3067,10 @@ export interface paths {
|
|
|
2952
3067
|
get: operations["getFieldConfigurationSchemeProjectMapping"];
|
|
2953
3068
|
/**
|
|
2954
3069
|
* Assign field configuration scheme to project
|
|
2955
|
-
* @
|
|
3070
|
+
* @deprecated
|
|
3071
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3072
|
+
*
|
|
3073
|
+
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme.
|
|
2956
3074
|
*
|
|
2957
3075
|
* Field configuration schemes can only be assigned to classic projects.
|
|
2958
3076
|
*
|
|
@@ -2976,7 +3094,10 @@ export interface paths {
|
|
|
2976
3094
|
get?: never;
|
|
2977
3095
|
/**
|
|
2978
3096
|
* Update field configuration scheme
|
|
2979
|
-
* @
|
|
3097
|
+
* @deprecated
|
|
3098
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3099
|
+
*
|
|
3100
|
+
* Updates a field configuration scheme.
|
|
2980
3101
|
*
|
|
2981
3102
|
* This operation can only update field configuration schemes used in company-managed (classic) projects.
|
|
2982
3103
|
*
|
|
@@ -2986,7 +3107,10 @@ export interface paths {
|
|
|
2986
3107
|
post?: never;
|
|
2987
3108
|
/**
|
|
2988
3109
|
* Delete field configuration scheme
|
|
2989
|
-
* @
|
|
3110
|
+
* @deprecated
|
|
3111
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3112
|
+
*
|
|
3113
|
+
* Deletes a field configuration scheme.
|
|
2990
3114
|
*
|
|
2991
3115
|
* This operation can only delete field configuration schemes used in company-managed (classic) projects.
|
|
2992
3116
|
*
|
|
@@ -3008,7 +3132,10 @@ export interface paths {
|
|
|
3008
3132
|
get?: never;
|
|
3009
3133
|
/**
|
|
3010
3134
|
* Assign issue types to field configurations
|
|
3011
|
-
* @
|
|
3135
|
+
* @deprecated
|
|
3136
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3137
|
+
*
|
|
3138
|
+
* Assigns issue types to field configurations on field configuration scheme.
|
|
3012
3139
|
*
|
|
3013
3140
|
* This operation can only modify field configuration schemes used in company-managed (classic) projects.
|
|
3014
3141
|
*
|
|
@@ -3033,7 +3160,10 @@ export interface paths {
|
|
|
3033
3160
|
put?: never;
|
|
3034
3161
|
/**
|
|
3035
3162
|
* Remove issue types from field configuration scheme
|
|
3036
|
-
* @
|
|
3163
|
+
* @deprecated
|
|
3164
|
+
* @description Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
|
|
3165
|
+
*
|
|
3166
|
+
* Removes issue types from the field configuration scheme.
|
|
3037
3167
|
*
|
|
3038
3168
|
* This operation can only modify field configuration schemes used in company-managed (classic) projects.
|
|
3039
3169
|
*
|
|
@@ -3421,6 +3551,30 @@ export interface paths {
|
|
|
3421
3551
|
patch?: never;
|
|
3422
3552
|
trace?: never;
|
|
3423
3553
|
};
|
|
3554
|
+
"/rest/api/3/forge/panel/action/bulk/async": {
|
|
3555
|
+
parameters: {
|
|
3556
|
+
query?: never;
|
|
3557
|
+
header?: never;
|
|
3558
|
+
path?: never;
|
|
3559
|
+
cookie?: never;
|
|
3560
|
+
};
|
|
3561
|
+
get?: never;
|
|
3562
|
+
put?: never;
|
|
3563
|
+
/**
|
|
3564
|
+
* Bulk pin or unpin issue panel to projects
|
|
3565
|
+
* @description Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects.
|
|
3566
|
+
*
|
|
3567
|
+
* The operation runs asynchronously. The response includes a task ID - use the [Get task](#api-rest-api-3-task-taskId-get) endpoint to check progress.
|
|
3568
|
+
*
|
|
3569
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
3570
|
+
*/
|
|
3571
|
+
post: operations["bulkPinUnpinProjectsAsync"];
|
|
3572
|
+
delete?: never;
|
|
3573
|
+
options?: never;
|
|
3574
|
+
head?: never;
|
|
3575
|
+
patch?: never;
|
|
3576
|
+
trace?: never;
|
|
3577
|
+
};
|
|
3424
3578
|
"/rest/api/3/group": {
|
|
3425
3579
|
parameters: {
|
|
3426
3580
|
query?: never;
|
|
@@ -4127,6 +4281,8 @@ export interface paths {
|
|
|
4127
4281
|
*
|
|
4128
4282
|
* The edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
|
|
4129
4283
|
*
|
|
4284
|
+
* **Note:** This endpoint doesn't check screen configurations to determine if a field is editable. For more context, see the [Deprecation of override screen security](https://community.developer.atlassian.com/t/deprecation-of-override-screen-security/97153) announcement.
|
|
4285
|
+
*
|
|
4130
4286
|
* The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting `update.parent.set.none` to *true*. Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
|
|
4131
4287
|
*
|
|
4132
4288
|
* Connect apps having an app user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`.
|
|
@@ -5007,7 +5163,8 @@ export interface paths {
|
|
|
5007
5163
|
*
|
|
5008
5164
|
* * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the projects containing the source and destination issues.
|
|
5009
5165
|
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
|
|
5010
|
-
* * *Delete all worklogs*
|
|
5166
|
+
* * *Delete all worklogs* [project permission](https://confluence.atlassian.com/x/yodKLg)
|
|
5167
|
+
* * *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) to log work on an issue, that is to create a worklog entry, if time tracking is enabled. This permission is required as a prerequisite for applying the other time-tracking permissions
|
|
5011
5168
|
* * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
|
|
5012
5169
|
*/
|
|
5013
5170
|
post: operations["bulkMoveWorklogs"];
|
|
@@ -5690,7 +5847,7 @@ export interface paths {
|
|
|
5690
5847
|
put?: never;
|
|
5691
5848
|
/**
|
|
5692
5849
|
* Create issue type
|
|
5693
|
-
* @description Creates an issue type
|
|
5850
|
+
* @description Creates an issue type.
|
|
5694
5851
|
*
|
|
5695
5852
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
5696
5853
|
*/
|
|
@@ -5997,9 +6154,9 @@ export interface paths {
|
|
|
5997
6154
|
* Delete issue type scheme
|
|
5998
6155
|
* @description Deletes an issue type scheme.
|
|
5999
6156
|
*
|
|
6000
|
-
* Only issue type schemes used in classic projects can be deleted.
|
|
6157
|
+
* Only issue type schemes used in classic projects can be deleted. Only issue type schemes not associated with a project can be deleted
|
|
6001
6158
|
*
|
|
6002
|
-
*
|
|
6159
|
+
* A validation error will be returned if the specified scheme is associated with one or more projects. Use [Get issue type scheme API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-get) (with the projects expand, and id query parameter) to get a list of projects. Then, use [Assign issue type scheme to project API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-project-put) to associate all projects to another scheme before deleting.
|
|
6003
6160
|
*
|
|
6004
6161
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
6005
6162
|
*/
|
|
@@ -7539,16 +7696,15 @@ export interface paths {
|
|
|
7539
7696
|
* @deprecated
|
|
7540
7697
|
* @description Returns the list of all issue priorities.
|
|
7541
7698
|
*
|
|
7542
|
-
* **[Permissions](#permissions) required:** Permission to access Jira.
|
|
7699
|
+
* **Deprecated:** Use [Search priorities](#api-rest-api-3-priority-search-get) instead. **[Permissions](#permissions) required:** Permission to access Jira.
|
|
7543
7700
|
*/
|
|
7544
7701
|
get: operations["getPriorities"];
|
|
7545
7702
|
put?: never;
|
|
7546
7703
|
/**
|
|
7547
7704
|
* Create priority
|
|
7548
|
-
* @deprecated
|
|
7549
7705
|
* @description Creates an issue priority.
|
|
7550
7706
|
*
|
|
7551
|
-
* Deprecation
|
|
7707
|
+
* **Deprecation notice:** The `iconUrl` parameter was sunset on 16th Mar 2025, and replaced with `avatarId`. See [CHANGE-1525](https://developer.atlassian.com/changelog/#CHANGE-1525).
|
|
7552
7708
|
*
|
|
7553
7709
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7554
7710
|
*/
|
|
@@ -7612,13 +7768,16 @@ export interface paths {
|
|
|
7612
7768
|
};
|
|
7613
7769
|
/**
|
|
7614
7770
|
* Search priorities
|
|
7615
|
-
* @deprecated
|
|
7616
7771
|
* @description Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
|
|
7617
7772
|
*
|
|
7618
7773
|
* * a list of priority IDs. Any invalid priority IDs are ignored.
|
|
7619
7774
|
* * a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.
|
|
7620
7775
|
* * whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.
|
|
7621
7776
|
*
|
|
7777
|
+
* **Deprecation notice:** The `onlyDefault` parameter is deprecated and will be removed at a later date. See [CHANGE-1655](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1655).
|
|
7778
|
+
*
|
|
7779
|
+
* **Deprecation notice:** The `isDefault` property of priorities is deprecated and will be removed at a later date. See [CHANGE-1655](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1655).
|
|
7780
|
+
*
|
|
7622
7781
|
* **[Permissions](#permissions) required:** Permission to access Jira.
|
|
7623
7782
|
*/
|
|
7624
7783
|
get: operations["searchPriorities"];
|
|
@@ -7639,19 +7798,18 @@ export interface paths {
|
|
|
7639
7798
|
};
|
|
7640
7799
|
/**
|
|
7641
7800
|
* Get priority
|
|
7642
|
-
* @description Returns an issue priority.
|
|
7801
|
+
* @description Returns an issue priority. To fetch multiple priorities at once, use [Search priorities](#api-rest-api-3-priority-search-get) instead.
|
|
7643
7802
|
*
|
|
7644
7803
|
* **[Permissions](#permissions) required:** Permission to access Jira.
|
|
7645
7804
|
*/
|
|
7646
7805
|
get: operations["getPriority"];
|
|
7647
7806
|
/**
|
|
7648
7807
|
* Update priority
|
|
7649
|
-
* @deprecated
|
|
7650
7808
|
* @description Updates an issue priority.
|
|
7651
7809
|
*
|
|
7652
7810
|
* At least one request body parameter must be defined.
|
|
7653
7811
|
*
|
|
7654
|
-
* Deprecation
|
|
7812
|
+
* **Deprecation notice:** The `iconUrl` parameter was sunset on 16th Mar 2025, and replaced with `avatarId`. See [CHANGE-1525](https://developer.atlassian.com/changelog/#CHANGE-1525).
|
|
7655
7813
|
*
|
|
7656
7814
|
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7657
7815
|
*/
|
|
@@ -7682,7 +7840,7 @@ export interface paths {
|
|
|
7682
7840
|
* Get priority schemes
|
|
7683
7841
|
* @description Returns a [paginated](#pagination) list of priority schemes.
|
|
7684
7842
|
*
|
|
7685
|
-
* **[Permissions](#permissions) required:**
|
|
7843
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7686
7844
|
*/
|
|
7687
7845
|
get: operations["getPrioritySchemes"];
|
|
7688
7846
|
put?: never;
|
|
@@ -7712,7 +7870,7 @@ export interface paths {
|
|
|
7712
7870
|
* Suggested priorities for mappings
|
|
7713
7871
|
* @description Returns a [paginated](#pagination) list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme.
|
|
7714
7872
|
*
|
|
7715
|
-
* **[Permissions](#permissions) required:**
|
|
7873
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7716
7874
|
*/
|
|
7717
7875
|
post: operations["suggestedPrioritiesForMappings"];
|
|
7718
7876
|
delete?: never;
|
|
@@ -7732,7 +7890,7 @@ export interface paths {
|
|
|
7732
7890
|
* Get available priorities by priority scheme
|
|
7733
7891
|
* @description Returns a [paginated](#pagination) list of priorities available for adding to a priority scheme.
|
|
7734
7892
|
*
|
|
7735
|
-
* **[Permissions](#permissions) required:**
|
|
7893
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7736
7894
|
*/
|
|
7737
7895
|
get: operations["getAvailablePrioritiesByPriorityScheme"];
|
|
7738
7896
|
put?: never;
|
|
@@ -7784,7 +7942,7 @@ export interface paths {
|
|
|
7784
7942
|
* Get priorities by priority scheme
|
|
7785
7943
|
* @description Returns a [paginated](#pagination) list of priorities by scheme.
|
|
7786
7944
|
*
|
|
7787
|
-
* **[Permissions](#permissions) required:**
|
|
7945
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7788
7946
|
*/
|
|
7789
7947
|
get: operations["getPrioritiesByPriorityScheme"];
|
|
7790
7948
|
put?: never;
|
|
@@ -7806,7 +7964,7 @@ export interface paths {
|
|
|
7806
7964
|
* Get projects by priority scheme
|
|
7807
7965
|
* @description Returns a [paginated](#pagination) list of projects by scheme.
|
|
7808
7966
|
*
|
|
7809
|
-
* **[Permissions](#permissions) required:**
|
|
7967
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7810
7968
|
*/
|
|
7811
7969
|
get: operations["getProjectsByPriorityScheme"];
|
|
7812
7970
|
put?: never;
|
|
@@ -7844,6 +8002,7 @@ export interface paths {
|
|
|
7844
8002
|
* | `business` | `com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`, `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`, `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`, `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`, `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`, `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking` |
|
|
7845
8003
|
* | `service_desk` | `com.atlassian.servicedesk:simplified-it-service-management`, `com.atlassian.servicedesk:simplified-external-service-desk`, `com.atlassian.servicedesk:simplified-hr-service-desk`, `com.atlassian.servicedesk:simplified-facilities-service-desk`, `com.atlassian.servicedesk:simplified-legal-service-desk`, `com.atlassian.servicedesk:simplified-analytics-service-desk`, `com.atlassian.servicedesk:simplified-marketing-service-desk`, `com.atlassian.servicedesk:simplified-design-service-desk`, `com.atlassian.servicedesk:simplified-sales-service-desk`, `com.atlassian.servicedesk:simplified-finance-service-desk`, `com.atlassian.servicedesk:company-managed-blank-service-project`, `com.atlassian.servicedesk:company-managed-general-service-project`, `com.atlassian.servicedesk:team-managed-general-service-project`, `com.atlassian.servicedesk:next-gen-it-service-desk`, `com.atlassian.servicedesk:next-gen-hr-service-desk`, `com.atlassian.servicedesk:next-gen-legal-service-desk`, `com.atlassian.servicedesk:next-gen-marketing-service-desk`, `com.atlassian.servicedesk:next-gen-facilities-service-desk`, `com.atlassian.servicedesk:next-gen-analytics-service-desk`, `com.atlassian.servicedesk:next-gen-finance-service-desk`, `com.atlassian.servicedesk:next-gen-design-service-desk`, `com.atlassian.servicedesk:next-gen-sales-service-desk` |
|
|
7846
8004
|
* | `software` | `com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`, `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`, `com.pyxis.greenhopper.jira:gh-simplified-basic`, `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`, `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic` |
|
|
8005
|
+
* | `customer_service` | `com.atlassian.jcs:customer-service-management` |
|
|
7847
8006
|
* The project types are available according to the installed Jira features as follows:
|
|
7848
8007
|
*
|
|
7849
8008
|
* * Jira Core, the default, enables `business` projects.
|
|
@@ -7886,6 +8045,8 @@ export interface paths {
|
|
|
7886
8045
|
* * [asynchronous](#async). Follow the `Location` link in the response header to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
|
|
7887
8046
|
*
|
|
7888
8047
|
* ***Note: This API is only supported for Jira Enterprise edition.***
|
|
8048
|
+
*
|
|
8049
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
7889
8050
|
*/
|
|
7890
8051
|
post: operations["createProjectWithCustomTemplate"];
|
|
7891
8052
|
delete?: never;
|
|
@@ -8314,6 +8475,34 @@ export interface paths {
|
|
|
8314
8475
|
patch?: never;
|
|
8315
8476
|
trace?: never;
|
|
8316
8477
|
};
|
|
8478
|
+
"/rest/api/3/project/{projectIdOrKey}/classification-config": {
|
|
8479
|
+
parameters: {
|
|
8480
|
+
query?: never;
|
|
8481
|
+
header?: never;
|
|
8482
|
+
path?: never;
|
|
8483
|
+
cookie?: never;
|
|
8484
|
+
};
|
|
8485
|
+
/**
|
|
8486
|
+
* Get the classification configuration for a project
|
|
8487
|
+
* @description Returns the consolidated classification configuration for a project's admin settings page.
|
|
8488
|
+
*
|
|
8489
|
+
* This includes permitted classification levels (with status), the project's default classification level, the organization's default classification level, and the container override setting.
|
|
8490
|
+
*
|
|
8491
|
+
* **[Permissions](#permissions) required:**
|
|
8492
|
+
*
|
|
8493
|
+
* * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
|
|
8494
|
+
* * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
|
|
8495
|
+
* * *Administer jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
8496
|
+
*/
|
|
8497
|
+
get: operations["getProjectClassificationConfig"];
|
|
8498
|
+
put?: never;
|
|
8499
|
+
post?: never;
|
|
8500
|
+
delete?: never;
|
|
8501
|
+
options?: never;
|
|
8502
|
+
head?: never;
|
|
8503
|
+
patch?: never;
|
|
8504
|
+
trace?: never;
|
|
8505
|
+
};
|
|
8317
8506
|
"/rest/api/3/project/{projectIdOrKey}/classification-level/default": {
|
|
8318
8507
|
parameters: {
|
|
8319
8508
|
query?: never;
|
|
@@ -10232,6 +10421,17 @@ export interface paths {
|
|
|
10232
10421
|
*
|
|
10233
10422
|
* Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.
|
|
10234
10423
|
*
|
|
10424
|
+
* **Context types:**
|
|
10425
|
+
*
|
|
10426
|
+
* * **Jira contexts:** For Jira view types, use `projectId` and `issueTypeId`. One field can act as a wildcard. Supported Jira views:
|
|
10427
|
+
*
|
|
10428
|
+
* * `GIC` \- Jira global issue create
|
|
10429
|
+
* * `IssueView` \- Jira issue view
|
|
10430
|
+
* * `IssueTransition` \- Jira issue transition
|
|
10431
|
+
* * **Jira Service Management contexts:** For Jira Service Management view types, use `portalId` and `requestTypeId`. Wildcards are not supported. Supported JSM views:
|
|
10432
|
+
*
|
|
10433
|
+
* * `JSMRequestCreate` \- Jira Service Management request create portal view
|
|
10434
|
+
*
|
|
10235
10435
|
* **[Permissions](#permissions) required:**
|
|
10236
10436
|
*
|
|
10237
10437
|
* * *None* if the UI modification is created without contexts.
|
|
@@ -10260,6 +10460,17 @@ export interface paths {
|
|
|
10260
10460
|
*
|
|
10261
10461
|
* Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.
|
|
10262
10462
|
*
|
|
10463
|
+
* **Context types:**
|
|
10464
|
+
*
|
|
10465
|
+
* * **Jira contexts:** For Jira view types, use `projectId` and `issueTypeId`. One field can act as a wildcard. Supported Jira views:
|
|
10466
|
+
*
|
|
10467
|
+
* * `GIC` \- Jira global issue create
|
|
10468
|
+
* * `IssueView` \- Jira issue view
|
|
10469
|
+
* * `IssueTransition` \- Jira issue transition
|
|
10470
|
+
* * **Jira Service Management contexts:** For Jira Service Management view types, use `portalId` and `requestTypeId`. Wildcards are not supported. Supported JSM views:
|
|
10471
|
+
*
|
|
10472
|
+
* * `JSMRequestCreate` \- Jira Service Management request create portal view
|
|
10473
|
+
*
|
|
10263
10474
|
* **[Permissions](#permissions) required:**
|
|
10264
10475
|
*
|
|
10265
10476
|
* * *None* if the UI modification is created without contexts.
|
|
@@ -10471,9 +10682,11 @@ export interface paths {
|
|
|
10471
10682
|
* Create user
|
|
10472
10683
|
* @description Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.
|
|
10473
10684
|
*
|
|
10685
|
+
* **Note:** This API does not support Forge apps.
|
|
10686
|
+
*
|
|
10474
10687
|
* If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.
|
|
10475
10688
|
*
|
|
10476
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
10689
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). The caller has to be an **organization admin**.
|
|
10477
10690
|
*/
|
|
10478
10691
|
post: operations["createUser"];
|
|
10479
10692
|
/**
|
|
@@ -11380,770 +11593,6 @@ export interface paths {
|
|
|
11380
11593
|
patch?: never;
|
|
11381
11594
|
trace?: never;
|
|
11382
11595
|
};
|
|
11383
|
-
"/rest/api/3/workflow": {
|
|
11384
|
-
parameters: {
|
|
11385
|
-
query?: never;
|
|
11386
|
-
header?: never;
|
|
11387
|
-
path?: never;
|
|
11388
|
-
cookie?: never;
|
|
11389
|
-
};
|
|
11390
|
-
/**
|
|
11391
|
-
* Get all workflows
|
|
11392
|
-
* @deprecated
|
|
11393
|
-
* @description This will be removed on [February 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2567); use [Search workflows](#api-rest-api-3-workflows-search-get) instead.
|
|
11394
|
-
*
|
|
11395
|
-
* Returns all workflows in Jira or a workflow.
|
|
11396
|
-
*
|
|
11397
|
-
* If the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.
|
|
11398
|
-
*
|
|
11399
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
11400
|
-
*/
|
|
11401
|
-
get: operations["getAllWorkflows"];
|
|
11402
|
-
put?: never;
|
|
11403
|
-
/**
|
|
11404
|
-
* Create workflow
|
|
11405
|
-
* @deprecated
|
|
11406
|
-
* @description This will be removed on [February 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2568); use [Bulk create workflows](#api-rest-api-3-workflows-create-post) to create both team and company-managed scoped workflows.
|
|
11407
|
-
*
|
|
11408
|
-
* Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows.
|
|
11409
|
-
*
|
|
11410
|
-
* #### Conditions ####
|
|
11411
|
-
*
|
|
11412
|
-
* Conditions enable workflow rules that govern whether a transition can execute.
|
|
11413
|
-
*
|
|
11414
|
-
* ##### Always false condition #####
|
|
11415
|
-
*
|
|
11416
|
-
* A condition that always fails.
|
|
11417
|
-
*
|
|
11418
|
-
* {
|
|
11419
|
-
* "type": "AlwaysFalseCondition"
|
|
11420
|
-
* }
|
|
11421
|
-
*
|
|
11422
|
-
* ##### Block transition until approval #####
|
|
11423
|
-
*
|
|
11424
|
-
* A condition that blocks issue transition if there is a pending approval.
|
|
11425
|
-
*
|
|
11426
|
-
* {
|
|
11427
|
-
* "type": "BlockInProgressApprovalCondition"
|
|
11428
|
-
* }
|
|
11429
|
-
*
|
|
11430
|
-
* ##### Compare number custom field condition #####
|
|
11431
|
-
*
|
|
11432
|
-
* A condition that allows transition if a comparison between a number custom field and a value is true.
|
|
11433
|
-
*
|
|
11434
|
-
* {
|
|
11435
|
-
* "type": "CompareNumberCFCondition",
|
|
11436
|
-
* "configuration": {
|
|
11437
|
-
* "comparator": "=",
|
|
11438
|
-
* "fieldId": "customfield_10029",
|
|
11439
|
-
* "fieldValue": 2
|
|
11440
|
-
* }
|
|
11441
|
-
* }
|
|
11442
|
-
*
|
|
11443
|
-
* * `comparator` One of the supported comparator: `=`, `>`, and `<`.
|
|
11444
|
-
* * `fieldId` The custom numeric field ID. Allowed field types:
|
|
11445
|
-
*
|
|
11446
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:float`
|
|
11447
|
-
* * `com.pyxis.greenhopper.jira:jsw-story-points`
|
|
11448
|
-
* * `fieldValue` The value for comparison.
|
|
11449
|
-
*
|
|
11450
|
-
* ##### Hide from user condition #####
|
|
11451
|
-
*
|
|
11452
|
-
* A condition that hides a transition from users. The transition can only be triggered from a workflow function or REST API operation.
|
|
11453
|
-
*
|
|
11454
|
-
* {
|
|
11455
|
-
* "type": "RemoteOnlyCondition"
|
|
11456
|
-
* }
|
|
11457
|
-
*
|
|
11458
|
-
* ##### Only assignee condition #####
|
|
11459
|
-
*
|
|
11460
|
-
* A condition that allows only the assignee to execute a transition.
|
|
11461
|
-
*
|
|
11462
|
-
* {
|
|
11463
|
-
* "type": "AllowOnlyAssignee"
|
|
11464
|
-
* }
|
|
11465
|
-
*
|
|
11466
|
-
* ##### Only Bamboo notifications workflow condition (deprecated) #####
|
|
11467
|
-
*
|
|
11468
|
-
* A condition that makes the transition available only to Bamboo build notifications.
|
|
11469
|
-
*
|
|
11470
|
-
* {
|
|
11471
|
-
* "type": "OnlyBambooNotificationsCondition"
|
|
11472
|
-
* }
|
|
11473
|
-
*
|
|
11474
|
-
* ##### Only reporter condition #####
|
|
11475
|
-
*
|
|
11476
|
-
* A condition that allows only the reporter to execute a transition.
|
|
11477
|
-
*
|
|
11478
|
-
* {
|
|
11479
|
-
* "type": "AllowOnlyReporter"
|
|
11480
|
-
* }
|
|
11481
|
-
*
|
|
11482
|
-
* ##### Permission condition #####
|
|
11483
|
-
*
|
|
11484
|
-
* A condition that allows only users with a permission to execute a transition.
|
|
11485
|
-
*
|
|
11486
|
-
* {
|
|
11487
|
-
* "type": "PermissionCondition",
|
|
11488
|
-
* "configuration": {
|
|
11489
|
-
* "permissionKey": "BROWSE_PROJECTS"
|
|
11490
|
-
* }
|
|
11491
|
-
* }
|
|
11492
|
-
*
|
|
11493
|
-
* * `permissionKey` The permission required to perform the transition. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions.
|
|
11494
|
-
*
|
|
11495
|
-
* ##### Previous status condition #####
|
|
11496
|
-
*
|
|
11497
|
-
* A condition that allows a transition based on whether an issue has or has not transitioned through a status.
|
|
11498
|
-
*
|
|
11499
|
-
* {
|
|
11500
|
-
* "type": "PreviousStatusCondition",
|
|
11501
|
-
* "configuration": {
|
|
11502
|
-
* "ignoreLoopTransitions": true,
|
|
11503
|
-
* "includeCurrentStatus": true,
|
|
11504
|
-
* "mostRecentStatusOnly": true,
|
|
11505
|
-
* "reverseCondition": true,
|
|
11506
|
-
* "previousStatus": {
|
|
11507
|
-
* "id": "5"
|
|
11508
|
-
* }
|
|
11509
|
-
* }
|
|
11510
|
-
* }
|
|
11511
|
-
*
|
|
11512
|
-
* By default this condition allows the transition if the status, as defined by its ID in the `previousStatus` object, matches any previous issue status, unless:
|
|
11513
|
-
*
|
|
11514
|
-
* * `ignoreLoopTransitions` is `true`, then loop transitions (from and to the same status) are ignored.
|
|
11515
|
-
* * `includeCurrentStatus` is `true`, then the current issue status is also checked.
|
|
11516
|
-
* * `mostRecentStatusOnly` is `true`, then only the issue's preceding status (the one immediately before the current status) is checked.
|
|
11517
|
-
* * `reverseCondition` is `true`, then the status must not be present.
|
|
11518
|
-
*
|
|
11519
|
-
* ##### Separation of duties condition #####
|
|
11520
|
-
*
|
|
11521
|
-
* A condition that prevents a user to perform the transition, if the user has already performed a transition on the issue.
|
|
11522
|
-
*
|
|
11523
|
-
* {
|
|
11524
|
-
* "type": "SeparationOfDutiesCondition",
|
|
11525
|
-
* "configuration": {
|
|
11526
|
-
* "fromStatus": {
|
|
11527
|
-
* "id": "5"
|
|
11528
|
-
* },
|
|
11529
|
-
* "toStatus": {
|
|
11530
|
-
* "id": "6"
|
|
11531
|
-
* }
|
|
11532
|
-
* }
|
|
11533
|
-
* }
|
|
11534
|
-
*
|
|
11535
|
-
* * `fromStatus` OPTIONAL. An object containing the ID of the source status of the transition that is blocked. If omitted any transition to `toStatus` is blocked.
|
|
11536
|
-
* * `toStatus` An object containing the ID of the target status of the transition that is blocked.
|
|
11537
|
-
*
|
|
11538
|
-
* ##### Subtask blocking condition #####
|
|
11539
|
-
*
|
|
11540
|
-
* A condition that blocks transition on a parent issue if any of its subtasks are in any of one or more statuses.
|
|
11541
|
-
*
|
|
11542
|
-
* {
|
|
11543
|
-
* "type": "SubTaskBlockingCondition",
|
|
11544
|
-
* "configuration": {
|
|
11545
|
-
* "statuses": [
|
|
11546
|
-
* {
|
|
11547
|
-
* "id": "1"
|
|
11548
|
-
* },
|
|
11549
|
-
* {
|
|
11550
|
-
* "id": "3"
|
|
11551
|
-
* }
|
|
11552
|
-
* ]
|
|
11553
|
-
* }
|
|
11554
|
-
* }
|
|
11555
|
-
*
|
|
11556
|
-
* * `statuses` A list of objects containing status IDs.
|
|
11557
|
-
*
|
|
11558
|
-
* ##### User is in any group condition #####
|
|
11559
|
-
*
|
|
11560
|
-
* A condition that allows users belonging to any group from a list of groups to execute a transition.
|
|
11561
|
-
*
|
|
11562
|
-
* {
|
|
11563
|
-
* "type": "UserInAnyGroupCondition",
|
|
11564
|
-
* "configuration": {
|
|
11565
|
-
* "groups": [
|
|
11566
|
-
* "administrators",
|
|
11567
|
-
* "atlassian-addons-admin"
|
|
11568
|
-
* ]
|
|
11569
|
-
* }
|
|
11570
|
-
* }
|
|
11571
|
-
*
|
|
11572
|
-
* * `groups` A list of group names.
|
|
11573
|
-
*
|
|
11574
|
-
* ##### User is in any project role condition #####
|
|
11575
|
-
*
|
|
11576
|
-
* A condition that allows only users with at least one project roles from a list of project roles to execute a transition.
|
|
11577
|
-
*
|
|
11578
|
-
* {
|
|
11579
|
-
* "type": "InAnyProjectRoleCondition",
|
|
11580
|
-
* "configuration": {
|
|
11581
|
-
* "projectRoles": [
|
|
11582
|
-
* {
|
|
11583
|
-
* "id": "10002"
|
|
11584
|
-
* },
|
|
11585
|
-
* {
|
|
11586
|
-
* "id": "10003"
|
|
11587
|
-
* },
|
|
11588
|
-
* {
|
|
11589
|
-
* "id": "10012"
|
|
11590
|
-
* },
|
|
11591
|
-
* {
|
|
11592
|
-
* "id": "10013"
|
|
11593
|
-
* }
|
|
11594
|
-
* ]
|
|
11595
|
-
* }
|
|
11596
|
-
* }
|
|
11597
|
-
*
|
|
11598
|
-
* * `projectRoles` A list of objects containing project role IDs.
|
|
11599
|
-
*
|
|
11600
|
-
* ##### User is in custom field condition #####
|
|
11601
|
-
*
|
|
11602
|
-
* A condition that allows only users listed in a given custom field to execute the transition.
|
|
11603
|
-
*
|
|
11604
|
-
* {
|
|
11605
|
-
* "type": "UserIsInCustomFieldCondition",
|
|
11606
|
-
* "configuration": {
|
|
11607
|
-
* "allowUserInField": false,
|
|
11608
|
-
* "fieldId": "customfield_10010"
|
|
11609
|
-
* }
|
|
11610
|
-
* }
|
|
11611
|
-
*
|
|
11612
|
-
* * `allowUserInField` If `true` only a user who is listed in `fieldId` can perform the transition, otherwise, only a user who is not listed in `fieldId` can perform the transition.
|
|
11613
|
-
* * `fieldId` The ID of the field containing the list of users.
|
|
11614
|
-
*
|
|
11615
|
-
* ##### User is in group condition #####
|
|
11616
|
-
*
|
|
11617
|
-
* A condition that allows users belonging to a group to execute a transition.
|
|
11618
|
-
*
|
|
11619
|
-
* {
|
|
11620
|
-
* "type": "UserInGroupCondition",
|
|
11621
|
-
* "configuration": {
|
|
11622
|
-
* "group": "administrators"
|
|
11623
|
-
* }
|
|
11624
|
-
* }
|
|
11625
|
-
*
|
|
11626
|
-
* * `group` The name of the group.
|
|
11627
|
-
*
|
|
11628
|
-
* ##### User is in group custom field condition #####
|
|
11629
|
-
*
|
|
11630
|
-
* A condition that allows users belonging to a group specified in a custom field to execute a transition.
|
|
11631
|
-
*
|
|
11632
|
-
* {
|
|
11633
|
-
* "type": "InGroupCFCondition",
|
|
11634
|
-
* "configuration": {
|
|
11635
|
-
* "fieldId": "customfield_10012"
|
|
11636
|
-
* }
|
|
11637
|
-
* }
|
|
11638
|
-
*
|
|
11639
|
-
* * `fieldId` The ID of the field. Allowed field types:
|
|
11640
|
-
*
|
|
11641
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker`
|
|
11642
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker`
|
|
11643
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:select`
|
|
11644
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:multiselect`
|
|
11645
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`
|
|
11646
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`
|
|
11647
|
-
* * `com.pyxis.greenhopper.jira:gh-epic-status`
|
|
11648
|
-
*
|
|
11649
|
-
* ##### User is in project role condition #####
|
|
11650
|
-
*
|
|
11651
|
-
* A condition that allows users with a project role to execute a transition.
|
|
11652
|
-
*
|
|
11653
|
-
* {
|
|
11654
|
-
* "type": "InProjectRoleCondition",
|
|
11655
|
-
* "configuration": {
|
|
11656
|
-
* "projectRole": {
|
|
11657
|
-
* "id": "10002"
|
|
11658
|
-
* }
|
|
11659
|
-
* }
|
|
11660
|
-
* }
|
|
11661
|
-
*
|
|
11662
|
-
* * `projectRole` An object containing the ID of a project role.
|
|
11663
|
-
*
|
|
11664
|
-
* ##### Value field condition #####
|
|
11665
|
-
*
|
|
11666
|
-
* A conditions that allows a transition to execute if the value of a field is equal to a constant value or simply set.
|
|
11667
|
-
*
|
|
11668
|
-
* {
|
|
11669
|
-
* "type": "ValueFieldCondition",
|
|
11670
|
-
* "configuration": {
|
|
11671
|
-
* "fieldId": "assignee",
|
|
11672
|
-
* "fieldValue": "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",
|
|
11673
|
-
* "comparisonType": "NUMBER",
|
|
11674
|
-
* "comparator": "="
|
|
11675
|
-
* }
|
|
11676
|
-
* }
|
|
11677
|
-
*
|
|
11678
|
-
* * `fieldId` The ID of a field used in the comparison.
|
|
11679
|
-
* * `fieldValue` The expected value of the field.
|
|
11680
|
-
* * `comparisonType` The type of the comparison. Allowed values: `STRING`, `NUMBER`, `DATE`, `DATE_WITHOUT_TIME`, or `OPTIONID`.
|
|
11681
|
-
* * `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, `!=`.
|
|
11682
|
-
*
|
|
11683
|
-
* **Notes:**
|
|
11684
|
-
*
|
|
11685
|
-
* * If you choose the comparison type `STRING`, only `=` and `!=` are valid options.
|
|
11686
|
-
* * You may leave `fieldValue` empty when comparison type is `!=` to indicate that a value is required in the field.
|
|
11687
|
-
* * For date fields without time format values as `yyyy-MM-dd`, and for those with time as `yyyy-MM-dd HH:mm`. For example, for July 16 2021 use `2021-07-16`, for 8:05 AM use `2021-07-16 08:05`, and for 4 PM: `2021-07-16 16:00`.
|
|
11688
|
-
*
|
|
11689
|
-
* #### Validators ####
|
|
11690
|
-
*
|
|
11691
|
-
* Validators check that any input made to the transition is valid before the transition is performed.
|
|
11692
|
-
*
|
|
11693
|
-
* ##### Date field validator #####
|
|
11694
|
-
*
|
|
11695
|
-
* A validator that compares two dates.
|
|
11696
|
-
*
|
|
11697
|
-
* {
|
|
11698
|
-
* "type": "DateFieldValidator",
|
|
11699
|
-
* "configuration": {
|
|
11700
|
-
* "comparator": ">",
|
|
11701
|
-
* "date1": "updated",
|
|
11702
|
-
* "date2": "created",
|
|
11703
|
-
* "expression": "1d",
|
|
11704
|
-
* "includeTime": true
|
|
11705
|
-
* }
|
|
11706
|
-
* }
|
|
11707
|
-
*
|
|
11708
|
-
* * `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, or `!=`.
|
|
11709
|
-
* * `date1` The date field to validate. Allowed field types:
|
|
11710
|
-
*
|
|
11711
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
|
|
11712
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
|
|
11713
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-end`
|
|
11714
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-start`
|
|
11715
|
-
* * `duedate`
|
|
11716
|
-
* * `created`
|
|
11717
|
-
* * `updated`
|
|
11718
|
-
* * `resolutiondate`
|
|
11719
|
-
* * `date2` The second date field. Required, if `expression` is not passed. Allowed field types:
|
|
11720
|
-
*
|
|
11721
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
|
|
11722
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
|
|
11723
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-end`
|
|
11724
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-start`
|
|
11725
|
-
* * `duedate`
|
|
11726
|
-
* * `created`
|
|
11727
|
-
* * `updated`
|
|
11728
|
-
* * `resolutiondate`
|
|
11729
|
-
* * `expression` An expression specifying an offset. Required, if `date2` is not passed. Offsets are built with a number, with `-` as prefix for the past, and one of these time units: `d` for day, `w` for week, `m` for month, or `y` for year. For example, -2d means two days into the past and 1w means one week into the future. The `now` keyword enables a comparison with the current date.
|
|
11730
|
-
* * `includeTime` If `true`, then the time part of the data is included for the comparison. If the field doesn't have a time part, 00:00:00 is used.
|
|
11731
|
-
*
|
|
11732
|
-
* ##### Windows date validator #####
|
|
11733
|
-
*
|
|
11734
|
-
* A validator that checks that a date falls on or after a reference date and before or on the reference date plus a number of days.
|
|
11735
|
-
*
|
|
11736
|
-
* {
|
|
11737
|
-
* "type": "WindowsDateValidator",
|
|
11738
|
-
* "configuration": {
|
|
11739
|
-
* "date1": "customfield_10009",
|
|
11740
|
-
* "date2": "created",
|
|
11741
|
-
* "windowsDays": 5
|
|
11742
|
-
* }
|
|
11743
|
-
* }
|
|
11744
|
-
*
|
|
11745
|
-
* * `date1` The date field to validate. Allowed field types:
|
|
11746
|
-
*
|
|
11747
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
|
|
11748
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
|
|
11749
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-end`
|
|
11750
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-start`
|
|
11751
|
-
* * `duedate`
|
|
11752
|
-
* * `created`
|
|
11753
|
-
* * `updated`
|
|
11754
|
-
* * `resolutiondate`
|
|
11755
|
-
* * `date2` The reference date. Allowed field types:
|
|
11756
|
-
*
|
|
11757
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
|
|
11758
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
|
|
11759
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-end`
|
|
11760
|
-
* * `com.atlassian.jpo:jpo-custom-field-baseline-start`
|
|
11761
|
-
* * `duedate`
|
|
11762
|
-
* * `created`
|
|
11763
|
-
* * `updated`
|
|
11764
|
-
* * `resolutiondate`
|
|
11765
|
-
* * `windowsDays` A positive integer indicating a number of days.
|
|
11766
|
-
*
|
|
11767
|
-
* ##### Field required validator #####
|
|
11768
|
-
*
|
|
11769
|
-
* A validator that checks fields are not empty. By default, if a field is not included in the current context it's ignored and not validated.
|
|
11770
|
-
*
|
|
11771
|
-
* {
|
|
11772
|
-
* "type": "FieldRequiredValidator",
|
|
11773
|
-
* "configuration": {
|
|
11774
|
-
* "ignoreContext": true,
|
|
11775
|
-
* "errorMessage": "Hey",
|
|
11776
|
-
* "fieldIds": [
|
|
11777
|
-
* "versions",
|
|
11778
|
-
* "customfield_10037",
|
|
11779
|
-
* "customfield_10003"
|
|
11780
|
-
* ]
|
|
11781
|
-
* }
|
|
11782
|
-
* }
|
|
11783
|
-
*
|
|
11784
|
-
* * `ignoreContext` If `true`, then the context is ignored and all the fields are validated.
|
|
11785
|
-
* * `errorMessage` OPTIONAL. The error message displayed when one or more fields are empty. A default error message is shown if an error message is not provided.
|
|
11786
|
-
* * `fieldIds` The list of fields to validate.
|
|
11787
|
-
*
|
|
11788
|
-
* ##### Field changed validator #####
|
|
11789
|
-
*
|
|
11790
|
-
* A validator that checks that a field value is changed. However, this validation can be ignored for users from a list of groups.
|
|
11791
|
-
*
|
|
11792
|
-
* {
|
|
11793
|
-
* "type": "FieldChangedValidator",
|
|
11794
|
-
* "configuration": {
|
|
11795
|
-
* "fieldId": "comment",
|
|
11796
|
-
* "errorMessage": "Hey",
|
|
11797
|
-
* "exemptedGroups": [
|
|
11798
|
-
* "administrators",
|
|
11799
|
-
* "atlassian-addons-admin"
|
|
11800
|
-
* ]
|
|
11801
|
-
* }
|
|
11802
|
-
* }
|
|
11803
|
-
*
|
|
11804
|
-
* * `fieldId` The ID of a field.
|
|
11805
|
-
* * `errorMessage` OPTIONAL. The error message displayed if the field is not changed. A default error message is shown if the error message is not provided.
|
|
11806
|
-
* * `exemptedGroups` OPTIONAL. The list of groups.
|
|
11807
|
-
*
|
|
11808
|
-
* ##### Field has single value validator #####
|
|
11809
|
-
*
|
|
11810
|
-
* A validator that checks that a multi-select field has only one value. Optionally, the validation can ignore values copied from subtasks.
|
|
11811
|
-
*
|
|
11812
|
-
* {
|
|
11813
|
-
* "type": "FieldHasSingleValueValidator",
|
|
11814
|
-
* "configuration": {
|
|
11815
|
-
* "fieldId": "attachment,
|
|
11816
|
-
* "excludeSubtasks": true
|
|
11817
|
-
* }
|
|
11818
|
-
* }
|
|
11819
|
-
*
|
|
11820
|
-
* * `fieldId` The ID of a field.
|
|
11821
|
-
* * `excludeSubtasks` If `true`, then values copied from subtasks are ignored.
|
|
11822
|
-
*
|
|
11823
|
-
* ##### Parent status validator #####
|
|
11824
|
-
*
|
|
11825
|
-
* A validator that checks the status of the parent issue of a subtask. Ìf the issue is not a subtask, no validation is performed.
|
|
11826
|
-
*
|
|
11827
|
-
* {
|
|
11828
|
-
* "type": "ParentStatusValidator",
|
|
11829
|
-
* "configuration": {
|
|
11830
|
-
* "parentStatuses": [
|
|
11831
|
-
* {
|
|
11832
|
-
* "id":"1"
|
|
11833
|
-
* },
|
|
11834
|
-
* {
|
|
11835
|
-
* "id":"2"
|
|
11836
|
-
* }
|
|
11837
|
-
* ]
|
|
11838
|
-
* }
|
|
11839
|
-
* }
|
|
11840
|
-
*
|
|
11841
|
-
* * `parentStatus` The list of required parent issue statuses.
|
|
11842
|
-
*
|
|
11843
|
-
* ##### Permission validator #####
|
|
11844
|
-
*
|
|
11845
|
-
* A validator that checks the user has a permission.
|
|
11846
|
-
*
|
|
11847
|
-
* {
|
|
11848
|
-
* "type": "PermissionValidator",
|
|
11849
|
-
* "configuration": {
|
|
11850
|
-
* "permissionKey": "ADMINISTER_PROJECTS"
|
|
11851
|
-
* }
|
|
11852
|
-
* }
|
|
11853
|
-
*
|
|
11854
|
-
* * `permissionKey` The permission required to perform the transition. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions.
|
|
11855
|
-
*
|
|
11856
|
-
* ##### Previous status validator #####
|
|
11857
|
-
*
|
|
11858
|
-
* A validator that checks if the issue has held a status.
|
|
11859
|
-
*
|
|
11860
|
-
* {
|
|
11861
|
-
* "type": "PreviousStatusValidator",
|
|
11862
|
-
* "configuration": {
|
|
11863
|
-
* "mostRecentStatusOnly": false,
|
|
11864
|
-
* "previousStatus": {
|
|
11865
|
-
* "id": "15"
|
|
11866
|
-
* }
|
|
11867
|
-
* }
|
|
11868
|
-
* }
|
|
11869
|
-
*
|
|
11870
|
-
* * `mostRecentStatusOnly` If `true`, then only the issue's preceding status (the one immediately before the current status) is checked.
|
|
11871
|
-
* * `previousStatus` An object containing the ID of an issue status.
|
|
11872
|
-
*
|
|
11873
|
-
* ##### Regular expression validator #####
|
|
11874
|
-
*
|
|
11875
|
-
* A validator that checks the content of a field against a regular expression.
|
|
11876
|
-
*
|
|
11877
|
-
* {
|
|
11878
|
-
* "type": "RegexpFieldValidator",
|
|
11879
|
-
* "configuration": {
|
|
11880
|
-
* "regExp": "[0-9]",
|
|
11881
|
-
* "fieldId": "customfield_10029"
|
|
11882
|
-
* }
|
|
11883
|
-
* }
|
|
11884
|
-
*
|
|
11885
|
-
* * `regExp`A regular expression.
|
|
11886
|
-
* * `fieldId` The ID of a field. Allowed field types:
|
|
11887
|
-
*
|
|
11888
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:select`
|
|
11889
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:multiselect`
|
|
11890
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`
|
|
11891
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`
|
|
11892
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:textarea`
|
|
11893
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:textfield`
|
|
11894
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:url`
|
|
11895
|
-
* * `com.atlassian.jira.plugin.system.customfieldtypes:float`
|
|
11896
|
-
* * `com.pyxis.greenhopper.jira:jsw-story-points`
|
|
11897
|
-
* * `com.pyxis.greenhopper.jira:gh-epic-status`
|
|
11898
|
-
* * `description`
|
|
11899
|
-
* * `summary`
|
|
11900
|
-
*
|
|
11901
|
-
* ##### User permission validator #####
|
|
11902
|
-
*
|
|
11903
|
-
* A validator that checks if a user has a permission. Obsolete. You may encounter this validator when getting transition rules and can pass it when updating or creating rules, for example, when you want to duplicate the rules from a workflow on a new workflow.
|
|
11904
|
-
*
|
|
11905
|
-
* {
|
|
11906
|
-
* "type": "UserPermissionValidator",
|
|
11907
|
-
* "configuration": {
|
|
11908
|
-
* "permissionKey": "BROWSE_PROJECTS",
|
|
11909
|
-
* "nullAllowed": false,
|
|
11910
|
-
* "username": "TestUser"
|
|
11911
|
-
* }
|
|
11912
|
-
* }
|
|
11913
|
-
*
|
|
11914
|
-
* * `permissionKey` The permission to be validated. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions.
|
|
11915
|
-
* * `nullAllowed` If `true`, allows the transition when `username` is empty.
|
|
11916
|
-
* * `username` The username to validate against the `permissionKey`.
|
|
11917
|
-
*
|
|
11918
|
-
* #### Post functions ####
|
|
11919
|
-
*
|
|
11920
|
-
* Post functions carry out any additional processing required after a Jira workflow transition is executed.
|
|
11921
|
-
*
|
|
11922
|
-
* ##### Fire issue event function #####
|
|
11923
|
-
*
|
|
11924
|
-
* A post function that fires an event that is processed by the listeners.
|
|
11925
|
-
*
|
|
11926
|
-
* {
|
|
11927
|
-
* "type": "FireIssueEventFunction",
|
|
11928
|
-
* "configuration": {
|
|
11929
|
-
* "event": {
|
|
11930
|
-
* "id":"1"
|
|
11931
|
-
* }
|
|
11932
|
-
* }
|
|
11933
|
-
* }
|
|
11934
|
-
*
|
|
11935
|
-
* **Note:** If provided, this post function overrides the default `FireIssueEventFunction`. Can be included once in a transition.
|
|
11936
|
-
*
|
|
11937
|
-
* * `event` An object containing the ID of the issue event.
|
|
11938
|
-
*
|
|
11939
|
-
* ##### Update issue status #####
|
|
11940
|
-
*
|
|
11941
|
-
* A post function that sets issue status to the linked status of the destination workflow status.
|
|
11942
|
-
*
|
|
11943
|
-
* {
|
|
11944
|
-
* "type": "UpdateIssueStatusFunction"
|
|
11945
|
-
* }
|
|
11946
|
-
*
|
|
11947
|
-
* **Note:** This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.
|
|
11948
|
-
*
|
|
11949
|
-
* ##### Create comment #####
|
|
11950
|
-
*
|
|
11951
|
-
* A post function that adds a comment entered during the transition to an issue.
|
|
11952
|
-
*
|
|
11953
|
-
* {
|
|
11954
|
-
* "type": "CreateCommentFunction"
|
|
11955
|
-
* }
|
|
11956
|
-
*
|
|
11957
|
-
* **Note:** This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.
|
|
11958
|
-
*
|
|
11959
|
-
* ##### Store issue #####
|
|
11960
|
-
*
|
|
11961
|
-
* A post function that stores updates to an issue.
|
|
11962
|
-
*
|
|
11963
|
-
* {
|
|
11964
|
-
* "type": "IssueStoreFunction"
|
|
11965
|
-
* }
|
|
11966
|
-
*
|
|
11967
|
-
* **Note:** This post function can only be added to the initial transition and can only be added once.
|
|
11968
|
-
*
|
|
11969
|
-
* ##### Assign to current user function #####
|
|
11970
|
-
*
|
|
11971
|
-
* A post function that assigns the issue to the current user if the current user has the `ASSIGNABLE_USER` permission.
|
|
11972
|
-
*
|
|
11973
|
-
* {
|
|
11974
|
-
* "type": "AssignToCurrentUserFunction"
|
|
11975
|
-
* }
|
|
11976
|
-
*
|
|
11977
|
-
* **Note:** This post function can be included once in a transition.
|
|
11978
|
-
*
|
|
11979
|
-
* ##### Assign to lead function #####
|
|
11980
|
-
*
|
|
11981
|
-
* A post function that assigns the issue to the project or component lead developer.
|
|
11982
|
-
*
|
|
11983
|
-
* {
|
|
11984
|
-
* "type": "AssignToLeadFunction"
|
|
11985
|
-
* }
|
|
11986
|
-
*
|
|
11987
|
-
* **Note:** This post function can be included once in a transition.
|
|
11988
|
-
*
|
|
11989
|
-
* ##### Assign to reporter function #####
|
|
11990
|
-
*
|
|
11991
|
-
* A post function that assigns the issue to the reporter.
|
|
11992
|
-
*
|
|
11993
|
-
* {
|
|
11994
|
-
* "type": "AssignToReporterFunction"
|
|
11995
|
-
* }
|
|
11996
|
-
*
|
|
11997
|
-
* **Note:** This post function can be included once in a transition.
|
|
11998
|
-
*
|
|
11999
|
-
* ##### Clear field value function #####
|
|
12000
|
-
*
|
|
12001
|
-
* A post function that clears the value from a field.
|
|
12002
|
-
*
|
|
12003
|
-
* {
|
|
12004
|
-
* "type": "ClearFieldValuePostFunction",
|
|
12005
|
-
* "configuration": {
|
|
12006
|
-
* "fieldId": "assignee"
|
|
12007
|
-
* }
|
|
12008
|
-
* }
|
|
12009
|
-
*
|
|
12010
|
-
* * `fieldId` The ID of the field.
|
|
12011
|
-
*
|
|
12012
|
-
* ##### Copy value from other field function #####
|
|
12013
|
-
*
|
|
12014
|
-
* A post function that copies the value of one field to another, either within an issue or from parent to subtask.
|
|
12015
|
-
*
|
|
12016
|
-
* {
|
|
12017
|
-
* "type": "CopyValueFromOtherFieldPostFunction",
|
|
12018
|
-
* "configuration": {
|
|
12019
|
-
* "sourceFieldId": "assignee",
|
|
12020
|
-
* "destinationFieldId": "creator",
|
|
12021
|
-
* "copyType": "same"
|
|
12022
|
-
* }
|
|
12023
|
-
* }
|
|
12024
|
-
*
|
|
12025
|
-
* * `sourceFieldId` The ID of the source field.
|
|
12026
|
-
* * `destinationFieldId` The ID of the destination field.
|
|
12027
|
-
* * `copyType` Use `same` to copy the value from a field inside the issue, or `parent` to copy the value from the parent issue.
|
|
12028
|
-
*
|
|
12029
|
-
* ##### Create Crucible review workflow function (deprecated) #####
|
|
12030
|
-
*
|
|
12031
|
-
* A post function that creates a Crucible review for all unreviewed code for the issue.
|
|
12032
|
-
*
|
|
12033
|
-
* {
|
|
12034
|
-
* "type": "CreateCrucibleReviewWorkflowFunction"
|
|
12035
|
-
* }
|
|
12036
|
-
*
|
|
12037
|
-
* **Note:** This post function can be included once in a transition.
|
|
12038
|
-
*
|
|
12039
|
-
* ##### Set issue security level based on user's project role function #####
|
|
12040
|
-
*
|
|
12041
|
-
* A post function that sets the issue's security level if the current user has a project role.
|
|
12042
|
-
*
|
|
12043
|
-
* {
|
|
12044
|
-
* "type": "SetIssueSecurityFromRoleFunction",
|
|
12045
|
-
* "configuration": {
|
|
12046
|
-
* "projectRole": {
|
|
12047
|
-
* "id":"10002"
|
|
12048
|
-
* },
|
|
12049
|
-
* "issueSecurityLevel": {
|
|
12050
|
-
* "id":"10000"
|
|
12051
|
-
* }
|
|
12052
|
-
* }
|
|
12053
|
-
* }
|
|
12054
|
-
*
|
|
12055
|
-
* * `projectRole` An object containing the ID of the project role.
|
|
12056
|
-
* * `issueSecurityLevel` OPTIONAL. The object containing the ID of the security level. If not passed, then the security level is set to `none`.
|
|
12057
|
-
*
|
|
12058
|
-
* ##### Trigger a webhook function #####
|
|
12059
|
-
*
|
|
12060
|
-
* A post function that triggers a webhook.
|
|
12061
|
-
*
|
|
12062
|
-
* {
|
|
12063
|
-
* "type": "TriggerWebhookFunction",
|
|
12064
|
-
* "configuration": {
|
|
12065
|
-
* "webhook": {
|
|
12066
|
-
* "id": "1"
|
|
12067
|
-
* }
|
|
12068
|
-
* }
|
|
12069
|
-
* }
|
|
12070
|
-
*
|
|
12071
|
-
* * `webhook` An object containing the ID of the webhook listener to trigger.
|
|
12072
|
-
*
|
|
12073
|
-
* ##### Update issue custom field function #####
|
|
12074
|
-
*
|
|
12075
|
-
* A post function that updates the content of an issue custom field.
|
|
12076
|
-
*
|
|
12077
|
-
* {
|
|
12078
|
-
* "type": "UpdateIssueCustomFieldPostFunction",
|
|
12079
|
-
* "configuration": {
|
|
12080
|
-
* "mode": "append",
|
|
12081
|
-
* "fieldId": "customfield_10003",
|
|
12082
|
-
* "fieldValue": "yikes"
|
|
12083
|
-
* }
|
|
12084
|
-
* }
|
|
12085
|
-
*
|
|
12086
|
-
* * `mode` Use `replace` to override the field content with `fieldValue` or `append` to add `fieldValue` to the end of the field content.
|
|
12087
|
-
* * `fieldId` The ID of the field.
|
|
12088
|
-
* * `fieldValue` The update content.
|
|
12089
|
-
*
|
|
12090
|
-
* ##### Update issue field function #####
|
|
12091
|
-
*
|
|
12092
|
-
* A post function that updates a simple issue field.
|
|
12093
|
-
*
|
|
12094
|
-
* {
|
|
12095
|
-
* "type": "UpdateIssueFieldFunction",
|
|
12096
|
-
* "configuration": {
|
|
12097
|
-
* "fieldId": "assignee",
|
|
12098
|
-
* "fieldValue": "5f0c277e70b8a90025a00776"
|
|
12099
|
-
* }
|
|
12100
|
-
* }
|
|
12101
|
-
*
|
|
12102
|
-
* * `fieldId` The ID of the field. Allowed field types:
|
|
12103
|
-
*
|
|
12104
|
-
* * `assignee`
|
|
12105
|
-
* * `description`
|
|
12106
|
-
* * `environment`
|
|
12107
|
-
* * `priority`
|
|
12108
|
-
* * `resolution`
|
|
12109
|
-
* * `summary`
|
|
12110
|
-
* * `timeoriginalestimate`
|
|
12111
|
-
* * `timeestimate`
|
|
12112
|
-
* * `timespent`
|
|
12113
|
-
* * `fieldValue` The update value.
|
|
12114
|
-
* * If the `fieldId` is `assignee`, the `fieldValue` should be one of these values:
|
|
12115
|
-
*
|
|
12116
|
-
* * an account ID.
|
|
12117
|
-
* * `automatic`.
|
|
12118
|
-
* * a blank string, which sets the value to `unassigned`.
|
|
12119
|
-
*
|
|
12120
|
-
* #### Connect rules ####
|
|
12121
|
-
*
|
|
12122
|
-
* Connect rules are conditions, validators, and post functions of a transition that are registered by Connect apps. To create a rule registered by the app, the app must be enabled and the rule's module must exist.
|
|
12123
|
-
*
|
|
12124
|
-
* {
|
|
12125
|
-
* "type": "appKey__moduleKey",
|
|
12126
|
-
* "configuration": {
|
|
12127
|
-
* "value":"{\"isValid\":\"true\"}"
|
|
12128
|
-
* }
|
|
12129
|
-
* }
|
|
12130
|
-
*
|
|
12131
|
-
* * `type` A Connect rule key in a form of `appKey__moduleKey`.
|
|
12132
|
-
* * `value` The stringified JSON configuration of a Connect rule.
|
|
12133
|
-
*
|
|
12134
|
-
* #### Forge rules ####
|
|
12135
|
-
*
|
|
12136
|
-
* Forge transition rules are not yet supported.
|
|
12137
|
-
*
|
|
12138
|
-
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
12139
|
-
*/
|
|
12140
|
-
post: operations["createWorkflow"];
|
|
12141
|
-
delete?: never;
|
|
12142
|
-
options?: never;
|
|
12143
|
-
head?: never;
|
|
12144
|
-
patch?: never;
|
|
12145
|
-
trace?: never;
|
|
12146
|
-
};
|
|
12147
11596
|
"/rest/api/3/workflow/history": {
|
|
12148
11597
|
parameters: {
|
|
12149
11598
|
query?: never;
|
|
@@ -12157,6 +11606,8 @@ export interface paths {
|
|
|
12157
11606
|
* Read workflow version from history
|
|
12158
11607
|
* @description Returns a workflow and related statuses for a specified workflow id and version number.
|
|
12159
11608
|
*
|
|
11609
|
+
* **Note:** Stored workflow data expires after 60 days. Additionally, no data from before the 30th of October 2025 is available.
|
|
11610
|
+
*
|
|
12160
11611
|
* **[Permissions](#permissions) required:**
|
|
12161
11612
|
*
|
|
12162
11613
|
* * *Administer Jira* global permission to access all, including project-scoped, workflows
|
|
@@ -12182,6 +11633,8 @@ export interface paths {
|
|
|
12182
11633
|
* List workflow history entries
|
|
12183
11634
|
* @description Returns a list of workflow history entries for a specified workflow id.
|
|
12184
11635
|
*
|
|
11636
|
+
* **Note:** Stored workflow data expires after 60 days. Additionally, no data from before the 30th of October 2025 is available.
|
|
11637
|
+
*
|
|
12185
11638
|
* **[Permissions](#permissions) required:**
|
|
12186
11639
|
*
|
|
12187
11640
|
* * *Administer Jira* global permission to access all, including project-scoped, workflows
|
|
@@ -12232,6 +11685,8 @@ export interface paths {
|
|
|
12232
11685
|
*
|
|
12233
11686
|
* Rules are enabled if the `disabled` parameter is not provided.
|
|
12234
11687
|
*
|
|
11688
|
+
* **Note:** The `draft` parameter in the request body WorkflowId is deprecated and will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147).
|
|
11689
|
+
*
|
|
12235
11690
|
* **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation.
|
|
12236
11691
|
*/
|
|
12237
11692
|
put: operations["updateWorkflowTransitionRuleConfigurations"];
|
|
@@ -12260,6 +11715,8 @@ export interface paths {
|
|
|
12260
11715
|
*
|
|
12261
11716
|
* Only rules created by the calling Connect app can be deleted.
|
|
12262
11717
|
*
|
|
11718
|
+
* **Note:** The `draft` parameter in the request body WorkflowId is deprecated and will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147).
|
|
11719
|
+
*
|
|
12263
11720
|
* **[Permissions](#permissions) required:** Only Connect apps can use this operation.
|
|
12264
11721
|
*/
|
|
12265
11722
|
put: operations["deleteWorkflowTransitionRuleConfigurations"];
|
|
@@ -12922,6 +12379,23 @@ export interface paths {
|
|
|
12922
12379
|
*
|
|
12923
12380
|
* * `webhookId` the ID of the webhook.
|
|
12924
12381
|
*
|
|
12382
|
+
* ##### Trigger agent #####
|
|
12383
|
+
*
|
|
12384
|
+
* A post function that triggers a Jira AI agent for the issue after the transition runs, using the configured agent and an optional prompt. The agent run is asynchronous: it is scheduled after the transition finishes and does not block the transition.
|
|
12385
|
+
*
|
|
12386
|
+
* {
|
|
12387
|
+
* "ruleKey": "system:trigger-agent",
|
|
12388
|
+
* "parameters": {
|
|
12389
|
+
* "agentId": "712020:3c6d3f05-331a-4488-932e-37c34b704720",
|
|
12390
|
+
* "promptValue": ""
|
|
12391
|
+
* }
|
|
12392
|
+
* }
|
|
12393
|
+
*
|
|
12394
|
+
* Parameters:
|
|
12395
|
+
*
|
|
12396
|
+
* * `agentId` the identifier of the agent to trigger (the Atlassian account ID of the agent).
|
|
12397
|
+
* * `promptValue` optional text passed to the agent as a user prompt after the transition runs; use an empty string if no extra prompt is needed.
|
|
12398
|
+
*
|
|
12925
12399
|
* #### Screen ####
|
|
12926
12400
|
*
|
|
12927
12401
|
* ##### Remind people to update fields #####
|
|
@@ -12993,7 +12467,9 @@ export interface paths {
|
|
|
12993
12467
|
* "parameters": {
|
|
12994
12468
|
* "key": "ari:cloud:ecosystem::extension/{appId}/{environmentId}/static/{moduleKey}",
|
|
12995
12469
|
* "config": "{"searchString":"workflow validator"}",
|
|
12996
|
-
* "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2"
|
|
12470
|
+
* "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2",
|
|
12471
|
+
* "disabled": "false",
|
|
12472
|
+
* "tag": ""
|
|
12997
12473
|
* }
|
|
12998
12474
|
* }
|
|
12999
12475
|
*
|
|
@@ -13003,6 +12479,8 @@ export interface paths {
|
|
|
13003
12479
|
* * `key` the identifier for the Forge app
|
|
13004
12480
|
* * `config` the persistent stringified JSON configuration for the Forge rule
|
|
13005
12481
|
* * `id` the ID of the Forge rule
|
|
12482
|
+
* * `disabled` determine if the Forge app is disabled. Allowed values: `true`, `false`.
|
|
12483
|
+
* * `tag` additional tags for the Forge app
|
|
13006
12484
|
*/
|
|
13007
12485
|
get: operations["workflowCapabilities"];
|
|
13008
12486
|
put?: never;
|
|
@@ -13242,6 +12720,32 @@ export interface paths {
|
|
|
13242
12720
|
patch?: never;
|
|
13243
12721
|
trace?: never;
|
|
13244
12722
|
};
|
|
12723
|
+
"/rest/api/3/workflowscheme/project/switch": {
|
|
12724
|
+
parameters: {
|
|
12725
|
+
query?: never;
|
|
12726
|
+
header?: never;
|
|
12727
|
+
path?: never;
|
|
12728
|
+
cookie?: never;
|
|
12729
|
+
};
|
|
12730
|
+
get?: never;
|
|
12731
|
+
put?: never;
|
|
12732
|
+
/**
|
|
12733
|
+
* Switch workflow scheme for project
|
|
12734
|
+
* @description Switches a workflow scheme for a project.
|
|
12735
|
+
*
|
|
12736
|
+
* Workflow schemes can only be assigned to classic projects.
|
|
12737
|
+
*
|
|
12738
|
+
* **Calculating required mappings:** If statuses from the current workflow scheme won't exist in the target workflow scheme, you must provide `mappingsByIssueTypeOverride` to specify how issues with those statuses should be migrated. Use [the required workflow scheme mappings API](#api-rest-api-3-workflowscheme-update-mappings-post) to determine which statuses and issue types require mappings.
|
|
12739
|
+
*
|
|
12740
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
12741
|
+
*/
|
|
12742
|
+
post: operations["switchWorkflowSchemeForProject"];
|
|
12743
|
+
delete?: never;
|
|
12744
|
+
options?: never;
|
|
12745
|
+
head?: never;
|
|
12746
|
+
patch?: never;
|
|
12747
|
+
trace?: never;
|
|
12748
|
+
};
|
|
13245
12749
|
"/rest/api/3/workflowscheme/read": {
|
|
13246
12750
|
parameters: {
|
|
13247
12751
|
query?: never;
|
|
@@ -13764,7 +13268,7 @@ export interface paths {
|
|
|
13764
13268
|
};
|
|
13765
13269
|
/**
|
|
13766
13270
|
* Get app properties
|
|
13767
|
-
* @description Gets all the properties of an app.
|
|
13271
|
+
* @description Gets all the properties of an app. The reserved key `connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8` is not returned.
|
|
13768
13272
|
*
|
|
13769
13273
|
* **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
|
|
13770
13274
|
* Additionally, Forge apps can access Connect app properties (stored against the same `app.connect.key`).
|
|
@@ -13787,7 +13291,9 @@ export interface paths {
|
|
|
13787
13291
|
};
|
|
13788
13292
|
/**
|
|
13789
13293
|
* Get app property
|
|
13790
|
-
* @description Returns the key and value of an app's property.
|
|
13294
|
+
* @description Returns the key and value of an app's property. The property key `connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8`
|
|
13295
|
+
* is reserved. It returns a synthetic, read-only property containing the Connect `clientKey` for the requested tenant.
|
|
13296
|
+
* This is intended for Forge apps with `app.connect.key` to retrieve the Connect client key during migration.
|
|
13791
13297
|
*
|
|
13792
13298
|
* **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
|
|
13793
13299
|
* Additionally, Forge apps can access Connect app properties (stored against the same `app.connect.key`).
|
|
@@ -13914,6 +13420,51 @@ export interface paths {
|
|
|
13914
13420
|
patch?: never;
|
|
13915
13421
|
trace?: never;
|
|
13916
13422
|
};
|
|
13423
|
+
"/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task": {
|
|
13424
|
+
parameters: {
|
|
13425
|
+
query?: never;
|
|
13426
|
+
header?: never;
|
|
13427
|
+
path?: never;
|
|
13428
|
+
cookie?: never;
|
|
13429
|
+
};
|
|
13430
|
+
/**
|
|
13431
|
+
* Get Connect issue field migration task
|
|
13432
|
+
* @description Returns the details of a Connect issue field's migration to Forge.
|
|
13433
|
+
*
|
|
13434
|
+
* When migrating a Connect app to Forge, [Issue Field](https://developer.atlassian.com/cloud/jira/software/modules/issue-field/) modules
|
|
13435
|
+
* must be converted to [Custom field](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/). When the
|
|
13436
|
+
* Forge version of the app is installed, Forge creates a
|
|
13437
|
+
* [background task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-group-tasks) to track the
|
|
13438
|
+
* migration of field data across. This endpoint returns the status and other details of that background task.
|
|
13439
|
+
*
|
|
13440
|
+
* For more details, see
|
|
13441
|
+
* [Jira modules > Jira Custom Fields](https://developer.atlassian.com/platform/adopting-forge-from-connect/migrate-jira-custom-fields/).
|
|
13442
|
+
*
|
|
13443
|
+
* **[Permissions](#permissions) required:** Only Connect and Forge apps can make this request.
|
|
13444
|
+
*/
|
|
13445
|
+
get: operations["ConnectToForgeMigrationFetchTaskResource.fetchMigrationTask_get"];
|
|
13446
|
+
put?: never;
|
|
13447
|
+
/**
|
|
13448
|
+
* Submit Connect issue field migration task
|
|
13449
|
+
* @description Submits a request to trigger migration of connect issue field to its Forge custom field counterpart.
|
|
13450
|
+
*
|
|
13451
|
+
* When migrating a Connect app to Forge, [Issue Field](https://developer.atlassian.com/cloud/jira/software/modules/issue-field/) modules
|
|
13452
|
+
* must be converted to [Custom field](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) modules.
|
|
13453
|
+
* This endpoint triggers the background migration of field data. Use the GET endpoint to retrieve
|
|
13454
|
+
* the status and progress of the task.
|
|
13455
|
+
*
|
|
13456
|
+
* For more details, see
|
|
13457
|
+
* [Jira modules > Jira Custom Fields](https://developer.atlassian.com/platform/adopting-forge-from-connect/migrate-jira-custom-fields/).
|
|
13458
|
+
*
|
|
13459
|
+
* **[Permissions](#permissions) required:** Only Connect and Forge apps can make this request.
|
|
13460
|
+
*/
|
|
13461
|
+
post: operations["ConnectToForgeMigrationTaskSubmissionResource.submitTask_post"];
|
|
13462
|
+
delete?: never;
|
|
13463
|
+
options?: never;
|
|
13464
|
+
head?: never;
|
|
13465
|
+
patch?: never;
|
|
13466
|
+
trace?: never;
|
|
13467
|
+
};
|
|
13917
13468
|
"/rest/atlassian-connect/1/service-registry": {
|
|
13918
13469
|
parameters: {
|
|
13919
13470
|
query?: never;
|
|
@@ -14656,6 +14207,13 @@ export interface components {
|
|
|
14656
14207
|
*/
|
|
14657
14208
|
state?: true | false;
|
|
14658
14209
|
};
|
|
14210
|
+
/** @description Configuration of features for one or more boards. Replaces the deprecated features field on BoardPayload */
|
|
14211
|
+
BoardFeaturesPayload: {
|
|
14212
|
+
/** @description A map of board PCRIs to the list of features to enable on each board. */
|
|
14213
|
+
boardFeatures?: {
|
|
14214
|
+
[key: string]: components["schemas"]["BoardFeaturePayload"][];
|
|
14215
|
+
};
|
|
14216
|
+
} | null;
|
|
14659
14217
|
/** @description The payload for creating a board */
|
|
14660
14218
|
BoardPayload: {
|
|
14661
14219
|
/**
|
|
@@ -14673,7 +14231,10 @@ export interface components {
|
|
|
14673
14231
|
cardLayouts?: components["schemas"]["CardLayoutField"][];
|
|
14674
14232
|
/** @description The columns of the board */
|
|
14675
14233
|
columns?: components["schemas"]["BoardColumnPayload"][];
|
|
14676
|
-
/**
|
|
14234
|
+
/**
|
|
14235
|
+
* @deprecated
|
|
14236
|
+
* @description Feature settings for the board. Deprecated: use boardFeatures capability instead.
|
|
14237
|
+
*/
|
|
14677
14238
|
features?: components["schemas"]["BoardFeaturePayload"][];
|
|
14678
14239
|
/** @description The name of the board */
|
|
14679
14240
|
name?: string;
|
|
@@ -15448,6 +15009,16 @@ export interface components {
|
|
|
15448
15009
|
/** @description The scope of the context. */
|
|
15449
15010
|
scope?: components["schemas"]["Scope"];
|
|
15450
15011
|
};
|
|
15012
|
+
/** @description Default values grouped by custom field context. */
|
|
15013
|
+
ContextDefaultValues: {
|
|
15014
|
+
/**
|
|
15015
|
+
* Format: int64
|
|
15016
|
+
* @description The ID of the context.
|
|
15017
|
+
*/
|
|
15018
|
+
contextId: number;
|
|
15019
|
+
/** @description Per-issue-type default values for this context. May contain a single entry for unconverted contexts, or one entry per issue type for converted contexts. */
|
|
15020
|
+
defaultValues?: components["schemas"]["IssueTypeDefaultValue"][];
|
|
15021
|
+
};
|
|
15451
15022
|
/** @description The project and issue type mapping with a matching custom field context. */
|
|
15452
15023
|
ContextForProjectAndIssueType: {
|
|
15453
15024
|
/** @description The ID of the custom field context. */
|
|
@@ -15722,9 +15293,15 @@ export interface components {
|
|
|
15722
15293
|
description?: string;
|
|
15723
15294
|
/**
|
|
15724
15295
|
* Format: int64
|
|
15725
|
-
* @
|
|
15296
|
+
* @deprecated
|
|
15297
|
+
* @description Deprecated use [fieldScheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) instead. The ID of the field configuration scheme for the project. Use the [Get all field configuration schemes](#api-rest-api-3-fieldconfigurationscheme-get) operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.
|
|
15726
15298
|
*/
|
|
15727
15299
|
fieldConfigurationScheme?: number;
|
|
15300
|
+
/**
|
|
15301
|
+
* Format: int64
|
|
15302
|
+
* @description The ID of the field scheme for the project. Use the [Get field schemes](#api-rest-api-3-config-fieldschemes-get) operation to get a list of field scheme IDs. If you specify the field scheme you cannot specify the project template key.
|
|
15303
|
+
*/
|
|
15304
|
+
fieldScheme?: number;
|
|
15728
15305
|
/**
|
|
15729
15306
|
* Format: int64
|
|
15730
15307
|
* @description The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs.
|
|
@@ -15762,7 +15339,7 @@ export interface components {
|
|
|
15762
15339
|
* @description A predefined configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`.
|
|
15763
15340
|
* @enum {string}
|
|
15764
15341
|
*/
|
|
15765
|
-
projectTemplateKey?: "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban" | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum" | "com.pyxis.greenhopper.jira:gh-simplified-basic" | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic" | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic" | "com.pyxis.greenhopper.jira:gh-cross-team-template" | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template" | "com.atlassian.servicedesk:simplified-it-service-management" | "com.atlassian.servicedesk:simplified-it-service-management-basic" | "com.atlassian.servicedesk:simplified-it-service-management-operations" | "com.atlassian.servicedesk:simplified-
|
|
15342
|
+
projectTemplateKey?: "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban" | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum" | "com.pyxis.greenhopper.jira:gh-simplified-basic" | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic" | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic" | "com.pyxis.greenhopper.jira:gh-cross-team-template" | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template" | "com.atlassian.servicedesk:simplified-it-service-management" | "com.atlassian.servicedesk:simplified-it-service-management-basic" | "com.atlassian.servicedesk:simplified-it-service-management-operations" | "com.atlassian.servicedesk:simplified-internal-service-desk" | "com.atlassian.servicedesk:simplified-external-service-desk" | "com.atlassian.servicedesk:simplified-hr-service-desk" | "com.atlassian.servicedesk:simplified-facilities-service-desk" | "com.atlassian.servicedesk:simplified-legal-service-desk" | "com.atlassian.servicedesk:simplified-marketing-service-desk" | "com.atlassian.servicedesk:simplified-finance-service-desk" | "com.atlassian.servicedesk:simplified-analytics-service-desk" | "com.atlassian.servicedesk:simplified-design-service-desk" | "com.atlassian.servicedesk:simplified-sales-service-desk" | "com.atlassian.servicedesk:simplified-halp-service-desk" | "com.atlassian.servicedesk:next-gen-it-service-desk" | "com.atlassian.servicedesk:next-gen-hr-service-desk" | "com.atlassian.servicedesk:next-gen-legal-service-desk" | "com.atlassian.servicedesk:next-gen-marketing-service-desk" | "com.atlassian.servicedesk:next-gen-facilities-service-desk" | "com.atlassian.servicedesk:next-gen-general-service-desk" | "com.atlassian.servicedesk:next-gen-analytics-service-desk" | "com.atlassian.servicedesk:next-gen-finance-service-desk" | "com.atlassian.servicedesk:next-gen-design-service-desk" | "com.atlassian.servicedesk:next-gen-sales-service-desk" | "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval" | "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking" | "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control" | "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement" | "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment" | "com.atlassian.jira-core-project-templates:jira-core-simplified-task-" | "com.atlassian.jcs:customer-service-management";
|
|
15766
15343
|
/**
|
|
15767
15344
|
* @description The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.
|
|
15768
15345
|
* @enum {string}
|
|
@@ -15823,162 +15400,6 @@ export interface components {
|
|
|
15823
15400
|
/** @description The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role. */
|
|
15824
15401
|
name?: string;
|
|
15825
15402
|
};
|
|
15826
|
-
/** @description A workflow transition condition. */
|
|
15827
|
-
CreateWorkflowCondition: {
|
|
15828
|
-
/** @description The list of workflow conditions. */
|
|
15829
|
-
conditions?: components["schemas"]["CreateWorkflowCondition"][];
|
|
15830
|
-
/** @description EXPERIMENTAL. The configuration of the transition rule. */
|
|
15831
|
-
configuration?: {
|
|
15832
|
-
[key: string]: unknown;
|
|
15833
|
-
};
|
|
15834
|
-
/**
|
|
15835
|
-
* @description The compound condition operator.
|
|
15836
|
-
* @enum {string}
|
|
15837
|
-
*/
|
|
15838
|
-
operator?: "AND" | "OR";
|
|
15839
|
-
/** @description The type of the transition rule. */
|
|
15840
|
-
type?: string;
|
|
15841
|
-
};
|
|
15842
|
-
/** @description The details of a workflow. */
|
|
15843
|
-
CreateWorkflowDetails: {
|
|
15844
|
-
/** @description The description of the workflow. The maximum length is 1000 characters. */
|
|
15845
|
-
description?: string;
|
|
15846
|
-
/** @description The name of the workflow. The name must be unique. The maximum length is 255 characters. Characters can be separated by a whitespace but the name cannot start or end with a whitespace. */
|
|
15847
|
-
name: string;
|
|
15848
|
-
/** @description The statuses of the workflow. Any status that does not include a transition is added to the workflow without a transition. */
|
|
15849
|
-
statuses: components["schemas"]["CreateWorkflowStatusDetails"][];
|
|
15850
|
-
/**
|
|
15851
|
-
* @description The transitions of the workflow. For the request to be valid, these transitions must:
|
|
15852
|
-
*
|
|
15853
|
-
* * include one *initial* transition.
|
|
15854
|
-
* * not use the same name for a *global* and *directed* transition.
|
|
15855
|
-
* * have a unique name for each *global* transition.
|
|
15856
|
-
* * have a unique 'to' status for each *global* transition.
|
|
15857
|
-
* * have unique names for each transition from a status.
|
|
15858
|
-
* * not have a 'from' status on *initial* and *global* transitions.
|
|
15859
|
-
* * have a 'from' status on *directed* transitions.
|
|
15860
|
-
*
|
|
15861
|
-
* All the transition statuses must be included in `statuses`.
|
|
15862
|
-
*/
|
|
15863
|
-
transitions: components["schemas"]["CreateWorkflowTransitionDetails"][];
|
|
15864
|
-
};
|
|
15865
|
-
/** @description The details of a transition status. */
|
|
15866
|
-
CreateWorkflowStatusDetails: {
|
|
15867
|
-
/** @description The ID of the status. */
|
|
15868
|
-
id: string;
|
|
15869
|
-
/** @description The properties of the status. */
|
|
15870
|
-
properties?: {
|
|
15871
|
-
[key: string]: string;
|
|
15872
|
-
};
|
|
15873
|
-
};
|
|
15874
|
-
/** @description The details of a workflow transition. */
|
|
15875
|
-
CreateWorkflowTransitionDetails: {
|
|
15876
|
-
/** @description The description of the transition. The maximum length is 1000 characters. */
|
|
15877
|
-
description?: string;
|
|
15878
|
-
/** @description The statuses the transition can start from. */
|
|
15879
|
-
from?: string[];
|
|
15880
|
-
/** @description The name of the transition. The maximum length is 60 characters. */
|
|
15881
|
-
name: string;
|
|
15882
|
-
/** @description The properties of the transition. */
|
|
15883
|
-
properties?: {
|
|
15884
|
-
[key: string]: string;
|
|
15885
|
-
};
|
|
15886
|
-
/** @description The rules of the transition. */
|
|
15887
|
-
rules?: components["schemas"]["CreateWorkflowTransitionRulesDetails"];
|
|
15888
|
-
/** @description The screen of the transition. */
|
|
15889
|
-
screen?: components["schemas"]["CreateWorkflowTransitionScreenDetails"];
|
|
15890
|
-
/** @description The status the transition goes to. */
|
|
15891
|
-
to: string;
|
|
15892
|
-
/**
|
|
15893
|
-
* @description The type of the transition.
|
|
15894
|
-
* @enum {string}
|
|
15895
|
-
*/
|
|
15896
|
-
type: "global" | "initial" | "directed";
|
|
15897
|
-
};
|
|
15898
|
-
/** @description A workflow transition rule. */
|
|
15899
|
-
CreateWorkflowTransitionRule: {
|
|
15900
|
-
/** @description EXPERIMENTAL. The configuration of the transition rule. */
|
|
15901
|
-
configuration?: {
|
|
15902
|
-
[key: string]: unknown;
|
|
15903
|
-
};
|
|
15904
|
-
/** @description The type of the transition rule. */
|
|
15905
|
-
type: string;
|
|
15906
|
-
};
|
|
15907
|
-
/** @description The details of a workflow transition rules. */
|
|
15908
|
-
CreateWorkflowTransitionRulesDetails: {
|
|
15909
|
-
/** @description The workflow conditions. */
|
|
15910
|
-
conditions?: components["schemas"]["CreateWorkflowCondition"];
|
|
15911
|
-
/**
|
|
15912
|
-
* @description The workflow post functions.
|
|
15913
|
-
*
|
|
15914
|
-
* **Note:** The default post functions are always added to the *initial* transition, as in:
|
|
15915
|
-
*
|
|
15916
|
-
* "postFunctions": [
|
|
15917
|
-
* {
|
|
15918
|
-
* "type": "IssueCreateFunction"
|
|
15919
|
-
* },
|
|
15920
|
-
* {
|
|
15921
|
-
* "type": "IssueReindexFunction"
|
|
15922
|
-
* },
|
|
15923
|
-
* {
|
|
15924
|
-
* "type": "FireIssueEventFunction",
|
|
15925
|
-
* "configuration": {
|
|
15926
|
-
* "event": {
|
|
15927
|
-
* "id": "1",
|
|
15928
|
-
* "name": "issue_created"
|
|
15929
|
-
* }
|
|
15930
|
-
* }
|
|
15931
|
-
* }
|
|
15932
|
-
* ]
|
|
15933
|
-
*
|
|
15934
|
-
* **Note:** The default post functions are always added to the *global* and *directed* transitions, as in:
|
|
15935
|
-
*
|
|
15936
|
-
* "postFunctions": [
|
|
15937
|
-
* {
|
|
15938
|
-
* "type": "UpdateIssueStatusFunction"
|
|
15939
|
-
* },
|
|
15940
|
-
* {
|
|
15941
|
-
* "type": "CreateCommentFunction"
|
|
15942
|
-
* },
|
|
15943
|
-
* {
|
|
15944
|
-
* "type": "GenerateChangeHistoryFunction"
|
|
15945
|
-
* },
|
|
15946
|
-
* {
|
|
15947
|
-
* "type": "IssueReindexFunction"
|
|
15948
|
-
* },
|
|
15949
|
-
* {
|
|
15950
|
-
* "type": "FireIssueEventFunction",
|
|
15951
|
-
* "configuration": {
|
|
15952
|
-
* "event": {
|
|
15953
|
-
* "id": "13",
|
|
15954
|
-
* "name": "issue_generic"
|
|
15955
|
-
* }
|
|
15956
|
-
* }
|
|
15957
|
-
* }
|
|
15958
|
-
* ]
|
|
15959
|
-
*/
|
|
15960
|
-
postFunctions?: components["schemas"]["CreateWorkflowTransitionRule"][];
|
|
15961
|
-
/**
|
|
15962
|
-
* @description The workflow validators.
|
|
15963
|
-
*
|
|
15964
|
-
* **Note:** The default permission validator is always added to the *initial* transition, as in:
|
|
15965
|
-
*
|
|
15966
|
-
* "validators": [
|
|
15967
|
-
* {
|
|
15968
|
-
* "type": "PermissionValidator",
|
|
15969
|
-
* "configuration": {
|
|
15970
|
-
* "permissionKey": "CREATE_ISSUES"
|
|
15971
|
-
* }
|
|
15972
|
-
* }
|
|
15973
|
-
* ]
|
|
15974
|
-
*/
|
|
15975
|
-
validators?: components["schemas"]["CreateWorkflowTransitionRule"][];
|
|
15976
|
-
};
|
|
15977
|
-
/** @description The details of a transition screen. */
|
|
15978
|
-
CreateWorkflowTransitionScreenDetails: {
|
|
15979
|
-
/** @description The ID of the screen. */
|
|
15980
|
-
id: string;
|
|
15981
|
-
};
|
|
15982
15403
|
/** @description Details about a created issue or subtask. */
|
|
15983
15404
|
CreatedIssue: {
|
|
15984
15405
|
/** @description The ID of the created issue or subtask. */
|
|
@@ -16038,6 +15459,8 @@ export interface components {
|
|
|
16038
15459
|
};
|
|
16039
15460
|
/** @description The default value for a Date custom field. */
|
|
16040
15461
|
CustomFieldContextDefaultValueDate: {
|
|
15462
|
+
/** @description The ID of the context. */
|
|
15463
|
+
contextId: string;
|
|
16041
15464
|
/** @description The default date in ISO format. Ignored if `useCurrent` is true. */
|
|
16042
15465
|
date?: string;
|
|
16043
15466
|
/**
|
|
@@ -16053,6 +15476,8 @@ export interface components {
|
|
|
16053
15476
|
};
|
|
16054
15477
|
/** @description The default value for a date time custom field. */
|
|
16055
15478
|
CustomFieldContextDefaultValueDateTime: {
|
|
15479
|
+
/** @description The ID of the context. */
|
|
15480
|
+
contextId: string;
|
|
16056
15481
|
/** @description The default date-time in ISO format. Ignored if `useCurrent` is true. */
|
|
16057
15482
|
dateTime?: string;
|
|
16058
15483
|
/**
|
|
@@ -16068,6 +15493,8 @@ export interface components {
|
|
|
16068
15493
|
};
|
|
16069
15494
|
/** @description Default value for a float (number) custom field. */
|
|
16070
15495
|
CustomFieldContextDefaultValueFloat: {
|
|
15496
|
+
/** @description The ID of the context. */
|
|
15497
|
+
contextId: string;
|
|
16071
15498
|
/**
|
|
16072
15499
|
* Format: double
|
|
16073
15500
|
* @description The default floating-point number.
|
|
@@ -16122,6 +15549,8 @@ export interface components {
|
|
|
16122
15549
|
};
|
|
16123
15550
|
/** @description The default text for a Forge collection of strings custom field. */
|
|
16124
15551
|
CustomFieldContextDefaultValueForgeMultiStringField: {
|
|
15552
|
+
/** @description The ID of the context. */
|
|
15553
|
+
contextId: string;
|
|
16125
15554
|
/**
|
|
16126
15555
|
* @description discriminator enum property added by openapi-typescript
|
|
16127
15556
|
* @enum {string}
|
|
@@ -16159,6 +15588,8 @@ export interface components {
|
|
|
16159
15588
|
};
|
|
16160
15589
|
/** @description The default value for a Forge object custom field. */
|
|
16161
15590
|
CustomFieldContextDefaultValueForgeObjectField: {
|
|
15591
|
+
/** @description The ID of the context. */
|
|
15592
|
+
contextId: string;
|
|
16162
15593
|
/** @description The default JSON object. */
|
|
16163
15594
|
object?: Record<string, never>;
|
|
16164
15595
|
/**
|
|
@@ -16194,6 +15625,8 @@ export interface components {
|
|
|
16194
15625
|
};
|
|
16195
15626
|
/** @description Default value for a labels custom field. */
|
|
16196
15627
|
CustomFieldContextDefaultValueLabels: {
|
|
15628
|
+
/** @description The ID of the context. */
|
|
15629
|
+
contextId: string;
|
|
16197
15630
|
/** @description The default labels value. */
|
|
16198
15631
|
labels: string[];
|
|
16199
15632
|
/**
|
|
@@ -16240,6 +15673,8 @@ export interface components {
|
|
|
16240
15673
|
};
|
|
16241
15674
|
/** @description The default value for a multiple version picker custom field. */
|
|
16242
15675
|
CustomFieldContextDefaultValueMultipleVersionPicker: {
|
|
15676
|
+
/** @description The ID of the context. */
|
|
15677
|
+
contextId: string;
|
|
16243
15678
|
/**
|
|
16244
15679
|
* @description discriminator enum property added by openapi-typescript
|
|
16245
15680
|
* @enum {string}
|
|
@@ -16264,6 +15699,8 @@ export interface components {
|
|
|
16264
15699
|
};
|
|
16265
15700
|
/** @description The default text for a read only custom field. */
|
|
16266
15701
|
CustomFieldContextDefaultValueReadOnly: {
|
|
15702
|
+
/** @description The ID of the context. */
|
|
15703
|
+
contextId: string;
|
|
16267
15704
|
/** @description The default text. The maximum length is 255 characters. */
|
|
16268
15705
|
text?: string;
|
|
16269
15706
|
/**
|
|
@@ -16298,6 +15735,8 @@ export interface components {
|
|
|
16298
15735
|
};
|
|
16299
15736
|
/** @description The default value for a version picker custom field. */
|
|
16300
15737
|
CustomFieldContextDefaultValueSingleVersionPicker: {
|
|
15738
|
+
/** @description The ID of the context. */
|
|
15739
|
+
contextId: string;
|
|
16301
15740
|
/**
|
|
16302
15741
|
* @description discriminator enum property added by openapi-typescript
|
|
16303
15742
|
* @enum {string}
|
|
@@ -16310,6 +15749,8 @@ export interface components {
|
|
|
16310
15749
|
};
|
|
16311
15750
|
/** @description The default text for a text area custom field. */
|
|
16312
15751
|
CustomFieldContextDefaultValueTextArea: {
|
|
15752
|
+
/** @description The ID of the context. */
|
|
15753
|
+
contextId: string;
|
|
16313
15754
|
/** @description The default text. The maximum length is 32767 characters. */
|
|
16314
15755
|
text?: string;
|
|
16315
15756
|
/**
|
|
@@ -16320,6 +15761,8 @@ export interface components {
|
|
|
16320
15761
|
};
|
|
16321
15762
|
/** @description The default text for a text custom field. */
|
|
16322
15763
|
CustomFieldContextDefaultValueTextField: {
|
|
15764
|
+
/** @description The ID of the context. */
|
|
15765
|
+
contextId: string;
|
|
16323
15766
|
/** @description The default text. The maximum length is 254 characters. */
|
|
16324
15767
|
text?: string;
|
|
16325
15768
|
/**
|
|
@@ -16563,6 +16006,7 @@ export interface components {
|
|
|
16563
16006
|
};
|
|
16564
16007
|
/** @description The specific request object for creating a project with template. */
|
|
16565
16008
|
CustomTemplateRequestDTO: {
|
|
16009
|
+
boardFeatures?: components["schemas"]["BoardFeaturesPayload"];
|
|
16566
16010
|
boards?: components["schemas"]["BoardsPayload"];
|
|
16567
16011
|
field?: components["schemas"]["FieldCapabilityPayload"];
|
|
16568
16012
|
issueType?: components["schemas"]["IssueTypeProjectCreatePayload"];
|
|
@@ -16763,6 +16207,8 @@ export interface components {
|
|
|
16763
16207
|
description?: string;
|
|
16764
16208
|
/** @description The guideline of the data classification object. */
|
|
16765
16209
|
guideline?: string;
|
|
16210
|
+
/** @description The guideline in ADF (Atlassian Document Format) for rich text rendering. */
|
|
16211
|
+
guidelineADF?: string;
|
|
16766
16212
|
/** @description The ID of the data classification object. */
|
|
16767
16213
|
id: string;
|
|
16768
16214
|
/** @description The name of the data classification object. */
|
|
@@ -16833,27 +16279,6 @@ export interface components {
|
|
|
16833
16279
|
deleted?: boolean;
|
|
16834
16280
|
id?: string;
|
|
16835
16281
|
};
|
|
16836
|
-
/** @description Details about a workflow. */
|
|
16837
|
-
DeprecatedWorkflow: {
|
|
16838
|
-
default?: boolean;
|
|
16839
|
-
/** @description The description of the workflow. */
|
|
16840
|
-
readonly description?: string;
|
|
16841
|
-
/** @description The datetime the workflow was last modified. */
|
|
16842
|
-
readonly lastModifiedDate?: string;
|
|
16843
|
-
/** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
|
|
16844
|
-
readonly lastModifiedUser?: string;
|
|
16845
|
-
/** @description The account ID of the user that last modified the workflow. */
|
|
16846
|
-
readonly lastModifiedUserAccountId?: string;
|
|
16847
|
-
/** @description The name of the workflow. */
|
|
16848
|
-
readonly name?: string;
|
|
16849
|
-
/** @description The scope where this workflow applies */
|
|
16850
|
-
readonly scope?: components["schemas"]["Scope"];
|
|
16851
|
-
/**
|
|
16852
|
-
* Format: int32
|
|
16853
|
-
* @description The number of steps included in the workflow.
|
|
16854
|
-
*/
|
|
16855
|
-
readonly steps?: number;
|
|
16856
|
-
};
|
|
16857
16282
|
DetailedErrorCollection: {
|
|
16858
16283
|
/** @description Map of objects representing additional details for an error */
|
|
16859
16284
|
details?: {
|
|
@@ -17084,9 +16509,28 @@ export interface components {
|
|
|
17084
16509
|
/** @description The display name of the field type */
|
|
17085
16510
|
typeDisplayName?: string;
|
|
17086
16511
|
};
|
|
16512
|
+
/** @description Defines the payload for the field association scheme. */
|
|
16513
|
+
FieldAssociationItemPayload: {
|
|
16514
|
+
/**
|
|
16515
|
+
* @description The description of the field association item
|
|
16516
|
+
* @example The description of the field association item
|
|
16517
|
+
*/
|
|
16518
|
+
description?: string;
|
|
16519
|
+
pcri?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
16520
|
+
qualifierId?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
16521
|
+
qualifierType?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
16522
|
+
/**
|
|
16523
|
+
* @description The renderer type of the field
|
|
16524
|
+
* @example jira-text-renderer
|
|
16525
|
+
*/
|
|
16526
|
+
rendererType?: string;
|
|
16527
|
+
/** @description Whether the field is required */
|
|
16528
|
+
required?: boolean;
|
|
16529
|
+
};
|
|
17087
16530
|
FieldAssociationParameters: {
|
|
17088
16531
|
description?: string;
|
|
17089
16532
|
isRequired: boolean;
|
|
16533
|
+
rendererType?: string;
|
|
17090
16534
|
};
|
|
17091
16535
|
/** @description Field association scheme field search results. */
|
|
17092
16536
|
FieldAssociationSchemeFieldSearchResult: {
|
|
@@ -17111,7 +16555,12 @@ export interface components {
|
|
|
17111
16555
|
};
|
|
17112
16556
|
/** @description Project search results for field association scheme. */
|
|
17113
16557
|
FieldAssociationSchemeProjectSearchResult: {
|
|
16558
|
+
avatarUrls?: {
|
|
16559
|
+
[key: string]: string;
|
|
16560
|
+
};
|
|
16561
|
+
deleted?: boolean;
|
|
17114
16562
|
id?: string;
|
|
16563
|
+
key?: string;
|
|
17115
16564
|
name?: string;
|
|
17116
16565
|
};
|
|
17117
16566
|
/** @description Details of field associations with projects. */
|
|
@@ -17126,8 +16575,12 @@ export interface components {
|
|
|
17126
16575
|
/** @description The custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/\#api-rest-api-3-field-post */
|
|
17127
16576
|
customFieldDefinitions?: components["schemas"]["CustomFieldPayload"][] | null;
|
|
17128
16577
|
fieldLayoutScheme?: components["schemas"]["FieldLayoutSchemePayload"];
|
|
17129
|
-
/**
|
|
16578
|
+
/**
|
|
16579
|
+
* @deprecated
|
|
16580
|
+
* @description The field layouts configuration.
|
|
16581
|
+
*/
|
|
17130
16582
|
fieldLayouts?: components["schemas"]["FieldLayoutPayload"][] | null;
|
|
16583
|
+
fieldScheme?: components["schemas"]["FieldSchemePayload"];
|
|
17131
16584
|
/** @description The issue layouts configuration */
|
|
17132
16585
|
issueLayouts?: components["schemas"]["IssueLayoutPayload"][] | null;
|
|
17133
16586
|
issueTypeScreenScheme?: components["schemas"]["IssueTypeScreenSchemePayload"];
|
|
@@ -17309,7 +16762,10 @@ export interface components {
|
|
|
17309
16762
|
/** @description Whether the field is required */
|
|
17310
16763
|
required?: boolean;
|
|
17311
16764
|
};
|
|
17312
|
-
/**
|
|
16765
|
+
/**
|
|
16766
|
+
* @deprecated
|
|
16767
|
+
* @description Defines the payload for the field layouts. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-group-issue-field-configurations" + fieldlayout is what users would see as "Field Configuration" in Jira's UI - https://support.atlassian.com/jira-cloud-administration/docs/manage-issue-field-configurations/
|
|
16768
|
+
*/
|
|
17313
16769
|
FieldLayoutPayload: {
|
|
17314
16770
|
/** @description The field layout configuration. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfiguration-post */
|
|
17315
16771
|
configuration?: components["schemas"]["FieldLayoutConfiguration"][];
|
|
@@ -17325,7 +16781,12 @@ export interface components {
|
|
|
17325
16781
|
name?: string;
|
|
17326
16782
|
pcri?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
17327
16783
|
} | null;
|
|
17328
|
-
/**
|
|
16784
|
+
/**
|
|
16785
|
+
* @deprecated
|
|
16786
|
+
* @description Deprecated use [fieldAssociationScheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) instead Defines the payload for the field layout schemes. See [ Field configuration scheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfigurationscheme-post).
|
|
16787
|
+
*
|
|
16788
|
+
* [ How to configure a field configuration scheme](https://support.atlassian.com/jira-cloud-administration/docs/configure-a-field-configuration-scheme/).
|
|
16789
|
+
*/
|
|
17329
16790
|
FieldLayoutSchemePayload: {
|
|
17330
16791
|
defaultFieldLayout?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
17331
16792
|
/**
|
|
@@ -17369,6 +16830,10 @@ export interface components {
|
|
|
17369
16830
|
/** @description The data type of the field. */
|
|
17370
16831
|
readonly schema: components["schemas"]["JsonTypeBean"];
|
|
17371
16832
|
};
|
|
16833
|
+
/** @description List of project associations. */
|
|
16834
|
+
FieldProjectAssociation: {
|
|
16835
|
+
projectId?: string;
|
|
16836
|
+
};
|
|
17372
16837
|
/** @description Details of a field that can be used in advanced searches. */
|
|
17373
16838
|
FieldReferenceData: {
|
|
17374
16839
|
/**
|
|
@@ -17410,6 +16875,27 @@ export interface components {
|
|
|
17410
16875
|
/** @description The field identifier. */
|
|
17411
16876
|
value?: string;
|
|
17412
16877
|
};
|
|
16878
|
+
/** @description Defines the payload to configure the field scheme for a project. See [Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes). */
|
|
16879
|
+
FieldSchemePayload: {
|
|
16880
|
+
/**
|
|
16881
|
+
* @description The description of the field scheme
|
|
16882
|
+
* @example This is a field scheme
|
|
16883
|
+
*/
|
|
16884
|
+
description?: string;
|
|
16885
|
+
/** @description The field association items for this field scheme. */
|
|
16886
|
+
items?: components["schemas"]["FieldAssociationItemPayload"][];
|
|
16887
|
+
/**
|
|
16888
|
+
* @description The name of the field scheme
|
|
16889
|
+
* @example My Field Scheme
|
|
16890
|
+
*/
|
|
16891
|
+
name?: string;
|
|
16892
|
+
/**
|
|
16893
|
+
* @description The strategy to use when there is a conflict with an existing field scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters
|
|
16894
|
+
* @enum {string}
|
|
16895
|
+
*/
|
|
16896
|
+
onConflict?: "FAIL" | "USE" | "NEW";
|
|
16897
|
+
pcri?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
16898
|
+
} | null;
|
|
17413
16899
|
/** @description Partial failure result when updating field scheme to fields associations. */
|
|
17414
16900
|
FieldSchemeToFieldsPartialFailure: {
|
|
17415
16901
|
error?: string;
|
|
@@ -17525,6 +17011,11 @@ export interface components {
|
|
|
17525
17011
|
description?: string;
|
|
17526
17012
|
/** @description Whether the field is required, null to preserve current requirement setting */
|
|
17527
17013
|
isRequired?: boolean;
|
|
17014
|
+
/**
|
|
17015
|
+
* @description The renderer type for the field, null to preserve current renderer type
|
|
17016
|
+
* @enum {string}
|
|
17017
|
+
*/
|
|
17018
|
+
rendererType?: "jira-text-renderer" | "atlassian-wiki-renderer";
|
|
17528
17019
|
};
|
|
17529
17020
|
/** @description The list of work type-specific parameter overrides, may be empty if only default parameters are being updated */
|
|
17530
17021
|
FieldsSchemeItemWorkTypeParameter: {
|
|
@@ -17532,6 +17023,11 @@ export interface components {
|
|
|
17532
17023
|
description?: string;
|
|
17533
17024
|
/** @description Whether the field is required for this work type, null to use default or preserve current */
|
|
17534
17025
|
isRequired?: boolean;
|
|
17026
|
+
/**
|
|
17027
|
+
* @description The renderer type for the field for this work type, null to use default or preserve current
|
|
17028
|
+
* @enum {string}
|
|
17029
|
+
*/
|
|
17030
|
+
rendererType?: "jira-text-renderer" | "atlassian-wiki-renderer";
|
|
17535
17031
|
/**
|
|
17536
17032
|
* Format: int64
|
|
17537
17033
|
* @description The ID of the work type (issue type) for which these parameters apply
|
|
@@ -17671,6 +17167,15 @@ export interface components {
|
|
|
17671
17167
|
*/
|
|
17672
17168
|
readonly "start-index"?: number;
|
|
17673
17169
|
};
|
|
17170
|
+
ForgePanelProjectPinAsyncResponse: {
|
|
17171
|
+
taskId?: string;
|
|
17172
|
+
};
|
|
17173
|
+
ForgePanelProjectPinRequest: {
|
|
17174
|
+
/** @description The moduleId of the Forge panel in the format `ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key}` */
|
|
17175
|
+
moduleId: string;
|
|
17176
|
+
/** @description The list of projects to pin or unpin the issue panel to or from. */
|
|
17177
|
+
projectList: components["schemas"]["ProjectPinAction"][];
|
|
17178
|
+
};
|
|
17674
17179
|
/** @description A group found in a search. */
|
|
17675
17180
|
FoundGroup: {
|
|
17676
17181
|
/** @description Avatar url for the group/team if present. */
|
|
@@ -17846,6 +17351,8 @@ export interface components {
|
|
|
17846
17351
|
/** @description Response object for getting a field association scheme by ID. */
|
|
17847
17352
|
GetFieldAssociationSchemeByIdResponse: {
|
|
17848
17353
|
description?: string;
|
|
17354
|
+
/** Format: int64 */
|
|
17355
|
+
fieldsCount?: number;
|
|
17849
17356
|
id?: string;
|
|
17850
17357
|
isDefault?: boolean;
|
|
17851
17358
|
links?: components["schemas"]["FieldAssociationSchemeLinks"];
|
|
@@ -17855,6 +17362,8 @@ export interface components {
|
|
|
17855
17362
|
GetFieldAssociationSchemeResponse: {
|
|
17856
17363
|
description?: string;
|
|
17857
17364
|
/** Format: int64 */
|
|
17365
|
+
fieldsCount?: number;
|
|
17366
|
+
/** Format: int64 */
|
|
17858
17367
|
id?: number;
|
|
17859
17368
|
isDefault?: boolean;
|
|
17860
17369
|
links?: components["schemas"]["FieldAssociationSchemeLinksBean"];
|
|
@@ -18474,6 +17983,10 @@ export interface components {
|
|
|
18474
17983
|
/** @description Defines the payload to configure the issue layout item for a project. */
|
|
18475
17984
|
IssueLayoutItemPayload: {
|
|
18476
17985
|
itemKey?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
17986
|
+
/** @description Additional properties for this item. This field is only used when the type is FIELD. */
|
|
17987
|
+
properties?: {
|
|
17988
|
+
[key: string]: unknown;
|
|
17989
|
+
};
|
|
18477
17990
|
/**
|
|
18478
17991
|
* @description The item section type
|
|
18479
17992
|
* @enum {string}
|
|
@@ -18693,6 +18206,14 @@ export interface components {
|
|
|
18693
18206
|
*/
|
|
18694
18207
|
type?: "subtask" | "standard";
|
|
18695
18208
|
};
|
|
18209
|
+
/** @description A default value associated with an issue type within a context. */
|
|
18210
|
+
IssueTypeDefaultValue: {
|
|
18211
|
+
/** @description True when this default value applies to every issue type covered by the context (no specific issue type). Only present when true; omitted otherwise. */
|
|
18212
|
+
isAnyIssueType?: boolean | null;
|
|
18213
|
+
/** @description The ID of the issue type this default value applies to. Null when isAnyIssueType is true. */
|
|
18214
|
+
issueTypeId?: string | null;
|
|
18215
|
+
value?: components["schemas"]["CustomFieldContextDefaultValue"];
|
|
18216
|
+
};
|
|
18696
18217
|
/** @description Details about an issue type. */
|
|
18697
18218
|
IssueTypeDetails: {
|
|
18698
18219
|
/**
|
|
@@ -20119,12 +19640,10 @@ export interface components {
|
|
|
20119
19640
|
/** @description Value for each field. Accepts Atlassian Document Format (ADF) for rich text fields like `description`, `environments`. For ADF format details, refer to: [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure) */
|
|
20120
19641
|
value: Record<string, never>;
|
|
20121
19642
|
};
|
|
20122
|
-
/** @description
|
|
19643
|
+
/** @description The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses in the current project's workflows would no longer exist in the target workflow scheme. Each mapping defines how to update issues from an old status to the corresponding new status in the issue’s new workflow. */
|
|
20123
19644
|
MappingsByIssueTypeOverride: {
|
|
20124
|
-
|
|
20125
|
-
|
|
20126
|
-
/** @description The list of status mappings. */
|
|
20127
|
-
statusMappings: components["schemas"]["WorkflowAssociationStatusMapping"][];
|
|
19645
|
+
issueTypeId?: string;
|
|
19646
|
+
statusMappings?: components["schemas"]["WorkflowAssociationStatusMapping"][];
|
|
20128
19647
|
};
|
|
20129
19648
|
/** @description The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`. */
|
|
20130
19649
|
MappingsByWorkflow: {
|
|
@@ -20864,6 +20383,38 @@ export interface components {
|
|
|
20864
20383
|
readonly values?: components["schemas"]["Context"][];
|
|
20865
20384
|
};
|
|
20866
20385
|
/** @description A page of items. */
|
|
20386
|
+
PageBeanContextDefaultValues: {
|
|
20387
|
+
/** @description Whether this is the last page. */
|
|
20388
|
+
readonly isLast?: boolean;
|
|
20389
|
+
/**
|
|
20390
|
+
* Format: int32
|
|
20391
|
+
* @description The maximum number of items that could be returned.
|
|
20392
|
+
*/
|
|
20393
|
+
readonly maxResults?: number;
|
|
20394
|
+
/**
|
|
20395
|
+
* Format: uri
|
|
20396
|
+
* @description If there is another page of results, the URL of the next page.
|
|
20397
|
+
*/
|
|
20398
|
+
readonly nextPage?: string;
|
|
20399
|
+
/**
|
|
20400
|
+
* Format: uri
|
|
20401
|
+
* @description The URL of the page.
|
|
20402
|
+
*/
|
|
20403
|
+
readonly self?: string;
|
|
20404
|
+
/**
|
|
20405
|
+
* Format: int64
|
|
20406
|
+
* @description The index of the first item returned.
|
|
20407
|
+
*/
|
|
20408
|
+
readonly startAt?: number;
|
|
20409
|
+
/**
|
|
20410
|
+
* Format: int64
|
|
20411
|
+
* @description The number of items returned.
|
|
20412
|
+
*/
|
|
20413
|
+
readonly total?: number;
|
|
20414
|
+
/** @description The list of items. */
|
|
20415
|
+
readonly values?: components["schemas"]["ContextDefaultValues"][];
|
|
20416
|
+
};
|
|
20417
|
+
/** @description A page of items. */
|
|
20867
20418
|
PageBeanContextForProjectAndIssueType: {
|
|
20868
20419
|
/** @description Whether this is the last page. */
|
|
20869
20420
|
readonly isLast?: boolean;
|
|
@@ -21280,6 +20831,38 @@ export interface components {
|
|
|
21280
20831
|
readonly values?: components["schemas"]["FieldConfigurationSchemeProjects"][];
|
|
21281
20832
|
};
|
|
21282
20833
|
/** @description A page of items. */
|
|
20834
|
+
PageBeanFieldProjectAssociation: {
|
|
20835
|
+
/** @description Whether this is the last page. */
|
|
20836
|
+
readonly isLast?: boolean;
|
|
20837
|
+
/**
|
|
20838
|
+
* Format: int32
|
|
20839
|
+
* @description The maximum number of items that could be returned.
|
|
20840
|
+
*/
|
|
20841
|
+
readonly maxResults?: number;
|
|
20842
|
+
/**
|
|
20843
|
+
* Format: uri
|
|
20844
|
+
* @description If there is another page of results, the URL of the next page.
|
|
20845
|
+
*/
|
|
20846
|
+
readonly nextPage?: string;
|
|
20847
|
+
/**
|
|
20848
|
+
* Format: uri
|
|
20849
|
+
* @description The URL of the page.
|
|
20850
|
+
*/
|
|
20851
|
+
readonly self?: string;
|
|
20852
|
+
/**
|
|
20853
|
+
* Format: int64
|
|
20854
|
+
* @description The index of the first item returned.
|
|
20855
|
+
*/
|
|
20856
|
+
readonly startAt?: number;
|
|
20857
|
+
/**
|
|
20858
|
+
* Format: int64
|
|
20859
|
+
* @description The number of items returned.
|
|
20860
|
+
*/
|
|
20861
|
+
readonly total?: number;
|
|
20862
|
+
/** @description The list of items. */
|
|
20863
|
+
readonly values?: components["schemas"]["FieldProjectAssociation"][];
|
|
20864
|
+
};
|
|
20865
|
+
/** @description A page of items. */
|
|
21283
20866
|
PageBeanFilterDetails: {
|
|
21284
20867
|
/** @description Whether this is the last page. */
|
|
21285
20868
|
readonly isLast?: boolean;
|
|
@@ -23398,6 +22981,16 @@ export interface components {
|
|
|
23398
22981
|
/** @description Whether the logged user can edit the project. */
|
|
23399
22982
|
readonly canEdit?: boolean;
|
|
23400
22983
|
};
|
|
22984
|
+
/** @description The list of projects to pin or unpin the issue panel to or from. */
|
|
22985
|
+
ProjectPinAction: {
|
|
22986
|
+
/**
|
|
22987
|
+
* @description The action to perform: PIN or UNPIN.
|
|
22988
|
+
* @enum {string}
|
|
22989
|
+
*/
|
|
22990
|
+
action: "PIN" | "UNPIN";
|
|
22991
|
+
/** @description The project ID or key. */
|
|
22992
|
+
projectIdOrKey: string;
|
|
22993
|
+
};
|
|
23401
22994
|
/** @description Details about the roles in a project. */
|
|
23402
22995
|
ProjectRole: {
|
|
23403
22996
|
/** @description The list of users who act in this role. */
|
|
@@ -23477,6 +23070,11 @@ export interface components {
|
|
|
23477
23070
|
readonly self?: string;
|
|
23478
23071
|
/** @description The translated name of the project role. */
|
|
23479
23072
|
translatedName?: string;
|
|
23073
|
+
/**
|
|
23074
|
+
* @description The type of the project role. This is "DEFAULT" or "GUEST\_ROLE".
|
|
23075
|
+
* @enum {string}
|
|
23076
|
+
*/
|
|
23077
|
+
readonly type?: "DEFAULT" | "GUEST_ROLE";
|
|
23480
23078
|
};
|
|
23481
23079
|
/** @description Details of the group associated with the role. */
|
|
23482
23080
|
ProjectRoleGroup: {
|
|
@@ -23780,6 +23378,7 @@ export interface components {
|
|
|
23780
23378
|
self?: string;
|
|
23781
23379
|
};
|
|
23782
23380
|
Resource: {
|
|
23381
|
+
contentAsByteArray?: string[];
|
|
23783
23382
|
description?: string;
|
|
23784
23383
|
/** Format: binary */
|
|
23785
23384
|
file?: string;
|
|
@@ -23854,7 +23453,7 @@ export interface components {
|
|
|
23854
23453
|
* @example EDITABLE
|
|
23855
23454
|
* @enum {string}
|
|
23856
23455
|
*/
|
|
23857
|
-
type?: "HIDDEN" | "VIEWABLE" | "EDITABLE";
|
|
23456
|
+
type?: "HIDDEN" | "VIEWABLE" | "EDITABLE" | "GUEST";
|
|
23858
23457
|
};
|
|
23859
23458
|
RolesCapabilityPayload: {
|
|
23860
23459
|
/** @description A map of role PCRI (can be ID or REF) to a list of user or group PCRI IDs to associate with the role and project. */
|
|
@@ -24170,6 +23769,8 @@ export interface components {
|
|
|
24170
23769
|
readonly schema?: {
|
|
24171
23770
|
[key: string]: components["schemas"]["JsonTypeBean"];
|
|
24172
23771
|
};
|
|
23772
|
+
/** @description Experimental. Warnings generated during the search, e.g. when a JQL clause exceeded its argument limit or when the result set was truncated due to an ingestion limit. This field is currently rolling out behind a feature flag and may be absent, empty, or change shape without notice until generally available. */
|
|
23773
|
+
readonly warnings?: components["schemas"]["SearchWarning"][];
|
|
24173
23774
|
};
|
|
24174
23775
|
/** @description Details of how to filter and list search auto complete information. */
|
|
24175
23776
|
SearchAutoCompleteFilter: {
|
|
@@ -24251,10 +23852,12 @@ export interface components {
|
|
|
24251
23852
|
SearchResultFieldParameters: {
|
|
24252
23853
|
description?: string;
|
|
24253
23854
|
isRequired?: boolean;
|
|
23855
|
+
rendererType?: string;
|
|
24254
23856
|
};
|
|
24255
23857
|
SearchResultWorkTypeParameters: {
|
|
24256
23858
|
description?: string;
|
|
24257
23859
|
isRequired?: boolean;
|
|
23860
|
+
rendererType?: string;
|
|
24258
23861
|
workTypeId?: string;
|
|
24259
23862
|
};
|
|
24260
23863
|
/** @description The result of a JQL search. */
|
|
@@ -24289,6 +23892,32 @@ export interface components {
|
|
|
24289
23892
|
/** @description Any warnings related to the JQL query. */
|
|
24290
23893
|
readonly warningMessages?: string[];
|
|
24291
23894
|
};
|
|
23895
|
+
/** @description Experimental. A warning returned alongside successful search results. */
|
|
23896
|
+
SearchWarning: {
|
|
23897
|
+
/** @description Structured details about the warning, if available. */
|
|
23898
|
+
details?: components["schemas"]["SearchWarningLimitDetails"];
|
|
23899
|
+
/** @description A human-readable explanation of the warning suitable for surfacing to end users. */
|
|
23900
|
+
readonly message?: string;
|
|
23901
|
+
/** @description The type of warning, e.g. CLAUSE\_LIMIT\_EXCEEDED. */
|
|
23902
|
+
readonly type?: string;
|
|
23903
|
+
};
|
|
23904
|
+
/** @description Experimental. Structured details about a JQL clause exceeding its argument limit. */
|
|
23905
|
+
SearchWarningLimitDetails: {
|
|
23906
|
+
/**
|
|
23907
|
+
* Format: int64
|
|
23908
|
+
* @description The actual number of arguments supplied that exceeded the limit.
|
|
23909
|
+
*/
|
|
23910
|
+
readonly actual?: number;
|
|
23911
|
+
/** @description The arguments passed to the JQL clause. */
|
|
23912
|
+
readonly arguments?: string;
|
|
23913
|
+
/** @description The JQL clause that triggered the limit, e.g. issueHistory(). */
|
|
23914
|
+
readonly clause?: string;
|
|
23915
|
+
/**
|
|
23916
|
+
* Format: int64
|
|
23917
|
+
* @description The maximum number of arguments allowed for the clause.
|
|
23918
|
+
*/
|
|
23919
|
+
readonly limit?: number;
|
|
23920
|
+
};
|
|
24292
23921
|
/** @description Details of an issue level security item. */
|
|
24293
23922
|
SecurityLevel: {
|
|
24294
23923
|
/** @description The description of the issue level security item. */
|
|
@@ -24345,6 +23974,7 @@ export interface components {
|
|
|
24345
23974
|
* @example New Security Level
|
|
24346
23975
|
*/
|
|
24347
23976
|
name?: string;
|
|
23977
|
+
pcri?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
24348
23978
|
/** @description The members of the security level */
|
|
24349
23979
|
securityLevelMembers?: components["schemas"]["SecurityLevelMemberPayload"][];
|
|
24350
23980
|
};
|
|
@@ -25058,6 +24688,62 @@ export interface components {
|
|
|
25058
24688
|
name?: string;
|
|
25059
24689
|
};
|
|
25060
24690
|
/** @description Details about a task. */
|
|
24691
|
+
TaskProgress: {
|
|
24692
|
+
/** @description The description of the task. */
|
|
24693
|
+
description?: string;
|
|
24694
|
+
/**
|
|
24695
|
+
* Format: int64
|
|
24696
|
+
* @description The execution time of the task, in milliseconds.
|
|
24697
|
+
*/
|
|
24698
|
+
elapsedRuntime: number;
|
|
24699
|
+
/**
|
|
24700
|
+
* Format: date-time
|
|
24701
|
+
* @description A timestamp recording when the task was finished.
|
|
24702
|
+
*/
|
|
24703
|
+
finished?: string;
|
|
24704
|
+
/** @description The ID of the task. */
|
|
24705
|
+
id: string;
|
|
24706
|
+
/**
|
|
24707
|
+
* Format: date-time
|
|
24708
|
+
* @description A timestamp recording when the task progress was last updated.
|
|
24709
|
+
*/
|
|
24710
|
+
lastUpdate: string;
|
|
24711
|
+
/** @description Information about the progress of the task. */
|
|
24712
|
+
message?: string;
|
|
24713
|
+
/**
|
|
24714
|
+
* Format: int64
|
|
24715
|
+
* @description The progress of the task, as a percentage complete.
|
|
24716
|
+
*/
|
|
24717
|
+
progress: number;
|
|
24718
|
+
/** @description The result of the task execution. */
|
|
24719
|
+
result?: unknown;
|
|
24720
|
+
/**
|
|
24721
|
+
* Format: uri
|
|
24722
|
+
* @description The URL of the task.
|
|
24723
|
+
*/
|
|
24724
|
+
self: string;
|
|
24725
|
+
/**
|
|
24726
|
+
* Format: date-time
|
|
24727
|
+
* @description A timestamp recording when the task was started.
|
|
24728
|
+
*/
|
|
24729
|
+
started?: string;
|
|
24730
|
+
/**
|
|
24731
|
+
* @description The status of the task.
|
|
24732
|
+
* @enum {string}
|
|
24733
|
+
*/
|
|
24734
|
+
status: "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD";
|
|
24735
|
+
/**
|
|
24736
|
+
* Format: date-time
|
|
24737
|
+
* @description A timestamp recording when the task was submitted.
|
|
24738
|
+
*/
|
|
24739
|
+
submitted?: string;
|
|
24740
|
+
/**
|
|
24741
|
+
* Format: int64
|
|
24742
|
+
* @description The ID of the user who submitted the task.
|
|
24743
|
+
*/
|
|
24744
|
+
submittedBy: number;
|
|
24745
|
+
};
|
|
24746
|
+
/** @description Details about a task. */
|
|
25061
24747
|
TaskProgressBeanJsonNode: {
|
|
25062
24748
|
/** @description The description of the task. */
|
|
25063
24749
|
description?: string;
|
|
@@ -25448,13 +25134,27 @@ export interface components {
|
|
|
25448
25134
|
readonly isAvailable?: boolean;
|
|
25449
25135
|
/** @description The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard. */
|
|
25450
25136
|
issueTypeId?: string;
|
|
25137
|
+
/** @description The portal ID of the context. Only required for Jira Service Management request create portal view (`JSMRequestCreate`). */
|
|
25138
|
+
portalId?: string;
|
|
25451
25139
|
/** @description The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard. */
|
|
25452
25140
|
projectId?: string;
|
|
25141
|
+
/** @description The request type ID of the context. Only required for Jira Service Management request create portal view (`JSMRequestCreate`). */
|
|
25142
|
+
requestTypeId?: string;
|
|
25453
25143
|
/**
|
|
25454
|
-
* @description The view type of the context.
|
|
25144
|
+
* @description The view type of the context.
|
|
25145
|
+
* Supported values:
|
|
25146
|
+
*
|
|
25147
|
+
* * `GIC` \- Jira global issue create
|
|
25148
|
+
* * `IssueView` \- Jira issue view
|
|
25149
|
+
* * `IssueTransition` \- Jira issue transition
|
|
25150
|
+
* * `JSMRequestCreate` \- Jira Service Management request create portal view
|
|
25151
|
+
*
|
|
25152
|
+
* For Jira view types (`GIC`, `IssueView`, `IssueTransition`), null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each Jira context can have a maximum of one wildcard.
|
|
25153
|
+
*
|
|
25154
|
+
* Wildcards are not applicable for JSM contexts.
|
|
25455
25155
|
* @enum {string}
|
|
25456
25156
|
*/
|
|
25457
|
-
viewType?: "GIC" | "IssueView" | "IssueTransition";
|
|
25157
|
+
viewType?: "GIC" | "IssueView" | "IssueTransition" | "JSMRequestCreate";
|
|
25458
25158
|
};
|
|
25459
25159
|
/** @description The details of a UI modification. */
|
|
25460
25160
|
UiModificationDetails: {
|
|
@@ -25847,6 +25547,8 @@ export interface components {
|
|
|
25847
25547
|
readonly expand?: string;
|
|
25848
25548
|
/** @description The groups that the user belongs to. */
|
|
25849
25549
|
readonly groups?: components["schemas"]["SimpleListWrapperGroupName"];
|
|
25550
|
+
/** @description Whether the user is a guest. */
|
|
25551
|
+
readonly guest?: boolean;
|
|
25850
25552
|
/** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
|
|
25851
25553
|
key?: string;
|
|
25852
25554
|
/** @description The locale of the user. Depending on the user’s privacy setting, this may be returned as null. */
|
|
@@ -26068,8 +25770,8 @@ export interface components {
|
|
|
26068
25770
|
archived?: boolean;
|
|
26069
25771
|
/** @description The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. */
|
|
26070
25772
|
description?: string;
|
|
26071
|
-
/** @description If the expand option `driver` is used, returns the Atlassian account ID of the driver. */
|
|
26072
|
-
|
|
25773
|
+
/** @description The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver. */
|
|
25774
|
+
driver?: string;
|
|
26073
25775
|
/**
|
|
26074
25776
|
* @description Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:
|
|
26075
25777
|
*
|
|
@@ -26303,7 +26005,7 @@ export interface components {
|
|
|
26303
26005
|
/** @description A webhook. */
|
|
26304
26006
|
Webhook: {
|
|
26305
26007
|
/** @description The Jira events that trigger the webhook. */
|
|
26306
|
-
events: ("jira:issue_created" | "jira:issue_updated" | "jira:issue_deleted" | "comment_created" | "comment_updated" | "comment_deleted" | "issue_property_set" | "issue_property_deleted")[];
|
|
26008
|
+
events: ("jira:issue_created" | "jira:issue_updated" | "jira:issue_deleted" | "comment_created" | "comment_updated" | "comment_deleted" | "issue_property_set" | "issue_property_deleted" | "sprint_created" | "sprint_updated" | "sprint_closed" | "sprint_deleted" | "sprint_started" | "jira:version_released" | "jira:version_unreleased" | "jira:version_created" | "jira:version_moved" | "jira:version_updated" | "jira:version_merged" | "jira:version_deleted")[];
|
|
26307
26009
|
/**
|
|
26308
26010
|
* Format: int64
|
|
26309
26011
|
* @description The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date.
|
|
@@ -26326,7 +26028,7 @@ export interface components {
|
|
|
26326
26028
|
/** @description A list of webhooks. */
|
|
26327
26029
|
WebhookDetails: {
|
|
26328
26030
|
/** @description The Jira events that trigger the webhook. */
|
|
26329
|
-
events: ("jira:issue_created" | "jira:issue_updated" | "jira:issue_deleted" | "comment_created" | "comment_updated" | "comment_deleted" | "issue_property_set" | "issue_property_deleted")[];
|
|
26031
|
+
events: ("jira:issue_created" | "jira:issue_updated" | "jira:issue_deleted" | "comment_created" | "comment_updated" | "comment_deleted" | "issue_property_set" | "issue_property_deleted" | "sprint_created" | "sprint_updated" | "sprint_closed" | "sprint_deleted" | "sprint_started" | "jira:version_released" | "jira:version_unreleased" | "jira:version_created" | "jira:version_moved" | "jira:version_updated" | "jira:version_merged" | "jira:version_deleted")[];
|
|
26330
26032
|
/** @description A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates. */
|
|
26331
26033
|
fieldIdsFilter?: string[];
|
|
26332
26034
|
/** @description A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about all issue property updates. */
|
|
@@ -26360,6 +26062,7 @@ export interface components {
|
|
|
26360
26062
|
WorkTypeParameters: {
|
|
26361
26063
|
description?: string;
|
|
26362
26064
|
isRequired: boolean;
|
|
26065
|
+
rendererType?: string;
|
|
26363
26066
|
/** Format: int64 */
|
|
26364
26067
|
workTypeId: number;
|
|
26365
26068
|
};
|
|
@@ -26392,12 +26095,9 @@ export interface components {
|
|
|
26392
26095
|
*/
|
|
26393
26096
|
updated?: string;
|
|
26394
26097
|
};
|
|
26395
|
-
/** @description The list of status mappings. */
|
|
26396
26098
|
WorkflowAssociationStatusMapping: {
|
|
26397
|
-
|
|
26398
|
-
|
|
26399
|
-
/** @description The ID of the status in the old workflow that isn't present in the new workflow. */
|
|
26400
|
-
oldStatusId: string;
|
|
26099
|
+
newStatusId?: string;
|
|
26100
|
+
oldStatusId?: string;
|
|
26401
26101
|
};
|
|
26402
26102
|
WorkflowCapabilities: {
|
|
26403
26103
|
/** @description The Connect provided ecosystem rules available. */
|
|
@@ -26549,17 +26249,10 @@ export interface components {
|
|
|
26549
26249
|
statuses?: components["schemas"]["WorkflowDocumentStatusDTO"][];
|
|
26550
26250
|
workflows?: components["schemas"]["WorkflowDocumentDTO"][];
|
|
26551
26251
|
};
|
|
26552
|
-
/** @description The classic workflow identifiers. */
|
|
26553
|
-
WorkflowIDs: {
|
|
26554
|
-
/** @description The entity ID of the workflow. */
|
|
26555
|
-
entityId?: string;
|
|
26556
|
-
/** @description The name of the workflow. */
|
|
26557
|
-
name: string;
|
|
26558
|
-
};
|
|
26559
26252
|
/** @description Properties that identify a workflow. */
|
|
26560
26253
|
WorkflowId: {
|
|
26561
|
-
/** @description Whether the workflow is in the draft state. */
|
|
26562
|
-
draft
|
|
26254
|
+
/** @description **Deprecated:** Whether the workflow is in the draft state. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147). */
|
|
26255
|
+
draft?: boolean;
|
|
26563
26256
|
/** @description The name of the workflow. */
|
|
26564
26257
|
name: string;
|
|
26565
26258
|
};
|
|
@@ -26878,6 +26571,11 @@ export interface components {
|
|
|
26878
26571
|
};
|
|
26879
26572
|
/** @description The name of the workflow scheme */
|
|
26880
26573
|
name?: string;
|
|
26574
|
+
/**
|
|
26575
|
+
* @description The strategy to use if there is a conflict with another workflow scheme
|
|
26576
|
+
* @enum {string}
|
|
26577
|
+
*/
|
|
26578
|
+
onConflict?: "FAIL" | "USE" | "NEW";
|
|
26881
26579
|
pcri?: components["schemas"]["ProjectCreateResourceIdentifier"];
|
|
26882
26580
|
};
|
|
26883
26581
|
/** @description An associated workflow scheme and project. */
|
|
@@ -26887,6 +26585,23 @@ export interface components {
|
|
|
26887
26585
|
/** @description The ID of the workflow scheme. If the workflow scheme ID is `null`, the operation assigns the default workflow scheme. */
|
|
26888
26586
|
workflowSchemeId?: string;
|
|
26889
26587
|
};
|
|
26588
|
+
/** @description Request to switch a project's workflow scheme */
|
|
26589
|
+
WorkflowSchemeProjectSwitchBean: {
|
|
26590
|
+
/** @description The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses in the current project's workflows would no longer exist in the target workflow scheme. Each mapping defines how to update issues from an old status to the corresponding new status in the issue’s new workflow. */
|
|
26591
|
+
mappingsByIssueTypeOverride?: components["schemas"]["MappingsByIssueTypeOverride"][];
|
|
26592
|
+
/**
|
|
26593
|
+
* @description The ID of the project to switch the workflow scheme for
|
|
26594
|
+
* @example 10001
|
|
26595
|
+
*/
|
|
26596
|
+
projectId?: string;
|
|
26597
|
+
/**
|
|
26598
|
+
* @description The ID of the target workflow scheme to switch to
|
|
26599
|
+
* @example 10002
|
|
26600
|
+
*/
|
|
26601
|
+
targetSchemeId?: string;
|
|
26602
|
+
} & {
|
|
26603
|
+
[key: string]: unknown;
|
|
26604
|
+
};
|
|
26890
26605
|
/** @description Projects using the workflow scheme. */
|
|
26891
26606
|
WorkflowSchemeProjectUsageDTO: {
|
|
26892
26607
|
projects?: components["schemas"]["ProjectUsagePage"];
|
|
@@ -27073,7 +26788,7 @@ export interface components {
|
|
|
27073
26788
|
WorkflowStatusUpdate: {
|
|
27074
26789
|
/** @description The description of the status. */
|
|
27075
26790
|
description?: string;
|
|
27076
|
-
/** @description The ID of the status. */
|
|
26791
|
+
/** @description The ID of the status. When reusing an existing status, this field should be provided. */
|
|
27077
26792
|
id?: string;
|
|
27078
26793
|
/** @description The name of the status. */
|
|
27079
26794
|
name: string;
|
|
@@ -27082,7 +26797,7 @@ export interface components {
|
|
|
27082
26797
|
* @enum {string}
|
|
27083
26798
|
*/
|
|
27084
26799
|
statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
|
|
27085
|
-
/** @description The reference of the status. */
|
|
26800
|
+
/** @description The reference of the status. If adding a new status to a team-managed workflow, this must be a UUID (for company-managed a UUID is not needed). */
|
|
27086
26801
|
statusReference: string;
|
|
27087
26802
|
} & {
|
|
27088
26803
|
[key: string]: unknown;
|
|
@@ -27250,6 +26965,8 @@ export interface components {
|
|
|
27250
26965
|
};
|
|
27251
26966
|
/** @description The details about a workflow validation error. */
|
|
27252
26967
|
WorkflowValidationError: {
|
|
26968
|
+
/** @description Additional details about the validation error. */
|
|
26969
|
+
additionalDetails?: string;
|
|
27253
26970
|
/** @description An error code. */
|
|
27254
26971
|
code?: string;
|
|
27255
26972
|
elementReference?: components["schemas"]["WorkflowElementReference"];
|
|
@@ -27669,6 +27386,8 @@ export interface operations {
|
|
|
27669
27386
|
query?: {
|
|
27670
27387
|
/** @description Whether to generate a changelog for this update. */
|
|
27671
27388
|
generateChangelog?: boolean;
|
|
27389
|
+
/** @description Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data. */
|
|
27390
|
+
generateAppEvents?: boolean;
|
|
27672
27391
|
};
|
|
27673
27392
|
header?: never;
|
|
27674
27393
|
path?: never;
|
|
@@ -27890,6 +27609,8 @@ export interface operations {
|
|
|
27890
27609
|
query?: {
|
|
27891
27610
|
/** @description Whether to generate a changelog for this update. */
|
|
27892
27611
|
generateChangelog?: boolean;
|
|
27612
|
+
/** @description Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data. */
|
|
27613
|
+
generateAppEvents?: boolean;
|
|
27893
27614
|
};
|
|
27894
27615
|
header?: never;
|
|
27895
27616
|
path: {
|
|
@@ -29936,7 +29657,7 @@ export interface operations {
|
|
|
29936
29657
|
[name: string]: unknown;
|
|
29937
29658
|
};
|
|
29938
29659
|
content: {
|
|
29939
|
-
/** @example {"description":"Field Association Scheme test description","id":1000,"isDefault":false,"links":{"associations":"rest/api/3/config/fieldschemes/10000/
|
|
29660
|
+
/** @example {"description":"Field Association Scheme test description","fieldsCount":5,"id":1000,"isDefault":false,"links":{"associations":"rest/api/3/config/fieldschemes/10000/fields","projects":"rest/api/3/config/fieldschemes/10000/projects"},"matchedFilters":{"projectIds":[10001,10002],"query":"query"},"name":"Field Association Scheme test name"} */
|
|
29940
29661
|
"application/json": components["schemas"]["PageBean2GetFieldAssociationSchemeResponse"];
|
|
29941
29662
|
};
|
|
29942
29663
|
};
|
|
@@ -30004,7 +29725,7 @@ export interface operations {
|
|
|
30004
29725
|
[name: string]: unknown;
|
|
30005
29726
|
};
|
|
30006
29727
|
content: {
|
|
30007
|
-
/** @example {"description":"Field association scheme description","id":10000,"links":{"associations":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/
|
|
29728
|
+
/** @example {"description":"Field association scheme description","id":10000,"links":{"associations":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/fields","projects":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/projects"},"name":"Field association scheme name"} */
|
|
30008
29729
|
"application/json": components["schemas"]["CreateFieldAssociationSchemeResponse"];
|
|
30009
29730
|
};
|
|
30010
29731
|
};
|
|
@@ -30250,7 +29971,8 @@ export interface operations {
|
|
|
30250
29971
|
* {
|
|
30251
29972
|
* "parameters": {
|
|
30252
29973
|
* "description": "Field description",
|
|
30253
|
-
* "isRequired": true
|
|
29974
|
+
* "isRequired": true,
|
|
29975
|
+
* "rendererType": "atlassian-wiki-renderer"
|
|
30254
29976
|
* },
|
|
30255
29977
|
* "schemeIds": [
|
|
30256
29978
|
* 10000,
|
|
@@ -30260,6 +29982,7 @@ export interface operations {
|
|
|
30260
29982
|
* {
|
|
30261
29983
|
* "description": "Description for Bug",
|
|
30262
29984
|
* "isRequired": false,
|
|
29985
|
+
* "rendererType": "jira-text-renderer",
|
|
30263
29986
|
* "workTypeId": 10002
|
|
30264
29987
|
* }
|
|
30265
29988
|
* ]
|
|
@@ -30279,6 +30002,7 @@ export interface operations {
|
|
|
30279
30002
|
* {
|
|
30280
30003
|
* "description": "Description for Task",
|
|
30281
30004
|
* "isRequired": true,
|
|
30005
|
+
* "rendererType": "atlassian-wiki-renderer",
|
|
30282
30006
|
* "workTypeId": 10003
|
|
30283
30007
|
* }
|
|
30284
30008
|
* ]
|
|
@@ -30620,7 +30344,7 @@ export interface operations {
|
|
|
30620
30344
|
[name: string]: unknown;
|
|
30621
30345
|
};
|
|
30622
30346
|
content: {
|
|
30623
|
-
/** @example {"description":"This is a field association scheme","id":"123","isDefault":false,"links":{"associations":"rest/api/3/config/fieldschemes/10000/
|
|
30347
|
+
/** @example {"description":"This is a field association scheme","fieldsCount":5,"id":"123","isDefault":false,"links":{"associations":"rest/api/3/config/fieldschemes/10000/fields","projects":"rest/api/3/config/fieldschemes/10000/projects"},"name":"Scheme"} */
|
|
30624
30348
|
"application/json": components["schemas"]["GetFieldAssociationSchemeByIdResponse"];
|
|
30625
30349
|
};
|
|
30626
30350
|
};
|
|
@@ -30672,7 +30396,7 @@ export interface operations {
|
|
|
30672
30396
|
[name: string]: unknown;
|
|
30673
30397
|
};
|
|
30674
30398
|
content: {
|
|
30675
|
-
/** @example {"description":"Field association scheme description","id":10000,"links":{"associations":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/
|
|
30399
|
+
/** @example {"description":"Field association scheme description","id":10000,"links":{"associations":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/fields","projects":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/projects"},"name":"Field association scheme name"} */
|
|
30676
30400
|
"application/json": components["schemas"]["UpdateFieldAssociationSchemeResponse"];
|
|
30677
30401
|
};
|
|
30678
30402
|
};
|
|
@@ -30783,6 +30507,77 @@ export interface operations {
|
|
|
30783
30507
|
};
|
|
30784
30508
|
};
|
|
30785
30509
|
};
|
|
30510
|
+
cloneFieldAssociationScheme: {
|
|
30511
|
+
parameters: {
|
|
30512
|
+
query?: never;
|
|
30513
|
+
header?: never;
|
|
30514
|
+
path: {
|
|
30515
|
+
/** @description The ID of the source field association scheme to clone from */
|
|
30516
|
+
id: number;
|
|
30517
|
+
};
|
|
30518
|
+
cookie?: never;
|
|
30519
|
+
};
|
|
30520
|
+
/** @description The request containing the name and description for the new scheme */
|
|
30521
|
+
requestBody: {
|
|
30522
|
+
content: {
|
|
30523
|
+
/**
|
|
30524
|
+
* @example {
|
|
30525
|
+
* "description": "Field association scheme description",
|
|
30526
|
+
* "name": "Field association scheme name"
|
|
30527
|
+
* }
|
|
30528
|
+
*/
|
|
30529
|
+
"application/json": components["schemas"]["CreateFieldAssociationSchemeRequest"];
|
|
30530
|
+
};
|
|
30531
|
+
};
|
|
30532
|
+
responses: {
|
|
30533
|
+
/** @description Returned if the clone was successful. */
|
|
30534
|
+
200: {
|
|
30535
|
+
headers: {
|
|
30536
|
+
[name: string]: unknown;
|
|
30537
|
+
};
|
|
30538
|
+
content: {
|
|
30539
|
+
/** @example {"description":"Field association scheme description","id":10000,"links":{"associations":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/fields","projects":"{BASE_API_URL}/rest/api/2/config/fieldschemes/9/projects"},"name":"Field association scheme name"} */
|
|
30540
|
+
"application/json": components["schemas"]["CreateFieldAssociationSchemeResponse"];
|
|
30541
|
+
};
|
|
30542
|
+
};
|
|
30543
|
+
/** @description Returned if the request is invalid. If request is malformed, returns a collection of errors. */
|
|
30544
|
+
400: {
|
|
30545
|
+
headers: {
|
|
30546
|
+
[name: string]: unknown;
|
|
30547
|
+
};
|
|
30548
|
+
content: {
|
|
30549
|
+
"application/json": components["schemas"]["ErrorCollections"];
|
|
30550
|
+
};
|
|
30551
|
+
};
|
|
30552
|
+
/** @description Returned if the authentication credentials are incorrect or missing. */
|
|
30553
|
+
401: {
|
|
30554
|
+
headers: {
|
|
30555
|
+
[name: string]: unknown;
|
|
30556
|
+
};
|
|
30557
|
+
content: {
|
|
30558
|
+
"application/json": unknown;
|
|
30559
|
+
};
|
|
30560
|
+
};
|
|
30561
|
+
/** @description Returned if the user does not have the required permissions */
|
|
30562
|
+
403: {
|
|
30563
|
+
headers: {
|
|
30564
|
+
[name: string]: unknown;
|
|
30565
|
+
};
|
|
30566
|
+
content: {
|
|
30567
|
+
"application/json": unknown;
|
|
30568
|
+
};
|
|
30569
|
+
};
|
|
30570
|
+
/** @description Returned if the feature flag is disabled or the source scheme ID is not found. */
|
|
30571
|
+
404: {
|
|
30572
|
+
headers: {
|
|
30573
|
+
[name: string]: unknown;
|
|
30574
|
+
};
|
|
30575
|
+
content: {
|
|
30576
|
+
"application/json": unknown;
|
|
30577
|
+
};
|
|
30578
|
+
};
|
|
30579
|
+
};
|
|
30580
|
+
};
|
|
30786
30581
|
searchFieldAssociationSchemeFields: {
|
|
30787
30582
|
parameters: {
|
|
30788
30583
|
query?: {
|
|
@@ -30808,7 +30603,7 @@ export interface operations {
|
|
|
30808
30603
|
[name: string]: unknown;
|
|
30809
30604
|
};
|
|
30810
30605
|
content: {
|
|
30811
|
-
/** @example {"allowedOperations":["REMOVE","CHANGE_REQUIRED","CHANGE_DESCRIPTION"],"fieldId":"customfield_10000","parameters":{"description":"text","isRequired":true},"restrictedToWorkTypes":["1","2"],"workTypeParameters":[{"description":"text","isRequired":true,"workTypeId":"1"},{"description":"textarea","isRequired":false,"workTypeId":"2"}]} */
|
|
30606
|
+
/** @example {"allowedOperations":["REMOVE","CHANGE_REQUIRED","CHANGE_DESCRIPTION"],"fieldId":"customfield_10000","parameters":{"description":"text","isRequired":true,"rendererType":"atlassian-wiki-renderer"},"restrictedToWorkTypes":["1","2"],"workTypeParameters":[{"description":"text","isRequired":true,"rendererType":"jira-text-renderer","workTypeId":"1"},{"description":"textarea","isRequired":false,"rendererType":"atlassian-wiki-renderer","workTypeId":"2"}]} */
|
|
30812
30607
|
"application/json": components["schemas"]["PageBean2FieldAssociationSchemeFieldSearchResult"];
|
|
30813
30608
|
};
|
|
30814
30609
|
};
|
|
@@ -30870,7 +30665,7 @@ export interface operations {
|
|
|
30870
30665
|
[name: string]: unknown;
|
|
30871
30666
|
};
|
|
30872
30667
|
content: {
|
|
30873
|
-
/** @example {"fieldId":"customfield_10000","parameters":{"description":"Teams field","isRequired":true},"workTypeParameters":[{"description":"Teams field","isRequired":false,"workTypeId":10010}]} */
|
|
30668
|
+
/** @example {"fieldId":"customfield_10000","parameters":{"description":"Teams field","isRequired":true,"rendererType":"atlassian-wiki-renderer"},"workTypeParameters":[{"description":"Teams field","isRequired":false,"rendererType":"jira-text-renderer","workTypeId":10010}]} */
|
|
30874
30669
|
"application/json": components["schemas"]["GetFieldAssociationParametersResponse"];
|
|
30875
30670
|
};
|
|
30876
30671
|
};
|
|
@@ -33131,6 +32926,56 @@ export interface operations {
|
|
|
33131
32926
|
};
|
|
33132
32927
|
};
|
|
33133
32928
|
};
|
|
32929
|
+
getFieldProjectAssociations: {
|
|
32930
|
+
parameters: {
|
|
32931
|
+
query?: {
|
|
32932
|
+
/** @description The index of the first item to return in a page of results (page offset). */
|
|
32933
|
+
startAt?: number;
|
|
32934
|
+
/** @description The maximum number of items to return per page. */
|
|
32935
|
+
maxResults?: number;
|
|
32936
|
+
};
|
|
32937
|
+
header?: never;
|
|
32938
|
+
path: {
|
|
32939
|
+
/** @description The ID of the field, for example `customfield_10000`. */
|
|
32940
|
+
fieldId: string;
|
|
32941
|
+
};
|
|
32942
|
+
cookie?: never;
|
|
32943
|
+
};
|
|
32944
|
+
requestBody?: never;
|
|
32945
|
+
responses: {
|
|
32946
|
+
/** @description Returned if the request is successful. */
|
|
32947
|
+
200: {
|
|
32948
|
+
headers: {
|
|
32949
|
+
[name: string]: unknown;
|
|
32950
|
+
};
|
|
32951
|
+
content: {
|
|
32952
|
+
/** @example {"isLast":false,"maxResults":50,"startAt":0,"total":2,"values":[{"projectId":"10010"},{"projectId":"10020"}]} */
|
|
32953
|
+
"application/json": components["schemas"]["PageBeanFieldProjectAssociation"];
|
|
32954
|
+
};
|
|
32955
|
+
};
|
|
32956
|
+
/** @description Returned if the request is invalid. */
|
|
32957
|
+
400: {
|
|
32958
|
+
headers: {
|
|
32959
|
+
[name: string]: unknown;
|
|
32960
|
+
};
|
|
32961
|
+
content?: never;
|
|
32962
|
+
};
|
|
32963
|
+
/** @description Returned if the authentication credentials are incorrect or missing. */
|
|
32964
|
+
401: {
|
|
32965
|
+
headers: {
|
|
32966
|
+
[name: string]: unknown;
|
|
32967
|
+
};
|
|
32968
|
+
content?: never;
|
|
32969
|
+
};
|
|
32970
|
+
/** @description Returned if the user does not have the necessary permission. */
|
|
32971
|
+
403: {
|
|
32972
|
+
headers: {
|
|
32973
|
+
[name: string]: unknown;
|
|
32974
|
+
};
|
|
32975
|
+
content?: never;
|
|
32976
|
+
};
|
|
32977
|
+
};
|
|
32978
|
+
};
|
|
33134
32979
|
getContextsForField: {
|
|
33135
32980
|
parameters: {
|
|
33136
32981
|
query?: {
|
|
@@ -33405,6 +33250,65 @@ export interface operations {
|
|
|
33405
33250
|
};
|
|
33406
33251
|
};
|
|
33407
33252
|
};
|
|
33253
|
+
getContextDefaultValues: {
|
|
33254
|
+
parameters: {
|
|
33255
|
+
query?: {
|
|
33256
|
+
/** @description The IDs of the contexts to return default values for. If omitted, default values for every context the custom field has are returned. */
|
|
33257
|
+
contextId?: number[];
|
|
33258
|
+
/** @description The IDs of the issue types to restrict the returned per-issue-type default values to. If omitted, default values for every issue type are returned. This filter never removes the catch-all \{@code isAnyIssueType\} entry of a context. */
|
|
33259
|
+
issueTypeId?: string[];
|
|
33260
|
+
/** @description The index of the first item to return in a page of results (page offset). */
|
|
33261
|
+
startAt?: number;
|
|
33262
|
+
/** @description The maximum number of items to return per page. */
|
|
33263
|
+
maxResults?: number;
|
|
33264
|
+
};
|
|
33265
|
+
header?: never;
|
|
33266
|
+
path: {
|
|
33267
|
+
/** @description The ID of the custom field, for example `customfield\_10000`. */
|
|
33268
|
+
fieldId: string;
|
|
33269
|
+
};
|
|
33270
|
+
cookie?: never;
|
|
33271
|
+
};
|
|
33272
|
+
requestBody?: never;
|
|
33273
|
+
responses: {
|
|
33274
|
+
/** @description Returned if the request is successful. */
|
|
33275
|
+
200: {
|
|
33276
|
+
headers: {
|
|
33277
|
+
[name: string]: unknown;
|
|
33278
|
+
};
|
|
33279
|
+
content: {
|
|
33280
|
+
"application/json": components["schemas"]["PageBeanContextDefaultValues"];
|
|
33281
|
+
};
|
|
33282
|
+
};
|
|
33283
|
+
/** @description Returned if the authentication credentials are incorrect or missing. */
|
|
33284
|
+
401: {
|
|
33285
|
+
headers: {
|
|
33286
|
+
[name: string]: unknown;
|
|
33287
|
+
};
|
|
33288
|
+
content?: never;
|
|
33289
|
+
};
|
|
33290
|
+
/** @description Returned if the user does not have the required permissions. */
|
|
33291
|
+
403: {
|
|
33292
|
+
headers: {
|
|
33293
|
+
[name: string]: unknown;
|
|
33294
|
+
};
|
|
33295
|
+
content: {
|
|
33296
|
+
/** @example {"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}} */
|
|
33297
|
+
"application/json": unknown;
|
|
33298
|
+
};
|
|
33299
|
+
};
|
|
33300
|
+
/** @description Returned if the custom field is not found. */
|
|
33301
|
+
404: {
|
|
33302
|
+
headers: {
|
|
33303
|
+
[name: string]: unknown;
|
|
33304
|
+
};
|
|
33305
|
+
content: {
|
|
33306
|
+
/** @example {"errorMessages":["The custom field was not found."],"errors":{}} */
|
|
33307
|
+
"application/json": unknown;
|
|
33308
|
+
};
|
|
33309
|
+
};
|
|
33310
|
+
};
|
|
33311
|
+
};
|
|
33408
33312
|
getIssueTypeMappingsForContexts: {
|
|
33409
33313
|
parameters: {
|
|
33410
33314
|
query?: {
|
|
@@ -37069,6 +36973,58 @@ export interface operations {
|
|
|
37069
36973
|
};
|
|
37070
36974
|
};
|
|
37071
36975
|
};
|
|
36976
|
+
bulkPinUnpinProjectsAsync: {
|
|
36977
|
+
parameters: {
|
|
36978
|
+
query?: never;
|
|
36979
|
+
header?: never;
|
|
36980
|
+
path?: never;
|
|
36981
|
+
cookie?: never;
|
|
36982
|
+
};
|
|
36983
|
+
/** @description Forge module ID and the list of projects with pin or unpin action. */
|
|
36984
|
+
requestBody: {
|
|
36985
|
+
content: {
|
|
36986
|
+
"application/json": components["schemas"]["ForgePanelProjectPinRequest"];
|
|
36987
|
+
};
|
|
36988
|
+
};
|
|
36989
|
+
responses: {
|
|
36990
|
+
/** @description Accepted. Returns the task ID for polling progress. */
|
|
36991
|
+
202: {
|
|
36992
|
+
headers: {
|
|
36993
|
+
[name: string]: unknown;
|
|
36994
|
+
};
|
|
36995
|
+
content: {
|
|
36996
|
+
"application/json": components["schemas"]["ForgePanelProjectPinAsyncResponse"];
|
|
36997
|
+
};
|
|
36998
|
+
};
|
|
36999
|
+
/** @description Returned if the request body is invalid. */
|
|
37000
|
+
400: {
|
|
37001
|
+
headers: {
|
|
37002
|
+
[name: string]: unknown;
|
|
37003
|
+
};
|
|
37004
|
+
content: {
|
|
37005
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
37006
|
+
};
|
|
37007
|
+
};
|
|
37008
|
+
/** @description Returned if the user does not have permission to administer Jira. */
|
|
37009
|
+
403: {
|
|
37010
|
+
headers: {
|
|
37011
|
+
[name: string]: unknown;
|
|
37012
|
+
};
|
|
37013
|
+
content: {
|
|
37014
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
37015
|
+
};
|
|
37016
|
+
};
|
|
37017
|
+
/** @description Returned if the task could not be submitted (server error). */
|
|
37018
|
+
500: {
|
|
37019
|
+
headers: {
|
|
37020
|
+
[name: string]: unknown;
|
|
37021
|
+
};
|
|
37022
|
+
content: {
|
|
37023
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
37024
|
+
};
|
|
37025
|
+
};
|
|
37026
|
+
};
|
|
37027
|
+
};
|
|
37072
37028
|
getGroup: {
|
|
37073
37029
|
parameters: {
|
|
37074
37030
|
query?: {
|
|
@@ -37506,6 +37462,13 @@ export interface operations {
|
|
|
37506
37462
|
};
|
|
37507
37463
|
content?: never;
|
|
37508
37464
|
};
|
|
37465
|
+
/** @description Returned if rate limiting is being enforced. */
|
|
37466
|
+
429: {
|
|
37467
|
+
headers: {
|
|
37468
|
+
[name: string]: unknown;
|
|
37469
|
+
};
|
|
37470
|
+
content?: never;
|
|
37471
|
+
};
|
|
37509
37472
|
};
|
|
37510
37473
|
};
|
|
37511
37474
|
findGroups: {
|
|
@@ -37568,6 +37531,8 @@ export interface operations {
|
|
|
37568
37531
|
caseInsensitive?: boolean;
|
|
37569
37532
|
/** @description Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used. */
|
|
37570
37533
|
excludeConnectAddons?: boolean;
|
|
37534
|
+
/** @description Whether AI Agents should be included in the search results. If an invalid value is provided, the default value is used. */
|
|
37535
|
+
includeAiAgents?: boolean;
|
|
37571
37536
|
};
|
|
37572
37537
|
header?: never;
|
|
37573
37538
|
path?: never;
|
|
@@ -38631,6 +38596,15 @@ export interface operations {
|
|
|
38631
38596
|
"application/json": components["schemas"]["ErrorCollection"];
|
|
38632
38597
|
};
|
|
38633
38598
|
};
|
|
38599
|
+
/** @description Returned if another bulk update on the same issues is already in progress. Retry the request later. */
|
|
38600
|
+
409: {
|
|
38601
|
+
headers: {
|
|
38602
|
+
[name: string]: unknown;
|
|
38603
|
+
};
|
|
38604
|
+
content: {
|
|
38605
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
38606
|
+
};
|
|
38607
|
+
};
|
|
38634
38608
|
};
|
|
38635
38609
|
};
|
|
38636
38610
|
bulkSetIssuePropertiesByIssue: {
|
|
@@ -38705,6 +38679,15 @@ export interface operations {
|
|
|
38705
38679
|
"application/json": components["schemas"]["ErrorCollection"];
|
|
38706
38680
|
};
|
|
38707
38681
|
};
|
|
38682
|
+
/** @description Returned if another bulk update on the same issues is already in progress. Retry the request later. */
|
|
38683
|
+
409: {
|
|
38684
|
+
headers: {
|
|
38685
|
+
[name: string]: unknown;
|
|
38686
|
+
};
|
|
38687
|
+
content: {
|
|
38688
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
38689
|
+
};
|
|
38690
|
+
};
|
|
38708
38691
|
};
|
|
38709
38692
|
};
|
|
38710
38693
|
bulkSetIssueProperty: {
|
|
@@ -39169,7 +39152,7 @@ export interface operations {
|
|
|
39169
39152
|
*
|
|
39170
39153
|
* * the request body is missing.
|
|
39171
39154
|
* * the user does not have the necessary permission to edit one or more fields.
|
|
39172
|
-
* * the request includes one or more fields that
|
|
39155
|
+
* * the request includes one or more fields that don't exist or aren't associated with the project and issue type.
|
|
39173
39156
|
* * the request includes an invalid transition.
|
|
39174
39157
|
*/
|
|
39175
39158
|
400: {
|
|
@@ -40132,14 +40115,14 @@ export interface operations {
|
|
|
40132
40115
|
};
|
|
40133
40116
|
requestBody?: never;
|
|
40134
40117
|
responses: {
|
|
40135
|
-
/** @description Returned if the request is successful. */
|
|
40118
|
+
/** @description Returned if the request is successful. A single RemoteIssueLink will be returned when specifying `globalId`, otherwise an array of RemoteIssueLink is returned. */
|
|
40136
40119
|
200: {
|
|
40137
40120
|
headers: {
|
|
40138
40121
|
[name: string]: unknown;
|
|
40139
40122
|
};
|
|
40140
40123
|
content: {
|
|
40141
40124
|
/** @example [{"application":{"name":"My Acme Tracker","type":"com.acme.tracker"},"globalId":"system=http://www.mycompany.com/support&id=1","id":10000,"object":{"icon":{"title":"Support Ticket","url16x16":"http://www.mycompany.com/support/ticket.png"},"status":{"icon":{"link":"http://www.mycompany.com/support?id=1&details=closed","title":"Case Closed","url16x16":"http://www.mycompany.com/support/resolved.png"},"resolved":true},"summary":"Customer support issue","title":"TSTSUP-111","url":"http://www.mycompany.com/support?id=1"},"relationship":"causes","self":"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"},{"application":{"name":"My Acme Tester","type":"com.acme.tester"},"globalId":"system=http://www.anothercompany.com/tester&id=1234","id":10001,"object":{"icon":{"title":"Test Case","url16x16":"http://www.anothercompany.com/tester/images/testcase.gif"},"status":{"icon":{"link":"http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g","title":"Tested by Mia Krystof","url16x16":"http://www.anothercompany.com/tester/images/person/mia.gif"},"resolved":false},"summary":"Test that the submit button saves the item","title":"Test Case #1234","url":"http://www.anothercompany.com/tester/testcase/1234"},"relationship":"is tested by","self":"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10001"}] */
|
|
40142
|
-
"application/json": components["schemas"]["RemoteIssueLink"];
|
|
40125
|
+
"application/json": components["schemas"]["RemoteIssueLink"][] | components["schemas"]["RemoteIssueLink"];
|
|
40143
40126
|
};
|
|
40144
40127
|
};
|
|
40145
40128
|
/** @description Returned if the request is invalid. */
|
|
@@ -44564,7 +44547,7 @@ export interface operations {
|
|
|
44564
44547
|
"application/json": unknown;
|
|
44565
44548
|
};
|
|
44566
44549
|
};
|
|
44567
|
-
/** @description Returned if the request is to delete the default issue type scheme
|
|
44550
|
+
/** @description Returned if the request is to delete the default issue type scheme or if the scheme is associated with a project */
|
|
44568
44551
|
400: {
|
|
44569
44552
|
headers: {
|
|
44570
44553
|
[name: string]: unknown;
|
|
@@ -48849,7 +48832,7 @@ export interface operations {
|
|
|
48849
48832
|
/**
|
|
48850
48833
|
* @example {
|
|
48851
48834
|
* "description": "My priority description",
|
|
48852
|
-
* "iconUrl": "images/icons/priorities/major.png",
|
|
48835
|
+
* "iconUrl": "/images/icons/priorities/major.png",
|
|
48853
48836
|
* "name": "My new priority",
|
|
48854
48837
|
* "statusColor": "#ABCDEF"
|
|
48855
48838
|
* }
|
|
@@ -49137,7 +49120,7 @@ export interface operations {
|
|
|
49137
49120
|
/**
|
|
49138
49121
|
* @example {
|
|
49139
49122
|
* "description": "My updated priority description",
|
|
49140
|
-
* "iconUrl": "images/icons/priorities/minor.png",
|
|
49123
|
+
* "iconUrl": "/images/icons/priorities/minor.png",
|
|
49141
49124
|
* "name": "My updated priority",
|
|
49142
49125
|
* "statusColor": "#123456"
|
|
49143
49126
|
* }
|
|
@@ -50717,6 +50700,44 @@ export interface operations {
|
|
|
50717
50700
|
};
|
|
50718
50701
|
};
|
|
50719
50702
|
};
|
|
50703
|
+
getProjectClassificationConfig: {
|
|
50704
|
+
parameters: {
|
|
50705
|
+
query?: never;
|
|
50706
|
+
header?: never;
|
|
50707
|
+
path: {
|
|
50708
|
+
/** @description The project ID or project key (case-sensitive). */
|
|
50709
|
+
projectIdOrKey: string;
|
|
50710
|
+
};
|
|
50711
|
+
cookie?: never;
|
|
50712
|
+
};
|
|
50713
|
+
requestBody?: never;
|
|
50714
|
+
responses: {
|
|
50715
|
+
/** @description Returned if the request is successful. */
|
|
50716
|
+
200: {
|
|
50717
|
+
headers: {
|
|
50718
|
+
[name: string]: unknown;
|
|
50719
|
+
};
|
|
50720
|
+
content: {
|
|
50721
|
+
/** @example {"classificationLevels":[{"id":"ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38","status":"published","name":"Restricted","rank":1,"description":"Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled","guideline":"Access to data must be restricted to only individuals who need access in order to perform their job duties.","color":"RED"}],"containerOverride":"ANY","defaultClassificationLevel":{"id":"ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38","status":"published","name":"Restricted","rank":1,"description":"Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled","guideline":"Access to data must be restricted to only individuals who need access in order to perform their job duties.","color":"RED"},"organizationClassificationLevel":{"id":"ari:cloud:platform::classification-tag/a82d653e-1035-4aa2-b9de-4265511fd487","status":"published","name":"Confidential","rank":2,"description":"Data we hold that would likely be damaging and could cause loss of trust with our customers if mishandled","guideline":"Data should be encrypted at rest and in transit.","color":"BLUE"}} */
|
|
50722
|
+
"application/json": unknown;
|
|
50723
|
+
};
|
|
50724
|
+
};
|
|
50725
|
+
/** @description Returned if the user does not have the necessary permission. */
|
|
50726
|
+
401: {
|
|
50727
|
+
headers: {
|
|
50728
|
+
[name: string]: unknown;
|
|
50729
|
+
};
|
|
50730
|
+
content?: never;
|
|
50731
|
+
};
|
|
50732
|
+
/** @description Returned if the project is not found or the feature is disabled. */
|
|
50733
|
+
404: {
|
|
50734
|
+
headers: {
|
|
50735
|
+
[name: string]: unknown;
|
|
50736
|
+
};
|
|
50737
|
+
content?: never;
|
|
50738
|
+
};
|
|
50739
|
+
};
|
|
50740
|
+
};
|
|
50720
50741
|
getDefaultProjectClassification: {
|
|
50721
50742
|
parameters: {
|
|
50722
50743
|
query?: never;
|
|
@@ -50735,7 +50756,7 @@ export interface operations {
|
|
|
50735
50756
|
[name: string]: unknown;
|
|
50736
50757
|
};
|
|
50737
50758
|
content: {
|
|
50738
|
-
/** @example {"classification":{"id":"ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38","status":"published","name":"Restricted","rank":1,"description":"Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled","guideline":"Access to data must be restricted to only individuals who need access in order to perform their job duties.","color":"RED"}} */
|
|
50759
|
+
/** @example {"classification":{"id":"ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38","status":"published","name":"Restricted","rank":1,"description":"Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled","guideline":"Access to data must be restricted to only individuals who need access in order to perform their job duties.","guidelineADF":"{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Access to data must be restricted to only individuals who need access in order to perform their job duties.\"}]}]}","color":"RED"}} */
|
|
50739
50760
|
"application/json": unknown;
|
|
50740
50761
|
};
|
|
50741
50762
|
};
|
|
@@ -51691,7 +51712,7 @@ export interface operations {
|
|
|
51691
51712
|
[name: string]: unknown;
|
|
51692
51713
|
};
|
|
51693
51714
|
content: {
|
|
51694
|
-
/** @example [{"self":"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","admin":false,"default":true,"roleConfigurable":true,"translatedName":"Developers"}] */
|
|
51715
|
+
/** @example [{"self":"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","admin":false,"default":true,"roleConfigurable":true,"translatedName":"Developers","type":"DEFAULT"}] */
|
|
51695
51716
|
"application/json": components["schemas"]["ProjectRoleDetails"][];
|
|
51696
51717
|
};
|
|
51697
51718
|
};
|
|
@@ -54357,7 +54378,9 @@ export interface operations {
|
|
|
54357
54378
|
};
|
|
54358
54379
|
addScreenTabField: {
|
|
54359
54380
|
parameters: {
|
|
54360
|
-
query?:
|
|
54381
|
+
query?: {
|
|
54382
|
+
skipFieldAssociation?: boolean;
|
|
54383
|
+
};
|
|
54361
54384
|
header?: never;
|
|
54362
54385
|
path: {
|
|
54363
54386
|
/** @description The ID of the screen. */
|
|
@@ -55745,6 +55768,8 @@ export interface operations {
|
|
|
55745
55768
|
searchString?: string;
|
|
55746
55769
|
/** @description Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`. */
|
|
55747
55770
|
statusCategory?: string;
|
|
55771
|
+
/** @description Whether to include global statuses (scope = null, not tied to any project) in the response. Defaults to false. Only relevant for project scoped queries. */
|
|
55772
|
+
includeGlobalStatuses?: boolean;
|
|
55748
55773
|
};
|
|
55749
55774
|
header?: never;
|
|
55750
55775
|
path?: never;
|
|
@@ -56070,7 +56095,7 @@ export interface operations {
|
|
|
56070
56095
|
[name: string]: unknown;
|
|
56071
56096
|
};
|
|
56072
56097
|
content: {
|
|
56073
|
-
/** @example {"isLast":true,"maxResults":100,"startAt":0,"total":3,"values":[{"id":"d7dbda8a-6239-4b63-8e13-a5ef975c8e61","name":"Reveal Story Points","description":"Reveals Story Points field when any Sprint is selected.","self":"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61","data":"{field: 'Story Points', config: {hidden: false}}","contexts":[{"id":"1533537a-bda3-4ac6-8481-846128cd9ef4","projectId":"10000","issueTypeId":"10000","viewType":"GIC","isAvailable":true},{"id":"c016fefa-6eb3-40c9-8596-4c4ef273e67c","projectId":"10000","issueTypeId":"10001","viewType":"IssueView","isAvailable":true},{"id":"1016defa-7ew3-40c5-8696-4c1efg73e67s","projectId":"10000","issueTypeId":"10002","viewType":"IssueTransition","isAvailable":true}]},{"id":"e4fe8db5-f82f-416b-a3aa-b260b55da577","name":"Set Assignee","description":"Sets the Assignee field automatically.","self":"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/e4fe8db5-f82f-416b-a3aa-b260b55da577","contexts":[{"id":"8b3740f9-8780-4958-8228-69dcfbda11d9","projectId":"10000","issueTypeId":"10000","viewType":"GIC","isAvailable":true}]},{"id":"
|
|
56098
|
+
/** @example {"isLast":true,"maxResults":100,"startAt":0,"total":3,"values":[{"id":"d7dbda8a-6239-4b63-8e13-a5ef975c8e61","name":"Reveal Story Points","description":"Reveals Story Points field when any Sprint is selected.","self":"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61","data":"{field: 'Story Points', config: {hidden: false}}","contexts":[{"id":"1533537a-bda3-4ac6-8481-846128cd9ef4","projectId":"10000","issueTypeId":"10000","viewType":"GIC","isAvailable":true},{"id":"c016fefa-6eb3-40c9-8596-4c4ef273e67c","projectId":"10000","issueTypeId":"10001","viewType":"IssueView","isAvailable":true},{"id":"1016defa-7ew3-40c5-8696-4c1efg73e67s","projectId":"10000","issueTypeId":"10002","viewType":"IssueTransition","isAvailable":true}]},{"id":"e4fe8db5-f82f-416b-a3aa-b260b55da577","name":"Set Assignee","description":"Sets the Assignee field automatically.","self":"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/e4fe8db5-f82f-416b-a3aa-b260b55da577","contexts":[{"id":"8b3740f9-8780-4958-8228-69dcfbda11d9","projectId":"10000","issueTypeId":"10000","viewType":"GIC","isAvailable":true}]},{"id":"d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff","name":"Wildcard example","description":"This context is applied to all issue types","self":"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff","contexts":[{"id":"521f2181-5d5e-46ea-9fc9-871bbf245b8b","projectId":"10000","issueTypeId":null,"viewType":"GIC","isAvailable":true}]},{"id":"1453f993-79ce-4389-a36d-eb72d5c85dd6","name":"JSM Context","description":"JSM context doesn't support wildcards.","self":"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/1453f993-79ce-4389-a36d-eb72d5c85dd6","contexts":[{"id":"521f2181-8780-4958-9fc9-871bbf245b8b","projectId":null,"portalId":"5","issueTypeId":null,"requestTypeId":"100","viewType":"JSMRequestCreate","isAvailable":true}]}]} */
|
|
56074
56099
|
"application/json": components["schemas"]["PageBeanUiModificationDetails"];
|
|
56075
56100
|
};
|
|
56076
56101
|
};
|
|
@@ -56129,6 +56154,13 @@ export interface operations {
|
|
|
56129
56154
|
* "issueTypeId": "10003",
|
|
56130
56155
|
* "projectId": "10000",
|
|
56131
56156
|
* "viewType": null
|
|
56157
|
+
* },
|
|
56158
|
+
* {
|
|
56159
|
+
* "issueTypeId": null,
|
|
56160
|
+
* "portalId": "1",
|
|
56161
|
+
* "projectId": null,
|
|
56162
|
+
* "requestTypeId": "10",
|
|
56163
|
+
* "viewType": "JSMRequestCreate"
|
|
56132
56164
|
* }
|
|
56133
56165
|
* ],
|
|
56134
56166
|
* "data": "{field: 'Story Points', config: {hidden: false}}",
|
|
@@ -56171,7 +56203,7 @@ export interface operations {
|
|
|
56171
56203
|
};
|
|
56172
56204
|
content?: never;
|
|
56173
56205
|
};
|
|
56174
|
-
/** @description Returned if a project or
|
|
56206
|
+
/** @description Returned if a project, issue type, portal, or request type in the context are not found. */
|
|
56175
56207
|
404: {
|
|
56176
56208
|
headers: {
|
|
56177
56209
|
[name: string]: unknown;
|
|
@@ -56213,6 +56245,13 @@ export interface operations {
|
|
|
56213
56245
|
* "issueTypeId": "10002",
|
|
56214
56246
|
* "projectId": "10000",
|
|
56215
56247
|
* "viewType": "IssueTransition"
|
|
56248
|
+
* },
|
|
56249
|
+
* {
|
|
56250
|
+
* "issueTypeId": null,
|
|
56251
|
+
* "portalId": "5",
|
|
56252
|
+
* "projectId": null,
|
|
56253
|
+
* "requestTypeId": "100",
|
|
56254
|
+
* "viewType": "JSMRequestCreate"
|
|
56216
56255
|
* }
|
|
56217
56256
|
* ],
|
|
56218
56257
|
* "data": "{field: 'Story Points', config: {hidden: true}}",
|
|
@@ -56253,7 +56292,7 @@ export interface operations {
|
|
|
56253
56292
|
};
|
|
56254
56293
|
content?: never;
|
|
56255
56294
|
};
|
|
56256
|
-
/** @description Returned if the UI modification, a project or
|
|
56295
|
+
/** @description Returned if the UI modification, a project, issue type, portal, or request type in the context are not found. */
|
|
56257
56296
|
404: {
|
|
56258
56297
|
headers: {
|
|
56259
56298
|
[name: string]: unknown;
|
|
@@ -56816,7 +56855,7 @@ export interface operations {
|
|
|
56816
56855
|
"application/json": components["schemas"]["User"];
|
|
56817
56856
|
};
|
|
56818
56857
|
};
|
|
56819
|
-
/** @description Returned if the request is invalid or the number of licensed users is exceeded. */
|
|
56858
|
+
/** @description Returned if the request is invalid, the user already exists but does not have access to jira, or the number of licensed users is exceeded. */
|
|
56820
56859
|
400: {
|
|
56821
56860
|
headers: {
|
|
56822
56861
|
[name: string]: unknown;
|
|
@@ -56984,6 +57023,8 @@ export interface operations {
|
|
|
56984
57023
|
/** @description The ID of the transition. */
|
|
56985
57024
|
actionDescriptorId?: number;
|
|
56986
57025
|
recommend?: boolean;
|
|
57026
|
+
accountType?: string[];
|
|
57027
|
+
appType?: string[];
|
|
56987
57028
|
};
|
|
56988
57029
|
header?: never;
|
|
56989
57030
|
path?: never;
|
|
@@ -58107,6 +58148,7 @@ export interface operations {
|
|
|
58107
58148
|
startAt?: number;
|
|
58108
58149
|
/** @description The maximum number of items to return (limited to 1000). */
|
|
58109
58150
|
maxResults?: number;
|
|
58151
|
+
expand?: string;
|
|
58110
58152
|
};
|
|
58111
58153
|
header?: never;
|
|
58112
58154
|
path?: never;
|
|
@@ -58154,6 +58196,7 @@ export interface operations {
|
|
|
58154
58196
|
startAt?: number;
|
|
58155
58197
|
/** @description The maximum number of items to return (limited to 1000). */
|
|
58156
58198
|
maxResults?: number;
|
|
58199
|
+
expand?: string;
|
|
58157
58200
|
};
|
|
58158
58201
|
header?: never;
|
|
58159
58202
|
path?: never;
|
|
@@ -58948,238 +58991,51 @@ export interface operations {
|
|
|
58948
58991
|
};
|
|
58949
58992
|
};
|
|
58950
58993
|
};
|
|
58951
|
-
registerDynamicWebhooks: {
|
|
58952
|
-
parameters: {
|
|
58953
|
-
query?: never;
|
|
58954
|
-
header?: never;
|
|
58955
|
-
path?: never;
|
|
58956
|
-
cookie?: never;
|
|
58957
|
-
};
|
|
58958
|
-
requestBody: {
|
|
58959
|
-
content: {
|
|
58960
|
-
/**
|
|
58961
|
-
* @example {
|
|
58962
|
-
* "url": "https://your-app.example.com/webhook-received",
|
|
58963
|
-
* "webhooks": [
|
|
58964
|
-
* {
|
|
58965
|
-
* "events": [
|
|
58966
|
-
* "jira:issue_created",
|
|
58967
|
-
* "jira:issue_updated"
|
|
58968
|
-
* ],
|
|
58969
|
-
* "fieldIdsFilter": [
|
|
58970
|
-
* "summary",
|
|
58971
|
-
* "customfield_10029"
|
|
58972
|
-
* ],
|
|
58973
|
-
* "jqlFilter": "project = PROJ"
|
|
58974
|
-
* },
|
|
58975
|
-
* {
|
|
58976
|
-
* "events": [
|
|
58977
|
-
* "jira:issue_deleted"
|
|
58978
|
-
* ],
|
|
58979
|
-
* "jqlFilter": "project IN (PROJ, EXP) AND status = done"
|
|
58980
|
-
* },
|
|
58981
|
-
* {
|
|
58982
|
-
* "events": [
|
|
58983
|
-
* "issue_property_set"
|
|
58984
|
-
* ],
|
|
58985
|
-
* "issuePropertyKeysFilter": [
|
|
58986
|
-
* "my-issue-property-key"
|
|
58987
|
-
* ],
|
|
58988
|
-
* "jqlFilter": "project = PROJ"
|
|
58989
|
-
* }
|
|
58990
|
-
* ]
|
|
58991
|
-
* }
|
|
58992
|
-
*/
|
|
58993
|
-
"application/json": components["schemas"]["WebhookRegistrationDetails"];
|
|
58994
|
-
};
|
|
58995
|
-
};
|
|
58996
|
-
responses: {
|
|
58997
|
-
/** @description Returned if the request is successful. */
|
|
58998
|
-
200: {
|
|
58999
|
-
headers: {
|
|
59000
|
-
[name: string]: unknown;
|
|
59001
|
-
};
|
|
59002
|
-
content: {
|
|
59003
|
-
/** @example {"webhookRegistrationResult":[{"createdWebhookId":1000},{"errors":["The clause watchCount is unsupported"]},{"createdWebhookId":1001}]} */
|
|
59004
|
-
"application/json": components["schemas"]["ContainerForRegisteredWebhooks"];
|
|
59005
|
-
};
|
|
59006
|
-
};
|
|
59007
|
-
/** @description Returned if the request is invalid. */
|
|
59008
|
-
400: {
|
|
59009
|
-
headers: {
|
|
59010
|
-
[name: string]: unknown;
|
|
59011
|
-
};
|
|
59012
|
-
content: {
|
|
59013
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59014
|
-
};
|
|
59015
|
-
};
|
|
59016
|
-
/** @description Returned if the caller isn't an app. */
|
|
59017
|
-
403: {
|
|
59018
|
-
headers: {
|
|
59019
|
-
[name: string]: unknown;
|
|
59020
|
-
};
|
|
59021
|
-
content: {
|
|
59022
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59023
|
-
};
|
|
59024
|
-
};
|
|
59025
|
-
};
|
|
59026
|
-
};
|
|
59027
|
-
deleteWebhookById: {
|
|
59028
|
-
parameters: {
|
|
59029
|
-
query?: never;
|
|
59030
|
-
header?: never;
|
|
59031
|
-
path?: never;
|
|
59032
|
-
cookie?: never;
|
|
59033
|
-
};
|
|
59034
|
-
requestBody: {
|
|
59035
|
-
content: {
|
|
59036
|
-
/**
|
|
59037
|
-
* @example {
|
|
59038
|
-
* "webhookIds": [
|
|
59039
|
-
* 10000,
|
|
59040
|
-
* 10001,
|
|
59041
|
-
* 10042
|
|
59042
|
-
* ]
|
|
59043
|
-
* }
|
|
59044
|
-
*/
|
|
59045
|
-
"application/json": components["schemas"]["ContainerForWebhookIDs"];
|
|
59046
|
-
};
|
|
59047
|
-
};
|
|
59048
|
-
responses: {
|
|
59049
|
-
/** @description Returned if the request is successful. */
|
|
59050
|
-
202: {
|
|
59051
|
-
headers: {
|
|
59052
|
-
[name: string]: unknown;
|
|
59053
|
-
};
|
|
59054
|
-
content?: never;
|
|
59055
|
-
};
|
|
59056
|
-
/** @description Returned if the list of webhook IDs is missing. */
|
|
59057
|
-
400: {
|
|
59058
|
-
headers: {
|
|
59059
|
-
[name: string]: unknown;
|
|
59060
|
-
};
|
|
59061
|
-
content: {
|
|
59062
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59063
|
-
};
|
|
59064
|
-
};
|
|
59065
|
-
/** @description Returned if the caller isn't an app. */
|
|
59066
|
-
403: {
|
|
59067
|
-
headers: {
|
|
59068
|
-
[name: string]: unknown;
|
|
59069
|
-
};
|
|
59070
|
-
content: {
|
|
59071
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59072
|
-
};
|
|
59073
|
-
};
|
|
59074
|
-
};
|
|
59075
|
-
};
|
|
59076
|
-
getFailedWebhooks: {
|
|
59077
|
-
parameters: {
|
|
59078
|
-
query?: {
|
|
59079
|
-
/** @description The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page. */
|
|
59080
|
-
maxResults?: number;
|
|
59081
|
-
/** @description The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch. */
|
|
59082
|
-
after?: number;
|
|
59083
|
-
};
|
|
59084
|
-
header?: never;
|
|
59085
|
-
path?: never;
|
|
59086
|
-
cookie?: never;
|
|
59087
|
-
};
|
|
59088
|
-
requestBody?: never;
|
|
59089
|
-
responses: {
|
|
59090
|
-
/** @description Returned if the request is successful. */
|
|
59091
|
-
200: {
|
|
59092
|
-
headers: {
|
|
59093
|
-
[name: string]: unknown;
|
|
59094
|
-
};
|
|
59095
|
-
content: {
|
|
59096
|
-
/** @example {"values":[{"id":"1","body":"{\"data\":\"webhook data\"}","url":"https://example.com","failureTime":1573118132000},{"id":"2","url":"https://example.com","failureTime":1573540473480}],"maxResults":100,"next":"https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"} */
|
|
59097
|
-
"application/json": components["schemas"]["FailedWebhooks"];
|
|
59098
|
-
};
|
|
59099
|
-
};
|
|
59100
|
-
/** @description 400 response */
|
|
59101
|
-
400: {
|
|
59102
|
-
headers: {
|
|
59103
|
-
[name: string]: unknown;
|
|
59104
|
-
};
|
|
59105
|
-
content: {
|
|
59106
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59107
|
-
};
|
|
59108
|
-
};
|
|
59109
|
-
/** @description Returned if the caller is not a Connect app. */
|
|
59110
|
-
403: {
|
|
59111
|
-
headers: {
|
|
59112
|
-
[name: string]: unknown;
|
|
59113
|
-
};
|
|
59114
|
-
content: {
|
|
59115
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59116
|
-
};
|
|
59117
|
-
};
|
|
59118
|
-
};
|
|
59119
|
-
};
|
|
59120
|
-
refreshWebhooks: {
|
|
59121
|
-
parameters: {
|
|
59122
|
-
query?: never;
|
|
59123
|
-
header?: never;
|
|
59124
|
-
path?: never;
|
|
59125
|
-
cookie?: never;
|
|
59126
|
-
};
|
|
59127
|
-
requestBody: {
|
|
59128
|
-
content: {
|
|
59129
|
-
/**
|
|
59130
|
-
* @example {
|
|
59131
|
-
* "webhookIds": [
|
|
59132
|
-
* 10000,
|
|
59133
|
-
* 10001,
|
|
59134
|
-
* 10042
|
|
59135
|
-
* ]
|
|
59136
|
-
* }
|
|
59137
|
-
*/
|
|
59138
|
-
"application/json": components["schemas"]["ContainerForWebhookIDs"];
|
|
59139
|
-
};
|
|
59140
|
-
};
|
|
59141
|
-
responses: {
|
|
59142
|
-
/** @description Returned if the request is successful. */
|
|
59143
|
-
200: {
|
|
59144
|
-
headers: {
|
|
59145
|
-
[name: string]: unknown;
|
|
59146
|
-
};
|
|
59147
|
-
content: {
|
|
59148
|
-
/** @example {"expirationDate":"2019-06-01T12:42:30.000+0000"} */
|
|
59149
|
-
"application/json": components["schemas"]["WebhooksExpirationDate"];
|
|
59150
|
-
};
|
|
59151
|
-
};
|
|
59152
|
-
/** @description Returned if the request is invalid. */
|
|
59153
|
-
400: {
|
|
59154
|
-
headers: {
|
|
59155
|
-
[name: string]: unknown;
|
|
59156
|
-
};
|
|
59157
|
-
content: {
|
|
59158
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59159
|
-
};
|
|
59160
|
-
};
|
|
59161
|
-
/** @description Returned if the caller isn't an app. */
|
|
59162
|
-
403: {
|
|
59163
|
-
headers: {
|
|
59164
|
-
[name: string]: unknown;
|
|
59165
|
-
};
|
|
59166
|
-
content: {
|
|
59167
|
-
"application/json": components["schemas"]["ErrorCollection"];
|
|
59168
|
-
};
|
|
59169
|
-
};
|
|
59170
|
-
};
|
|
59171
|
-
};
|
|
59172
|
-
getAllWorkflows: {
|
|
58994
|
+
registerDynamicWebhooks: {
|
|
59173
58995
|
parameters: {
|
|
59174
|
-
query?:
|
|
59175
|
-
/** @description The name of the workflow to be returned. Only one workflow can be specified. */
|
|
59176
|
-
workflowName?: string;
|
|
59177
|
-
};
|
|
58996
|
+
query?: never;
|
|
59178
58997
|
header?: never;
|
|
59179
58998
|
path?: never;
|
|
59180
58999
|
cookie?: never;
|
|
59181
59000
|
};
|
|
59182
|
-
requestBody
|
|
59001
|
+
requestBody: {
|
|
59002
|
+
content: {
|
|
59003
|
+
/**
|
|
59004
|
+
* @example {
|
|
59005
|
+
* "url": "https://your-app.example.com/webhook-received",
|
|
59006
|
+
* "webhooks": [
|
|
59007
|
+
* {
|
|
59008
|
+
* "events": [
|
|
59009
|
+
* "jira:issue_created",
|
|
59010
|
+
* "jira:issue_updated"
|
|
59011
|
+
* ],
|
|
59012
|
+
* "fieldIdsFilter": [
|
|
59013
|
+
* "summary",
|
|
59014
|
+
* "customfield_10029"
|
|
59015
|
+
* ],
|
|
59016
|
+
* "jqlFilter": "project = PROJ"
|
|
59017
|
+
* },
|
|
59018
|
+
* {
|
|
59019
|
+
* "events": [
|
|
59020
|
+
* "jira:issue_deleted"
|
|
59021
|
+
* ],
|
|
59022
|
+
* "jqlFilter": "project IN (PROJ, EXP) AND status = done"
|
|
59023
|
+
* },
|
|
59024
|
+
* {
|
|
59025
|
+
* "events": [
|
|
59026
|
+
* "issue_property_set"
|
|
59027
|
+
* ],
|
|
59028
|
+
* "issuePropertyKeysFilter": [
|
|
59029
|
+
* "my-issue-property-key"
|
|
59030
|
+
* ],
|
|
59031
|
+
* "jqlFilter": "project = PROJ"
|
|
59032
|
+
* }
|
|
59033
|
+
* ]
|
|
59034
|
+
* }
|
|
59035
|
+
*/
|
|
59036
|
+
"application/json": components["schemas"]["WebhookRegistrationDetails"];
|
|
59037
|
+
};
|
|
59038
|
+
};
|
|
59183
59039
|
responses: {
|
|
59184
59040
|
/** @description Returned if the request is successful. */
|
|
59185
59041
|
200: {
|
|
@@ -59187,177 +59043,171 @@ export interface operations {
|
|
|
59187
59043
|
[name: string]: unknown;
|
|
59188
59044
|
};
|
|
59189
59045
|
content: {
|
|
59190
|
-
/** @example [{"
|
|
59191
|
-
"application/json": components["schemas"]["
|
|
59046
|
+
/** @example {"webhookRegistrationResult":[{"createdWebhookId":1000},{"errors":["The clause watchCount is unsupported"]},{"createdWebhookId":1001}]} */
|
|
59047
|
+
"application/json": components["schemas"]["ContainerForRegisteredWebhooks"];
|
|
59192
59048
|
};
|
|
59193
59049
|
};
|
|
59194
|
-
/** @description Returned if the
|
|
59195
|
-
|
|
59050
|
+
/** @description Returned if the request is invalid. */
|
|
59051
|
+
400: {
|
|
59196
59052
|
headers: {
|
|
59197
59053
|
[name: string]: unknown;
|
|
59198
59054
|
};
|
|
59199
|
-
content
|
|
59055
|
+
content: {
|
|
59056
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59057
|
+
};
|
|
59058
|
+
};
|
|
59059
|
+
/** @description Returned if the caller isn't an app. */
|
|
59060
|
+
403: {
|
|
59061
|
+
headers: {
|
|
59062
|
+
[name: string]: unknown;
|
|
59063
|
+
};
|
|
59064
|
+
content: {
|
|
59065
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59066
|
+
};
|
|
59200
59067
|
};
|
|
59201
59068
|
};
|
|
59202
59069
|
};
|
|
59203
|
-
|
|
59070
|
+
deleteWebhookById: {
|
|
59204
59071
|
parameters: {
|
|
59205
59072
|
query?: never;
|
|
59206
59073
|
header?: never;
|
|
59207
59074
|
path?: never;
|
|
59208
59075
|
cookie?: never;
|
|
59209
59076
|
};
|
|
59210
|
-
/** @description The workflow details. */
|
|
59211
59077
|
requestBody: {
|
|
59212
59078
|
content: {
|
|
59213
59079
|
/**
|
|
59214
59080
|
* @example {
|
|
59215
|
-
* "
|
|
59216
|
-
*
|
|
59217
|
-
*
|
|
59218
|
-
*
|
|
59219
|
-
* "id": "1",
|
|
59220
|
-
* "properties": {
|
|
59221
|
-
* "jira.issue.editable": "false"
|
|
59222
|
-
* }
|
|
59223
|
-
* },
|
|
59224
|
-
* {
|
|
59225
|
-
* "id": "2"
|
|
59226
|
-
* },
|
|
59227
|
-
* {
|
|
59228
|
-
* "id": "3"
|
|
59229
|
-
* }
|
|
59230
|
-
* ],
|
|
59231
|
-
* "transitions": [
|
|
59232
|
-
* {
|
|
59233
|
-
* "from": [],
|
|
59234
|
-
* "name": "Created",
|
|
59235
|
-
* "to": "1",
|
|
59236
|
-
* "type": "initial"
|
|
59237
|
-
* },
|
|
59238
|
-
* {
|
|
59239
|
-
* "from": [
|
|
59240
|
-
* "1"
|
|
59241
|
-
* ],
|
|
59242
|
-
* "name": "In progress",
|
|
59243
|
-
* "properties": {
|
|
59244
|
-
* "custom-property": "custom-value"
|
|
59245
|
-
* },
|
|
59246
|
-
* "rules": {
|
|
59247
|
-
* "conditions": {
|
|
59248
|
-
* "conditions": [
|
|
59249
|
-
* {
|
|
59250
|
-
* "type": "RemoteOnlyCondition"
|
|
59251
|
-
* },
|
|
59252
|
-
* {
|
|
59253
|
-
* "configuration": {
|
|
59254
|
-
* "groups": [
|
|
59255
|
-
* "developers",
|
|
59256
|
-
* "qa-testers"
|
|
59257
|
-
* ]
|
|
59258
|
-
* },
|
|
59259
|
-
* "type": "UserInAnyGroupCondition"
|
|
59260
|
-
* }
|
|
59261
|
-
* ],
|
|
59262
|
-
* "operator": "AND"
|
|
59263
|
-
* },
|
|
59264
|
-
* "postFunctions": [
|
|
59265
|
-
* {
|
|
59266
|
-
* "type": "AssignToCurrentUserFunction"
|
|
59267
|
-
* }
|
|
59268
|
-
* ]
|
|
59269
|
-
* },
|
|
59270
|
-
* "screen": {
|
|
59271
|
-
* "id": "10001"
|
|
59272
|
-
* },
|
|
59273
|
-
* "to": "2",
|
|
59274
|
-
* "type": "directed"
|
|
59275
|
-
* },
|
|
59276
|
-
* {
|
|
59277
|
-
* "name": "Completed",
|
|
59278
|
-
* "rules": {
|
|
59279
|
-
* "postFunctions": [
|
|
59280
|
-
* {
|
|
59281
|
-
* "configuration": {
|
|
59282
|
-
* "fieldId": "assignee"
|
|
59283
|
-
* },
|
|
59284
|
-
* "type": "ClearFieldValuePostFunction"
|
|
59285
|
-
* }
|
|
59286
|
-
* ],
|
|
59287
|
-
* "validators": [
|
|
59288
|
-
* {
|
|
59289
|
-
* "configuration": {
|
|
59290
|
-
* "parentStatuses": [
|
|
59291
|
-
* {
|
|
59292
|
-
* "id": "3"
|
|
59293
|
-
* }
|
|
59294
|
-
* ]
|
|
59295
|
-
* },
|
|
59296
|
-
* "type": "ParentStatusValidator"
|
|
59297
|
-
* },
|
|
59298
|
-
* {
|
|
59299
|
-
* "configuration": {
|
|
59300
|
-
* "permissionKey": "ADMINISTER_PROJECTS"
|
|
59301
|
-
* },
|
|
59302
|
-
* "type": "PermissionValidator"
|
|
59303
|
-
* }
|
|
59304
|
-
* ]
|
|
59305
|
-
* },
|
|
59306
|
-
* "to": "3",
|
|
59307
|
-
* "type": "global"
|
|
59308
|
-
* }
|
|
59081
|
+
* "webhookIds": [
|
|
59082
|
+
* 10000,
|
|
59083
|
+
* 10001,
|
|
59084
|
+
* 10042
|
|
59309
59085
|
* ]
|
|
59310
59086
|
* }
|
|
59311
59087
|
*/
|
|
59312
|
-
"application/json": components["schemas"]["
|
|
59088
|
+
"application/json": components["schemas"]["ContainerForWebhookIDs"];
|
|
59313
59089
|
};
|
|
59314
59090
|
};
|
|
59315
59091
|
responses: {
|
|
59316
|
-
/** @description Returned if the
|
|
59317
|
-
|
|
59092
|
+
/** @description Returned if the request is successful. */
|
|
59093
|
+
202: {
|
|
59094
|
+
headers: {
|
|
59095
|
+
[name: string]: unknown;
|
|
59096
|
+
};
|
|
59097
|
+
content?: never;
|
|
59098
|
+
};
|
|
59099
|
+
/** @description Returned if the list of webhook IDs is missing. */
|
|
59100
|
+
400: {
|
|
59318
59101
|
headers: {
|
|
59319
59102
|
[name: string]: unknown;
|
|
59320
59103
|
};
|
|
59321
59104
|
content: {
|
|
59322
|
-
|
|
59323
|
-
"application/json": components["schemas"]["WorkflowIDs"];
|
|
59105
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59324
59106
|
};
|
|
59325
59107
|
};
|
|
59326
|
-
/** @description Returned if the
|
|
59327
|
-
|
|
59108
|
+
/** @description Returned if the caller isn't an app. */
|
|
59109
|
+
403: {
|
|
59328
59110
|
headers: {
|
|
59329
59111
|
[name: string]: unknown;
|
|
59330
59112
|
};
|
|
59331
59113
|
content: {
|
|
59332
|
-
|
|
59333
|
-
"application/json": unknown;
|
|
59114
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59334
59115
|
};
|
|
59335
59116
|
};
|
|
59336
|
-
|
|
59337
|
-
|
|
59117
|
+
};
|
|
59118
|
+
};
|
|
59119
|
+
getFailedWebhooks: {
|
|
59120
|
+
parameters: {
|
|
59121
|
+
query?: {
|
|
59122
|
+
/** @description The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page. */
|
|
59123
|
+
maxResults?: number;
|
|
59124
|
+
/** @description The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch. */
|
|
59125
|
+
after?: number;
|
|
59126
|
+
};
|
|
59127
|
+
header?: never;
|
|
59128
|
+
path?: never;
|
|
59129
|
+
cookie?: never;
|
|
59130
|
+
};
|
|
59131
|
+
requestBody?: never;
|
|
59132
|
+
responses: {
|
|
59133
|
+
/** @description Returned if the request is successful. */
|
|
59134
|
+
200: {
|
|
59338
59135
|
headers: {
|
|
59339
59136
|
[name: string]: unknown;
|
|
59340
59137
|
};
|
|
59341
|
-
content
|
|
59138
|
+
content: {
|
|
59139
|
+
/** @example {"values":[{"id":"1","body":"{\"data\":\"webhook data\"}","url":"https://example.com","failureTime":1573118132000},{"id":"2","url":"https://example.com","failureTime":1573540473480}],"maxResults":100,"next":"https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"} */
|
|
59140
|
+
"application/json": components["schemas"]["FailedWebhooks"];
|
|
59141
|
+
};
|
|
59342
59142
|
};
|
|
59343
|
-
/** @description
|
|
59143
|
+
/** @description 400 response */
|
|
59144
|
+
400: {
|
|
59145
|
+
headers: {
|
|
59146
|
+
[name: string]: unknown;
|
|
59147
|
+
};
|
|
59148
|
+
content: {
|
|
59149
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59150
|
+
};
|
|
59151
|
+
};
|
|
59152
|
+
/** @description Returned if the caller is not a Connect app. */
|
|
59344
59153
|
403: {
|
|
59345
59154
|
headers: {
|
|
59346
59155
|
[name: string]: unknown;
|
|
59347
59156
|
};
|
|
59348
59157
|
content: {
|
|
59349
|
-
|
|
59350
|
-
"application/json": unknown;
|
|
59158
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59351
59159
|
};
|
|
59352
59160
|
};
|
|
59353
|
-
|
|
59354
|
-
|
|
59161
|
+
};
|
|
59162
|
+
};
|
|
59163
|
+
refreshWebhooks: {
|
|
59164
|
+
parameters: {
|
|
59165
|
+
query?: never;
|
|
59166
|
+
header?: never;
|
|
59167
|
+
path?: never;
|
|
59168
|
+
cookie?: never;
|
|
59169
|
+
};
|
|
59170
|
+
requestBody: {
|
|
59171
|
+
content: {
|
|
59172
|
+
/**
|
|
59173
|
+
* @example {
|
|
59174
|
+
* "webhookIds": [
|
|
59175
|
+
* 10000,
|
|
59176
|
+
* 10001,
|
|
59177
|
+
* 10042
|
|
59178
|
+
* ]
|
|
59179
|
+
* }
|
|
59180
|
+
*/
|
|
59181
|
+
"application/json": components["schemas"]["ContainerForWebhookIDs"];
|
|
59182
|
+
};
|
|
59183
|
+
};
|
|
59184
|
+
responses: {
|
|
59185
|
+
/** @description Returned if the request is successful. */
|
|
59186
|
+
200: {
|
|
59355
59187
|
headers: {
|
|
59356
59188
|
[name: string]: unknown;
|
|
59357
59189
|
};
|
|
59358
59190
|
content: {
|
|
59359
|
-
/** @example {"
|
|
59360
|
-
"application/json":
|
|
59191
|
+
/** @example {"expirationDate":"2019-06-01T12:42:30.000+0000"} */
|
|
59192
|
+
"application/json": components["schemas"]["WebhooksExpirationDate"];
|
|
59193
|
+
};
|
|
59194
|
+
};
|
|
59195
|
+
/** @description Returned if the request is invalid. */
|
|
59196
|
+
400: {
|
|
59197
|
+
headers: {
|
|
59198
|
+
[name: string]: unknown;
|
|
59199
|
+
};
|
|
59200
|
+
content: {
|
|
59201
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59202
|
+
};
|
|
59203
|
+
};
|
|
59204
|
+
/** @description Returned if the caller isn't an app. */
|
|
59205
|
+
403: {
|
|
59206
|
+
headers: {
|
|
59207
|
+
[name: string]: unknown;
|
|
59208
|
+
};
|
|
59209
|
+
content: {
|
|
59210
|
+
"application/json": components["schemas"]["ErrorCollection"];
|
|
59361
59211
|
};
|
|
59362
59212
|
};
|
|
59363
59213
|
};
|
|
@@ -59473,7 +59323,7 @@ export interface operations {
|
|
|
59473
59323
|
workflowNames?: string[];
|
|
59474
59324
|
/** @description The list of `tags` to filter by. */
|
|
59475
59325
|
withTags?: string[];
|
|
59476
|
-
/** @description Whether draft or published workflows are returned. If not provided, both workflow types are returned. */
|
|
59326
|
+
/** @description **Deprecated:** Whether draft or published workflows are returned. If not provided, both workflow types are returned. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147). */
|
|
59477
59327
|
draft?: boolean;
|
|
59478
59328
|
/** @description Use [expand](#expansion) to include additional information in the response. This parameter accepts `transition`, which, for each rule, returns information about the transition the rule is assigned to. */
|
|
59479
59329
|
expand?: string;
|
|
@@ -60185,65 +60035,62 @@ export interface operations {
|
|
|
60185
60035
|
};
|
|
60186
60036
|
};
|
|
60187
60037
|
};
|
|
60188
|
-
getWorkflowSchemeUsagesForWorkflow: {
|
|
60189
|
-
parameters: {
|
|
60190
|
-
query?: {
|
|
60191
|
-
/** @description The cursor for pagination */
|
|
60192
|
-
nextPageToken?: string;
|
|
60193
|
-
/** @description The maximum number of results to return. Must be an integer between 1 and 200. */
|
|
60194
|
-
maxResults?: number;
|
|
60195
|
-
};
|
|
60196
|
-
header?: never;
|
|
60197
|
-
path: {
|
|
60198
|
-
/** @description The workflow ID */
|
|
60199
|
-
workflowId: string;
|
|
60200
|
-
};
|
|
60201
|
-
cookie?: never;
|
|
60202
|
-
};
|
|
60203
|
-
requestBody?: never;
|
|
60204
|
-
responses: {
|
|
60205
|
-
/** @description Returned if the request is successful. */
|
|
60206
|
-
200: {
|
|
60207
|
-
headers: {
|
|
60208
|
-
[name: string]: unknown;
|
|
60209
|
-
};
|
|
60210
|
-
content: {
|
|
60211
|
-
/** @example {"workflowId":"fb759d53-a3a4-45ff-9de4-547c4b638dde","workflowSchemes":{"nextPageToken":"eyJvIjoyfQ==","values":[{"id":"1000"}]}} */
|
|
60212
|
-
"application/json": components["schemas"]["WorkflowSchemeUsageDTO"];
|
|
60213
|
-
};
|
|
60214
|
-
};
|
|
60215
|
-
/** @description Returned if the request is not valid. */
|
|
60216
|
-
400: {
|
|
60217
|
-
headers: {
|
|
60218
|
-
[name: string]: unknown;
|
|
60219
|
-
};
|
|
60220
|
-
content: {
|
|
60221
|
-
/** @example {"errorMessages":["Invalid format of nextPageToken"],"errors":{}} */
|
|
60222
|
-
"application/json": unknown;
|
|
60223
|
-
};
|
|
60224
|
-
};
|
|
60225
|
-
/** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
|
|
60226
|
-
401: {
|
|
60227
|
-
headers: {
|
|
60228
|
-
[name: string]: unknown;
|
|
60229
|
-
};
|
|
60230
|
-
content?: never;
|
|
60231
|
-
};
|
|
60232
|
-
/** @description Returned if the workflow with the given ID does not exist. */
|
|
60233
|
-
404: {
|
|
60234
|
-
headers: {
|
|
60235
|
-
[name: string]: unknown;
|
|
60236
|
-
};
|
|
60237
|
-
content?: never;
|
|
60238
|
-
};
|
|
60239
|
-
};
|
|
60240
|
-
};
|
|
60241
|
-
readWorkflows: {
|
|
60038
|
+
getWorkflowSchemeUsagesForWorkflow: {
|
|
60242
60039
|
parameters: {
|
|
60243
60040
|
query?: {
|
|
60244
|
-
/** @description
|
|
60245
|
-
|
|
60041
|
+
/** @description The cursor for pagination */
|
|
60042
|
+
nextPageToken?: string;
|
|
60043
|
+
/** @description The maximum number of results to return. Must be an integer between 1 and 200. */
|
|
60044
|
+
maxResults?: number;
|
|
60045
|
+
};
|
|
60046
|
+
header?: never;
|
|
60047
|
+
path: {
|
|
60048
|
+
/** @description The workflow ID */
|
|
60049
|
+
workflowId: string;
|
|
60050
|
+
};
|
|
60051
|
+
cookie?: never;
|
|
60052
|
+
};
|
|
60053
|
+
requestBody?: never;
|
|
60054
|
+
responses: {
|
|
60055
|
+
/** @description Returned if the request is successful. */
|
|
60056
|
+
200: {
|
|
60057
|
+
headers: {
|
|
60058
|
+
[name: string]: unknown;
|
|
60059
|
+
};
|
|
60060
|
+
content: {
|
|
60061
|
+
/** @example {"workflowId":"fb759d53-a3a4-45ff-9de4-547c4b638dde","workflowSchemes":{"nextPageToken":"eyJvIjoyfQ==","values":[{"id":"1000"}]}} */
|
|
60062
|
+
"application/json": components["schemas"]["WorkflowSchemeUsageDTO"];
|
|
60063
|
+
};
|
|
60064
|
+
};
|
|
60065
|
+
/** @description Returned if the request is not valid. */
|
|
60066
|
+
400: {
|
|
60067
|
+
headers: {
|
|
60068
|
+
[name: string]: unknown;
|
|
60069
|
+
};
|
|
60070
|
+
content: {
|
|
60071
|
+
/** @example {"errorMessages":["Invalid format of nextPageToken"],"errors":{}} */
|
|
60072
|
+
"application/json": unknown;
|
|
60073
|
+
};
|
|
60074
|
+
};
|
|
60075
|
+
/** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
|
|
60076
|
+
401: {
|
|
60077
|
+
headers: {
|
|
60078
|
+
[name: string]: unknown;
|
|
60079
|
+
};
|
|
60080
|
+
content?: never;
|
|
60246
60081
|
};
|
|
60082
|
+
/** @description Returned if the workflow with the given ID does not exist. */
|
|
60083
|
+
404: {
|
|
60084
|
+
headers: {
|
|
60085
|
+
[name: string]: unknown;
|
|
60086
|
+
};
|
|
60087
|
+
content?: never;
|
|
60088
|
+
};
|
|
60089
|
+
};
|
|
60090
|
+
};
|
|
60091
|
+
readWorkflows: {
|
|
60092
|
+
parameters: {
|
|
60093
|
+
query?: never;
|
|
60247
60094
|
header?: never;
|
|
60248
60095
|
path?: never;
|
|
60249
60096
|
cookie?: never;
|
|
@@ -60640,7 +60487,7 @@ export interface operations {
|
|
|
60640
60487
|
[name: string]: unknown;
|
|
60641
60488
|
};
|
|
60642
60489
|
content: {
|
|
60643
|
-
/** @example {"errors":[{"code":"NON_UNIQUE_STATUS_NAME","elementReference":{"statusReference":"1f0443ff-47e4-4306-9c26-0af696059a43"},"level":"ERROR","message":"You must use a unique status name.","type":"STATUS"}]} */
|
|
60490
|
+
/** @example {"errors":[{"additionalDetails":"Additional details about the error message.","code":"NON_UNIQUE_STATUS_NAME","elementReference":{"statusReference":"1f0443ff-47e4-4306-9c26-0af696059a43"},"level":"ERROR","message":"You must use a unique status name.","type":"STATUS"}]} */
|
|
60644
60491
|
"application/json": components["schemas"]["WorkflowValidationErrorList"];
|
|
60645
60492
|
};
|
|
60646
60493
|
};
|
|
@@ -60765,6 +60612,8 @@ export interface operations {
|
|
|
60765
60612
|
scope?: string;
|
|
60766
60613
|
/** @description Filters active and inactive workflows. */
|
|
60767
60614
|
isActive?: boolean;
|
|
60615
|
+
/** @description The ID of the project to filter the workflows by. Only workflows associated with the given project are returned. */
|
|
60616
|
+
projectId?: number;
|
|
60768
60617
|
};
|
|
60769
60618
|
header?: never;
|
|
60770
60619
|
path?: never;
|
|
@@ -61147,7 +60996,7 @@ export interface operations {
|
|
|
61147
60996
|
[name: string]: unknown;
|
|
61148
60997
|
};
|
|
61149
60998
|
content: {
|
|
61150
|
-
/** @example {"errors":[{"code":"NON_UNIQUE_STATUS_NAME","elementReference":{"statusReference":"1f0443ff-47e4-4306-9c26-0af696059a43"},"level":"ERROR","message":"You must use a unique status name.","type":"STATUS"}]} */
|
|
60999
|
+
/** @example {"errors":[{"additionalDetails":"Additional details about the error message.","code":"NON_UNIQUE_STATUS_NAME","elementReference":{"statusReference":"1f0443ff-47e4-4306-9c26-0af696059a43"},"level":"ERROR","message":"You must use a unique status name.","type":"STATUS"}]} */
|
|
61151
61000
|
"application/json": components["schemas"]["WorkflowValidationErrorList"];
|
|
61152
61001
|
};
|
|
61153
61002
|
};
|
|
@@ -61382,6 +61231,89 @@ export interface operations {
|
|
|
61382
61231
|
};
|
|
61383
61232
|
};
|
|
61384
61233
|
};
|
|
61234
|
+
switchWorkflowSchemeForProject: {
|
|
61235
|
+
parameters: {
|
|
61236
|
+
query?: never;
|
|
61237
|
+
header?: never;
|
|
61238
|
+
path?: never;
|
|
61239
|
+
cookie?: never;
|
|
61240
|
+
};
|
|
61241
|
+
/** @description The request containing project ID, target scheme ID, and any issue type mappings. */
|
|
61242
|
+
requestBody: {
|
|
61243
|
+
content: {
|
|
61244
|
+
/**
|
|
61245
|
+
* @example {
|
|
61246
|
+
* "mappingsByIssueTypeOverride": [
|
|
61247
|
+
* {
|
|
61248
|
+
* "issueTypeId": "10000",
|
|
61249
|
+
* "statusMappings": [
|
|
61250
|
+
* {
|
|
61251
|
+
* "newStatusId": "10003",
|
|
61252
|
+
* "oldStatusId": "3"
|
|
61253
|
+
* },
|
|
61254
|
+
* {
|
|
61255
|
+
* "newStatusId": "10009",
|
|
61256
|
+
* "oldStatusId": "10"
|
|
61257
|
+
* }
|
|
61258
|
+
* ]
|
|
61259
|
+
* },
|
|
61260
|
+
* {
|
|
61261
|
+
* "issueTypeId": "10011",
|
|
61262
|
+
* "statusMappings": [
|
|
61263
|
+
* {
|
|
61264
|
+
* "newStatusId": "10003",
|
|
61265
|
+
* "oldStatusId": "3"
|
|
61266
|
+
* },
|
|
61267
|
+
* {
|
|
61268
|
+
* "newStatusId": "10002",
|
|
61269
|
+
* "oldStatusId": "10003"
|
|
61270
|
+
* }
|
|
61271
|
+
* ]
|
|
61272
|
+
* }
|
|
61273
|
+
* ],
|
|
61274
|
+
* "projectId": "10001",
|
|
61275
|
+
* "targetSchemeId": "10002"
|
|
61276
|
+
* }
|
|
61277
|
+
*/
|
|
61278
|
+
"application/json": components["schemas"]["WorkflowSchemeProjectSwitchBean"];
|
|
61279
|
+
};
|
|
61280
|
+
};
|
|
61281
|
+
responses: {
|
|
61282
|
+
/** @description Returned if the request is successful and the task has been started. */
|
|
61283
|
+
303: {
|
|
61284
|
+
headers: {
|
|
61285
|
+
[name: string]: unknown;
|
|
61286
|
+
};
|
|
61287
|
+
content: {
|
|
61288
|
+
"application/json": components["schemas"]["TaskProgressBeanObject"];
|
|
61289
|
+
};
|
|
61290
|
+
};
|
|
61291
|
+
/** @description Returned if the request is invalid. */
|
|
61292
|
+
400: {
|
|
61293
|
+
headers: {
|
|
61294
|
+
[name: string]: unknown;
|
|
61295
|
+
};
|
|
61296
|
+
content?: never;
|
|
61297
|
+
};
|
|
61298
|
+
/** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
|
|
61299
|
+
401: {
|
|
61300
|
+
headers: {
|
|
61301
|
+
[name: string]: unknown;
|
|
61302
|
+
};
|
|
61303
|
+
content?: never;
|
|
61304
|
+
};
|
|
61305
|
+
/** @description Returned if a conflicting task is already running. */
|
|
61306
|
+
409: {
|
|
61307
|
+
headers: {
|
|
61308
|
+
[name: string]: unknown;
|
|
61309
|
+
};
|
|
61310
|
+
content: {
|
|
61311
|
+
/** @example {"errorMessages":["Another task is currently running, please try again later."],"errors":{"conflictingTaskId":"10000"}} */
|
|
61312
|
+
"application/json": unknown;
|
|
61313
|
+
};
|
|
61314
|
+
};
|
|
61315
|
+
};
|
|
61316
|
+
};
|
|
61385
61317
|
readWorkflowSchemes: {
|
|
61386
61318
|
parameters: {
|
|
61387
61319
|
query?: never;
|
|
@@ -63500,6 +63432,21 @@ export interface operations {
|
|
|
63500
63432
|
"application/json": components["schemas"]["OperationMessage"];
|
|
63501
63433
|
};
|
|
63502
63434
|
};
|
|
63435
|
+
/** @description Returned if the property key is reserved and read-only. */
|
|
63436
|
+
403: {
|
|
63437
|
+
headers: {
|
|
63438
|
+
[name: string]: unknown;
|
|
63439
|
+
};
|
|
63440
|
+
content: {
|
|
63441
|
+
/**
|
|
63442
|
+
* @example {
|
|
63443
|
+
* "message": "The property key is reserved and cannot be created or updated.",
|
|
63444
|
+
* "statusCode": 403
|
|
63445
|
+
* }
|
|
63446
|
+
*/
|
|
63447
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
63448
|
+
};
|
|
63449
|
+
};
|
|
63503
63450
|
};
|
|
63504
63451
|
};
|
|
63505
63452
|
"AddonPropertiesResource.deleteAddonProperty_delete": {
|
|
@@ -63553,6 +63500,21 @@ export interface operations {
|
|
|
63553
63500
|
"application/json": components["schemas"]["OperationMessage"];
|
|
63554
63501
|
};
|
|
63555
63502
|
};
|
|
63503
|
+
/** @description Returned if the property key is reserved and read-only. */
|
|
63504
|
+
403: {
|
|
63505
|
+
headers: {
|
|
63506
|
+
[name: string]: unknown;
|
|
63507
|
+
};
|
|
63508
|
+
content: {
|
|
63509
|
+
/**
|
|
63510
|
+
* @example {
|
|
63511
|
+
* "message": "The property key is reserved and cannot be deleted.",
|
|
63512
|
+
* "statusCode": 403
|
|
63513
|
+
* }
|
|
63514
|
+
*/
|
|
63515
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
63516
|
+
};
|
|
63517
|
+
};
|
|
63556
63518
|
/** @description Returned if the property is not found or doesn't belong to the app. */
|
|
63557
63519
|
404: {
|
|
63558
63520
|
headers: {
|
|
@@ -63924,6 +63886,145 @@ export interface operations {
|
|
|
63924
63886
|
};
|
|
63925
63887
|
};
|
|
63926
63888
|
};
|
|
63889
|
+
"ConnectToForgeMigrationFetchTaskResource.fetchMigrationTask_get": {
|
|
63890
|
+
parameters: {
|
|
63891
|
+
query?: never;
|
|
63892
|
+
header?: never;
|
|
63893
|
+
path: {
|
|
63894
|
+
/**
|
|
63895
|
+
* @description The key of the Connect app that contains the Jira issue field being migrated.
|
|
63896
|
+
* @example com.example.app
|
|
63897
|
+
*/
|
|
63898
|
+
connectKey: string;
|
|
63899
|
+
/**
|
|
63900
|
+
* @description The module key of the Connect issue field being migrated.
|
|
63901
|
+
* @example my-custom-field
|
|
63902
|
+
*/
|
|
63903
|
+
jiraIssueFieldsKey: string;
|
|
63904
|
+
};
|
|
63905
|
+
cookie?: never;
|
|
63906
|
+
};
|
|
63907
|
+
requestBody?: never;
|
|
63908
|
+
responses: {
|
|
63909
|
+
/** @description Returned if the request is successful and a migration task is found. */
|
|
63910
|
+
200: {
|
|
63911
|
+
headers: {
|
|
63912
|
+
[name: string]: unknown;
|
|
63913
|
+
};
|
|
63914
|
+
content: {
|
|
63915
|
+
"application/json": components["schemas"]["TaskProgress"];
|
|
63916
|
+
};
|
|
63917
|
+
};
|
|
63918
|
+
/** @description Returned if the authentication credentials are incorrect or missing. */
|
|
63919
|
+
401: {
|
|
63920
|
+
headers: {
|
|
63921
|
+
[name: string]: unknown;
|
|
63922
|
+
};
|
|
63923
|
+
content: {
|
|
63924
|
+
/**
|
|
63925
|
+
* @example {
|
|
63926
|
+
* "message": "Access to this resource must be authenticated as an app.",
|
|
63927
|
+
* "statusCode": 401
|
|
63928
|
+
* }
|
|
63929
|
+
*/
|
|
63930
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
63931
|
+
};
|
|
63932
|
+
};
|
|
63933
|
+
/**
|
|
63934
|
+
* @description Returned if:
|
|
63935
|
+
* * no migrated Forge module with the given key is found.
|
|
63936
|
+
* * no ongoing migration task exists for the custom field.
|
|
63937
|
+
*/
|
|
63938
|
+
404: {
|
|
63939
|
+
headers: {
|
|
63940
|
+
[name: string]: unknown;
|
|
63941
|
+
};
|
|
63942
|
+
content: {
|
|
63943
|
+
/**
|
|
63944
|
+
* @example {
|
|
63945
|
+
* "message": "No ongoing migration task for the custom field.",
|
|
63946
|
+
* "statusCode": 404
|
|
63947
|
+
* }
|
|
63948
|
+
*/
|
|
63949
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
63950
|
+
};
|
|
63951
|
+
};
|
|
63952
|
+
};
|
|
63953
|
+
};
|
|
63954
|
+
"ConnectToForgeMigrationTaskSubmissionResource.submitTask_post": {
|
|
63955
|
+
parameters: {
|
|
63956
|
+
query?: never;
|
|
63957
|
+
header?: never;
|
|
63958
|
+
path: {
|
|
63959
|
+
/**
|
|
63960
|
+
* @description The key of the Connect app that contains the Jira issue field being migrated.
|
|
63961
|
+
* @example com.example.app
|
|
63962
|
+
*/
|
|
63963
|
+
connectKey: string;
|
|
63964
|
+
/**
|
|
63965
|
+
* @description The module key of the Connect issue field being migrated.
|
|
63966
|
+
* @example my-custom-field
|
|
63967
|
+
*/
|
|
63968
|
+
jiraIssueFieldsKey: string;
|
|
63969
|
+
};
|
|
63970
|
+
cookie?: never;
|
|
63971
|
+
};
|
|
63972
|
+
requestBody?: never;
|
|
63973
|
+
responses: {
|
|
63974
|
+
/** @description Returned if the migration task was submitted successfully. */
|
|
63975
|
+
202: {
|
|
63976
|
+
headers: {
|
|
63977
|
+
[name: string]: unknown;
|
|
63978
|
+
};
|
|
63979
|
+
content?: never;
|
|
63980
|
+
};
|
|
63981
|
+
/** @description Returned if the authentication credentials are incorrect or missing. */
|
|
63982
|
+
401: {
|
|
63983
|
+
headers: {
|
|
63984
|
+
[name: string]: unknown;
|
|
63985
|
+
};
|
|
63986
|
+
content: {
|
|
63987
|
+
/**
|
|
63988
|
+
* @example {
|
|
63989
|
+
* "message": "Access to this resource must be authenticated as an app.",
|
|
63990
|
+
* "statusCode": 401
|
|
63991
|
+
* }
|
|
63992
|
+
*/
|
|
63993
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
63994
|
+
};
|
|
63995
|
+
};
|
|
63996
|
+
/** @description Returned if no migrated Forge module with the given key is found. */
|
|
63997
|
+
404: {
|
|
63998
|
+
headers: {
|
|
63999
|
+
[name: string]: unknown;
|
|
64000
|
+
};
|
|
64001
|
+
content: {
|
|
64002
|
+
/**
|
|
64003
|
+
* @example {
|
|
64004
|
+
* "message": "No migrated Forge module with given key is found.",
|
|
64005
|
+
* "statusCode": 404
|
|
64006
|
+
* }
|
|
64007
|
+
*/
|
|
64008
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
64009
|
+
};
|
|
64010
|
+
};
|
|
64011
|
+
/** @description Returned if a migration task is already in progress for the field. */
|
|
64012
|
+
409: {
|
|
64013
|
+
headers: {
|
|
64014
|
+
[name: string]: unknown;
|
|
64015
|
+
};
|
|
64016
|
+
content: {
|
|
64017
|
+
/**
|
|
64018
|
+
* @example {
|
|
64019
|
+
* "message": "Failed to trigger migration task because of already in progress task for the field.",
|
|
64020
|
+
* "statusCode": 409
|
|
64021
|
+
* }
|
|
64022
|
+
*/
|
|
64023
|
+
"application/json": components["schemas"]["OperationMessage"];
|
|
64024
|
+
};
|
|
64025
|
+
};
|
|
64026
|
+
};
|
|
64027
|
+
};
|
|
63927
64028
|
"ServiceRegistryResource.services_get": {
|
|
63928
64029
|
parameters: {
|
|
63929
64030
|
query: {
|