@resolution/jira-api-client 0.16.8 → 0.17.0
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/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +5 -5
- package/lib/openapi/platform/BaseJiraPlatformApiClient.js +1 -6
- package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
- package/lib/openapi/platform/models/fieldSchemes.d.ts +18 -0
- package/lib/openapi/platform/models/fieldSchemes.js +14 -3
- package/lib/openapi/platform/models/fieldSchemes.js.map +1 -1
- package/lib/openapi/platform/models/issueCustomFieldContexts.d.ts +22 -0
- package/lib/openapi/platform/models/issueCustomFieldContexts.js +11 -0
- package/lib/openapi/platform/models/issueCustomFieldContexts.js.map +1 -1
- package/lib/openapi/platform/models/issueSearch.d.ts +36 -0
- package/lib/openapi/platform/models/issueSearch.js +13 -1
- package/lib/openapi/platform/models/issueSearch.js.map +1 -1
- package/lib/openapi/platform/models/projectTemplates.d.ts +23 -1
- package/lib/openapi/platform/models/projectTemplates.js +4 -0
- package/lib/openapi/platform/models/projectTemplates.js.map +1 -1
- package/lib/openapi/platform/models/projects.d.ts +1 -1
- package/lib/openapi/platform/models/projects.js +1 -1
- package/lib/openapi/platform/models/projects.js.map +1 -1
- package/lib/openapi/platform/models/workflowTransitionRules.d.ts +6 -2
- package/lib/openapi/platform/models/workflowTransitionRules.js +1 -1
- package/lib/openapi/platform/models/workflowTransitionRules.js.map +1 -1
- package/lib/openapi/platform/models/workflows.d.ts +3 -231
- package/lib/openapi/platform/models/workflows.js +1 -60
- package/lib/openapi/platform/models/workflows.js.map +1 -1
- package/lib/openapi/platform/services/FieldSchemesService.d.ts +13 -3
- package/lib/openapi/platform/services/FieldSchemesService.js +9 -2
- package/lib/openapi/platform/services/FieldSchemesService.js.map +1 -1
- package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +6 -1
- package/lib/openapi/platform/services/GroupAndUserPickerService.js +3 -2
- package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
- package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +12 -0
- package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +12 -0
- package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
- package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +24 -2
- package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +6 -4
- package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
- package/lib/openapi/platform/services/IssueFieldsService.d.ts +2 -0
- package/lib/openapi/platform/services/IssueFieldsService.js +2 -0
- package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
- package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +18 -11
- package/lib/openapi/platform/services/IssuePrioritiesService.js +18 -11
- package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
- package/lib/openapi/platform/services/IssuesService.d.ts +5 -0
- package/lib/openapi/platform/services/IssuesService.js +5 -0
- package/lib/openapi/platform/services/IssuesService.js.map +1 -1
- package/lib/openapi/platform/services/PrioritySchemesService.d.ts +10 -5
- package/lib/openapi/platform/services/PrioritySchemesService.js +10 -5
- package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
- package/lib/openapi/platform/services/ProjectTemplatesService.d.ts +3 -0
- package/lib/openapi/platform/services/ProjectTemplatesService.js +3 -0
- package/lib/openapi/platform/services/ProjectTemplatesService.js.map +1 -1
- package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +2 -1
- package/lib/openapi/platform/services/ScreenTabFieldsService.js +4 -1
- package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
- package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +12 -2
- package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +8 -0
- package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
- package/lib/openapi/platform/services/WorkflowsService.d.ts +26 -1028
- package/lib/openapi/platform/services/WorkflowsService.js +25 -953
- package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +4 -4
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +1 -1
- package/lib/openapi/serviceManagement/models/request.d.ts +46 -10
- package/lib/openapi/serviceManagement/models/request.js +20 -0
- package/lib/openapi/serviceManagement/models/request.js.map +1 -1
- package/lib/openapi/serviceManagement/models/servicedesk.d.ts +7 -0
- package/lib/openapi/serviceManagement/models/servicedesk.js +4 -0
- package/lib/openapi/serviceManagement/models/servicedesk.js.map +1 -1
- package/lib/openapi/serviceManagement/services/RequestService.d.ts +12 -4
- package/lib/openapi/serviceManagement/services/RequestService.js +12 -4
- package/lib/openapi/serviceManagement/services/RequestService.js.map +1 -1
- package/lib/openapi/serviceManagement/services/ServicedeskService.d.ts +59 -1
- package/lib/openapi/serviceManagement/services/ServicedeskService.js +64 -0
- package/lib/openapi/serviceManagement/services/ServicedeskService.js.map +1 -1
- package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +3 -3
- package/lib/openapi/software/BaseJiraSoftwareApiClient.js +11 -1
- package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
- package/lib/openapi/software/models/board.d.ts +5 -0
- package/lib/openapi/software/models/board.js +3 -0
- package/lib/openapi/software/models/board.js.map +1 -1
- package/lib/openapi/software/models/common.d.ts +28 -0
- package/lib/openapi/software/models/common.js +9 -0
- package/lib/openapi/software/models/common.js.map +1 -1
- package/lib/openapi/software/services/BoardService.d.ts +1596 -240
- package/lib/openapi/software/services/BoardService.js +1526 -220
- package/lib/openapi/software/services/BoardService.js.map +1 -1
- package/lib/openapi/software/services/EpicService.d.ts +524 -1
- package/lib/openapi/software/services/EpicService.js +496 -0
- package/lib/openapi/software/services/EpicService.js.map +1 -1
- package/lib/openapi/software/services/SprintService.d.ts +257 -1
- package/lib/openapi/software/services/SprintService.js +242 -0
- package/lib/openapi/software/services/SprintService.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
|
-
import { type Board, type BoardCreateBean, type SearchResults, type BoardConfigBean, type FeatureResponseBean, type FeatureToggleRequestBean, type PartialSuccessBean, type ProjectDetails, type PageBeanQuickFilterBean, type QuickFilterBean, type ReportsResponseBean, type BoardFilterBean } from "../models/board";
|
|
3
|
-
import { type IssueRankRequestBean, type SprintBean } from "../models/common";
|
|
2
|
+
import { type Board, type BoardCreateBean, type SearchResults, type BoardConfigBean, type FeatureResponseBean, type FeatureToggleRequestBean, type PartialSuccessBean, type ProjectDetails, type PageBeanQuickFilterBean, type QuickFilterBean, type ReportsResponseBean, type BoardFilterBean, type IssueCountBean } from "../models/board";
|
|
3
|
+
import { type IssueRankRequestBean, type SprintBean, type SoftwareIssueResults } from "../models/common";
|
|
4
4
|
/**
|
|
5
5
|
* Apis related to boards
|
|
6
6
|
*
|
|
@@ -373,6 +373,66 @@ export declare class BoardService extends CommonHttpService {
|
|
|
373
373
|
*/
|
|
374
374
|
released?: string | undefined;
|
|
375
375
|
}) => Promise<unknown>;
|
|
376
|
+
/**
|
|
377
|
+
* Returns the approximate count of all issues from the board's backlog, for the
|
|
378
|
+
* given board ID. This is equivalent to counting the issues on all pages returned
|
|
379
|
+
* by [Get issues for backlog
|
|
380
|
+
* enhanced](https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-software-1-0-board-boardid-backlog-get).
|
|
381
|
+
* Recent updates might not be immediately visible in the returned output. This
|
|
382
|
+
* only includes issues that the user has permission to view.
|
|
383
|
+
*
|
|
384
|
+
* @returns Returns the requested issue count.
|
|
385
|
+
*
|
|
386
|
+
* example:
|
|
387
|
+
* ```
|
|
388
|
+
* {
|
|
389
|
+
* "count": 153
|
|
390
|
+
* }
|
|
391
|
+
* ```
|
|
392
|
+
* @path GET `/rest/software/1.0/board/{boardId}/backlog/approximate-count`
|
|
393
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-backlog-approximate-count-get
|
|
394
|
+
* @param params
|
|
395
|
+
*/
|
|
396
|
+
getApproximateIssueCountForBacklog: ({ boardId, jql }: {
|
|
397
|
+
/** The ID of the board that has the backlog containing the requested issues. */
|
|
398
|
+
boardId: number;
|
|
399
|
+
/**
|
|
400
|
+
* Filters results using a JQL query. Note that `username` and `userkey` can't be
|
|
401
|
+
* used as search terms for this parameter due to privacy reasons. Use `accountId`
|
|
402
|
+
* instead.
|
|
403
|
+
*/
|
|
404
|
+
jql?: string | undefined;
|
|
405
|
+
}) => Promise<IssueCountBean>;
|
|
406
|
+
/**
|
|
407
|
+
* Returns the approximate count of all issues from a board, for a given board ID.
|
|
408
|
+
* This is equivalent to counting the issues on all pages returned by [Get issues
|
|
409
|
+
* for board
|
|
410
|
+
* enhanced](https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-software-1-0-board-boardid-issue-get).
|
|
411
|
+
* Recent updates might not be immediately visible in the returned output. This
|
|
412
|
+
* only includes issues that the user has permission to view.
|
|
413
|
+
*
|
|
414
|
+
* @returns Returns the requested issue count.
|
|
415
|
+
*
|
|
416
|
+
* example:
|
|
417
|
+
* ```
|
|
418
|
+
* {
|
|
419
|
+
* "count": 153
|
|
420
|
+
* }
|
|
421
|
+
* ```
|
|
422
|
+
* @path GET `/rest/software/1.0/board/{boardId}/issue/approximate-count`
|
|
423
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-issue-approximate-count-get
|
|
424
|
+
* @param params
|
|
425
|
+
*/
|
|
426
|
+
getApproximateIssueCountForBoard: ({ boardId, jql }: {
|
|
427
|
+
/** The ID of the board that contains the requested issues. */
|
|
428
|
+
boardId: number;
|
|
429
|
+
/**
|
|
430
|
+
* Filters results using a JQL query. Note that `username` and `userkey` can't be
|
|
431
|
+
* used as search terms for this parameter due to privacy reasons. Use `accountId`
|
|
432
|
+
* instead.
|
|
433
|
+
*/
|
|
434
|
+
jql?: string | undefined;
|
|
435
|
+
}) => Promise<IssueCountBean>;
|
|
376
436
|
/**
|
|
377
437
|
* Returns the board for the given board ID. This board will only be returned if
|
|
378
438
|
* the user has permission to view it. Admins without the view permission will see
|
|
@@ -457,6 +517,7 @@ export declare class BoardService extends CommonHttpService {
|
|
|
457
517
|
* closedSprints, flagged, and epic. By default, the returned issues are ordered
|
|
458
518
|
* by rank.
|
|
459
519
|
*
|
|
520
|
+
* @deprecated
|
|
460
521
|
* @returns Returns the requested issues, at the specified page of the results.
|
|
461
522
|
*
|
|
462
523
|
* example:
|
|
@@ -662,12 +723,272 @@ export declare class BoardService extends CommonHttpService {
|
|
|
662
723
|
/** A comma-separated list of the parameters to expand. */
|
|
663
724
|
expand?: string | undefined;
|
|
664
725
|
}) => Promise<unknown>;
|
|
726
|
+
/**
|
|
727
|
+
* Returns all issues that belong to an epic on the board, for the given epic ID
|
|
728
|
+
* and the board ID. Result pagination is token based, using `nextPageToken` and
|
|
729
|
+
* `maxResults`. This only includes issues that the user has permission to view.
|
|
730
|
+
* Note, if the user does not have permission to view the board, no issues will be
|
|
731
|
+
* returned at all. Issues returned from this resource include Software project
|
|
732
|
+
* fields, like sprint, closedSprints, flagged, and epic. By default, the returned
|
|
733
|
+
* issues are ordered by rank.
|
|
734
|
+
*
|
|
735
|
+
* @returns Returns the requested issues, at the specified page of the results.
|
|
736
|
+
*
|
|
737
|
+
* example:
|
|
738
|
+
* ```
|
|
739
|
+
* {
|
|
740
|
+
* "expand": "names,schema",
|
|
741
|
+
* "isLast": true,
|
|
742
|
+
* "issues": [
|
|
743
|
+
* {
|
|
744
|
+
* "expand": "",
|
|
745
|
+
* "fields": {
|
|
746
|
+
* "watcher": {
|
|
747
|
+
* "isWatching": false,
|
|
748
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
|
|
749
|
+
* "watchCount": 1
|
|
750
|
+
* },
|
|
751
|
+
* "attachment": [
|
|
752
|
+
* {
|
|
753
|
+
* "author": {
|
|
754
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
755
|
+
* "accountType": "atlassian",
|
|
756
|
+
* "active": false,
|
|
757
|
+
* "avatarUrls": {
|
|
758
|
+
* "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
759
|
+
* "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
760
|
+
* "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
761
|
+
* "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
762
|
+
* },
|
|
763
|
+
* "displayName": "Mia Krystof",
|
|
764
|
+
* "key": "",
|
|
765
|
+
* "name": "",
|
|
766
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
767
|
+
* },
|
|
768
|
+
* "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
|
|
769
|
+
* "created": "2023-06-24T19:24:50.000+0000",
|
|
770
|
+
* "filename": "debuglog.txt",
|
|
771
|
+
* "id": 10001,
|
|
772
|
+
* "mimeType": "text/plain",
|
|
773
|
+
* "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
|
|
774
|
+
* "size": 2460
|
|
775
|
+
* }
|
|
776
|
+
* ],
|
|
777
|
+
* "sub-tasks": [
|
|
778
|
+
* {
|
|
779
|
+
* "id": "10000",
|
|
780
|
+
* "outwardIssue": {
|
|
781
|
+
* "fields": {
|
|
782
|
+
* "status": {
|
|
783
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
784
|
+
* "name": "Open"
|
|
785
|
+
* }
|
|
786
|
+
* },
|
|
787
|
+
* "id": "10003",
|
|
788
|
+
* "key": "ED-2",
|
|
789
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
|
|
790
|
+
* },
|
|
791
|
+
* "type": {
|
|
792
|
+
* "id": "10000",
|
|
793
|
+
* "inward": "Parent",
|
|
794
|
+
* "name": "",
|
|
795
|
+
* "outward": "Sub-task"
|
|
796
|
+
* }
|
|
797
|
+
* }
|
|
798
|
+
* ],
|
|
799
|
+
* "description": "Main order flow broken",
|
|
800
|
+
* "project": {
|
|
801
|
+
* "avatarUrls": {
|
|
802
|
+
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
803
|
+
* "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
|
|
804
|
+
* "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
|
|
805
|
+
* "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
|
|
806
|
+
* },
|
|
807
|
+
* "id": "10000",
|
|
808
|
+
* "insight": {
|
|
809
|
+
* "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
|
|
810
|
+
* "totalIssueCount": 100
|
|
811
|
+
* },
|
|
812
|
+
* "key": "EX",
|
|
813
|
+
* "name": "Example",
|
|
814
|
+
* "projectCategory": {
|
|
815
|
+
* "description": "First Project Category",
|
|
816
|
+
* "id": "10000",
|
|
817
|
+
* "name": "FIRST",
|
|
818
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
|
|
819
|
+
* },
|
|
820
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
|
|
821
|
+
* "simplified": false,
|
|
822
|
+
* "style": "classic"
|
|
823
|
+
* },
|
|
824
|
+
* "comment": [
|
|
825
|
+
* {
|
|
826
|
+
* "author": {
|
|
827
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
828
|
+
* "active": false,
|
|
829
|
+
* "displayName": "Mia Krystof",
|
|
830
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
831
|
+
* },
|
|
832
|
+
* "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
|
|
833
|
+
* "created": "2021-01-17T12:34:00.000+0000",
|
|
834
|
+
* "id": "10000",
|
|
835
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
836
|
+
* "updateAuthor": {
|
|
837
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
838
|
+
* "active": false,
|
|
839
|
+
* "displayName": "Mia Krystof",
|
|
840
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
841
|
+
* },
|
|
842
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
843
|
+
* "visibility": {
|
|
844
|
+
* "identifier": "Administrators",
|
|
845
|
+
* "type": "role",
|
|
846
|
+
* "value": "Administrators"
|
|
847
|
+
* }
|
|
848
|
+
* }
|
|
849
|
+
* ],
|
|
850
|
+
* "issuelinks": [
|
|
851
|
+
* {
|
|
852
|
+
* "id": "10001",
|
|
853
|
+
* "outwardIssue": {
|
|
854
|
+
* "fields": {
|
|
855
|
+
* "status": {
|
|
856
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
857
|
+
* "name": "Open"
|
|
858
|
+
* }
|
|
859
|
+
* },
|
|
860
|
+
* "id": "10004L",
|
|
861
|
+
* "key": "PR-2",
|
|
862
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
|
|
863
|
+
* },
|
|
864
|
+
* "type": {
|
|
865
|
+
* "id": "10000",
|
|
866
|
+
* "inward": "depends on",
|
|
867
|
+
* "name": "Dependent",
|
|
868
|
+
* "outward": "is depended by"
|
|
869
|
+
* }
|
|
870
|
+
* },
|
|
871
|
+
* {
|
|
872
|
+
* "id": "10002",
|
|
873
|
+
* "inwardIssue": {
|
|
874
|
+
* "fields": {
|
|
875
|
+
* "status": {
|
|
876
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
877
|
+
* "name": "Open"
|
|
878
|
+
* }
|
|
879
|
+
* },
|
|
880
|
+
* "id": "10004",
|
|
881
|
+
* "key": "PR-3",
|
|
882
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
|
|
883
|
+
* },
|
|
884
|
+
* "type": {
|
|
885
|
+
* "id": "10000",
|
|
886
|
+
* "inward": "depends on",
|
|
887
|
+
* "name": "Dependent",
|
|
888
|
+
* "outward": "is depended by"
|
|
889
|
+
* }
|
|
890
|
+
* }
|
|
891
|
+
* ],
|
|
892
|
+
* "worklog": [
|
|
893
|
+
* {
|
|
894
|
+
* "author": {
|
|
895
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
896
|
+
* "active": false,
|
|
897
|
+
* "displayName": "Mia Krystof",
|
|
898
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
899
|
+
* },
|
|
900
|
+
* "comment": "I did some work here.",
|
|
901
|
+
* "id": "100028",
|
|
902
|
+
* "issueId": "10002",
|
|
903
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
904
|
+
* "started": "2021-01-17T12:34:00.000+0000",
|
|
905
|
+
* "timeSpent": "3h 20m",
|
|
906
|
+
* "timeSpentSeconds": 12000,
|
|
907
|
+
* "updateAuthor": {
|
|
908
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
909
|
+
* "active": false,
|
|
910
|
+
* "displayName": "Mia Krystof",
|
|
911
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
912
|
+
* },
|
|
913
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
914
|
+
* "visibility": {
|
|
915
|
+
* "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
|
|
916
|
+
* "type": "group",
|
|
917
|
+
* "value": "jira-developers"
|
|
918
|
+
* }
|
|
919
|
+
* }
|
|
920
|
+
* ],
|
|
921
|
+
* "updated": 1,
|
|
922
|
+
* "timetracking": {
|
|
923
|
+
* "originalEstimate": "10m",
|
|
924
|
+
* "originalEstimateSeconds": 600,
|
|
925
|
+
* "remainingEstimate": "3m",
|
|
926
|
+
* "remainingEstimateSeconds": 200,
|
|
927
|
+
* "timeSpent": "6m",
|
|
928
|
+
* "timeSpentSeconds": 400
|
|
929
|
+
* }
|
|
930
|
+
* },
|
|
931
|
+
* "id": "10002",
|
|
932
|
+
* "key": "ED-1",
|
|
933
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
|
|
934
|
+
* }
|
|
935
|
+
* ]
|
|
936
|
+
* }
|
|
937
|
+
* ```
|
|
938
|
+
* @path GET `/rest/software/1.0/board/{boardId}/epic/{epicId}/issue`
|
|
939
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-epic-epicid-issue-get
|
|
940
|
+
* @param params
|
|
941
|
+
*/
|
|
942
|
+
getBoardIssuesForEpicJsis: ({ boardId, epicId, nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }: {
|
|
943
|
+
/** The ID of the board that contains the requested issues. */
|
|
944
|
+
boardId: number;
|
|
945
|
+
/** The ID of the epic that contains the requested issues. */
|
|
946
|
+
epicId: number;
|
|
947
|
+
/**
|
|
948
|
+
* The token for a page to fetch that is not the first page. The first page has a
|
|
949
|
+
* `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
|
|
950
|
+
* issues.
|
|
951
|
+
*
|
|
952
|
+
* Note: The `nextPageToken` field is **not included** in the response for the
|
|
953
|
+
* last page, indicating there is no next page.
|
|
954
|
+
*/
|
|
955
|
+
nextPageToken?: string | undefined;
|
|
956
|
+
/**
|
|
957
|
+
* The maximum number of items to return per page. To manage page size, the API
|
|
958
|
+
* may return fewer items per page where there is a large number of fields or
|
|
959
|
+
* properties returned. It returns max 5000 issues.
|
|
960
|
+
*/
|
|
961
|
+
maxResults?: number | undefined;
|
|
962
|
+
/**
|
|
963
|
+
* Strong consistency issue IDs to be reconciled with search results. Accepts max
|
|
964
|
+
* 50 IDs. This list of IDs should be consistent with each paginated request
|
|
965
|
+
* across different pages.
|
|
966
|
+
*/
|
|
967
|
+
reconcileIssues?: number[] | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
970
|
+
* will override the default order of the returned issues.
|
|
971
|
+
* Note that `username` and `userkey` can't be used as search terms for this
|
|
972
|
+
* parameter due to privacy reasons. Use `accountId` instead.
|
|
973
|
+
*/
|
|
974
|
+
jql?: string | undefined;
|
|
975
|
+
/** Specifies whether to validate the JQL query or not. Default: true. */
|
|
976
|
+
validateQuery?: boolean | undefined;
|
|
977
|
+
/**
|
|
978
|
+
* The list of fields to return for each issue. By default, all navigable and
|
|
979
|
+
* Software project fields are returned.
|
|
980
|
+
*/
|
|
981
|
+
fields?: {}[] | undefined;
|
|
982
|
+
/** A comma-separated list of the parameters to expand. */
|
|
983
|
+
expand?: string | undefined;
|
|
984
|
+
}) => Promise<SoftwareIssueResults>;
|
|
665
985
|
/**
|
|
666
986
|
* Get all issues you have access to that belong to the sprint from the board.
|
|
667
987
|
* Issue returned from this resource contains additional fields like: sprint,
|
|
668
988
|
* closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order
|
|
669
989
|
* has higher priority than default rank.
|
|
670
990
|
*
|
|
991
|
+
* @deprecated
|
|
671
992
|
* @returns Returns the requested issues, at the specified page of the results.
|
|
672
993
|
*
|
|
673
994
|
* example:
|
|
@@ -875,74 +1196,333 @@ export declare class BoardService extends CommonHttpService {
|
|
|
875
1196
|
expand?: string | undefined;
|
|
876
1197
|
}) => Promise<unknown>;
|
|
877
1198
|
/**
|
|
878
|
-
*
|
|
879
|
-
*
|
|
880
|
-
*
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
-
*
|
|
884
|
-
*
|
|
885
|
-
* @param params
|
|
886
|
-
*/
|
|
887
|
-
getBoardProperty: ({ boardId, propertyKey }: {
|
|
888
|
-
/** the ID of the board from which the property will be returned. */
|
|
889
|
-
boardId: string;
|
|
890
|
-
/** the key of the property to return. */
|
|
891
|
-
propertyKey: string;
|
|
892
|
-
}) => Promise<unknown>;
|
|
893
|
-
/**
|
|
894
|
-
* Returns the keys of all properties for the board identified by the id. The user
|
|
895
|
-
* who retrieves the property keys is required to have permissions to view the
|
|
896
|
-
* board.
|
|
897
|
-
*
|
|
898
|
-
* @returns Returned if the board with given id exists.
|
|
899
|
-
* @path GET `/rest/agile/1.0/board/{boardId}/properties`
|
|
900
|
-
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get
|
|
901
|
-
* @param params
|
|
902
|
-
*/
|
|
903
|
-
getBoardPropertyKeys: ({ boardId }: {
|
|
904
|
-
/** the ID of the board from which property keys will be returned. */
|
|
905
|
-
boardId: string;
|
|
906
|
-
}) => Promise<unknown>;
|
|
907
|
-
/**
|
|
908
|
-
* Get the board configuration. The response contains the following fields:
|
|
909
|
-
*
|
|
910
|
-
* * `id` \- ID of the board.
|
|
911
|
-
* * `name` \- Name of the board.
|
|
912
|
-
* * `filter` \- Reference to the filter used by the given board.
|
|
913
|
-
* * `location` \- Reference to the container that the board is located in.
|
|
914
|
-
* Includes the container type (Valid values: project, user).
|
|
915
|
-
* * `subQuery` (Kanban only) - JQL subquery used by the given board.
|
|
916
|
-
* * `columnConfig` \- The column configuration lists the columns for the board,
|
|
917
|
-
* in the order defined in the column configuration. For each column, it shows the
|
|
918
|
-
* issue status mapping as well as the constraint type (Valid values: none,
|
|
919
|
-
* issueCount, issueCountExclSubs) for the min/max number of issues. Note, the
|
|
920
|
-
* last column with statuses mapped to it is treated as the "Done" column, which
|
|
921
|
-
* means that issues in that column will be marked as already completed.
|
|
922
|
-
* * `estimation` (Scrum only) - Contains information about type of estimation
|
|
923
|
-
* used for the board. Valid values: none, issueCount, field. If the estimation
|
|
924
|
-
* type is "field", the ID and display name of the field used for estimation is
|
|
925
|
-
* also returned. Note, estimates for an issue can be updated by a PUT
|
|
926
|
-
* /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the
|
|
927
|
-
* screen. "timeoriginalestimate" field will never be on the screen, so in order
|
|
928
|
-
* to update it "originalEstimate" in "timetracking" field should be updated.
|
|
929
|
-
* * `ranking` \- Contains information about custom field used for ranking in
|
|
930
|
-
* the given board.
|
|
1199
|
+
* Get all issues you have access to that belong to the sprint from the board.
|
|
1200
|
+
* Result pagination is token-based, using `nextPageToken` and `maxResults`. This
|
|
1201
|
+
* only includes issues that the user has permission to view. Note, if the user
|
|
1202
|
+
* does not have permission to view the board, no issues will be returned at all.
|
|
1203
|
+
* Issues returned from this resource contains additional fields like: sprint,
|
|
1204
|
+
* closedSprints, flagged, and epic. Issues are returned ordered by rank. JQL
|
|
1205
|
+
* order has higher priority than default rank.
|
|
931
1206
|
*
|
|
932
|
-
* @returns Returns the
|
|
1207
|
+
* @returns Returns the requested issues, at the specified page of the results.
|
|
933
1208
|
*
|
|
934
1209
|
* example:
|
|
935
1210
|
* ```
|
|
936
1211
|
* {
|
|
937
|
-
* "
|
|
938
|
-
*
|
|
939
|
-
*
|
|
940
|
-
*
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
*
|
|
944
|
-
*
|
|
945
|
-
*
|
|
1212
|
+
* "expand": "names,schema",
|
|
1213
|
+
* "isLast": true,
|
|
1214
|
+
* "issues": [
|
|
1215
|
+
* {
|
|
1216
|
+
* "expand": "",
|
|
1217
|
+
* "fields": {
|
|
1218
|
+
* "watcher": {
|
|
1219
|
+
* "isWatching": false,
|
|
1220
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
|
|
1221
|
+
* "watchCount": 1
|
|
1222
|
+
* },
|
|
1223
|
+
* "attachment": [
|
|
1224
|
+
* {
|
|
1225
|
+
* "author": {
|
|
1226
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1227
|
+
* "accountType": "atlassian",
|
|
1228
|
+
* "active": false,
|
|
1229
|
+
* "avatarUrls": {
|
|
1230
|
+
* "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
1231
|
+
* "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
1232
|
+
* "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
1233
|
+
* "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
1234
|
+
* },
|
|
1235
|
+
* "displayName": "Mia Krystof",
|
|
1236
|
+
* "key": "",
|
|
1237
|
+
* "name": "",
|
|
1238
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1239
|
+
* },
|
|
1240
|
+
* "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
|
|
1241
|
+
* "created": "2023-06-24T19:24:50.000+0000",
|
|
1242
|
+
* "filename": "debuglog.txt",
|
|
1243
|
+
* "id": 10001,
|
|
1244
|
+
* "mimeType": "text/plain",
|
|
1245
|
+
* "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
|
|
1246
|
+
* "size": 2460
|
|
1247
|
+
* }
|
|
1248
|
+
* ],
|
|
1249
|
+
* "sub-tasks": [
|
|
1250
|
+
* {
|
|
1251
|
+
* "id": "10000",
|
|
1252
|
+
* "outwardIssue": {
|
|
1253
|
+
* "fields": {
|
|
1254
|
+
* "status": {
|
|
1255
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
1256
|
+
* "name": "Open"
|
|
1257
|
+
* }
|
|
1258
|
+
* },
|
|
1259
|
+
* "id": "10003",
|
|
1260
|
+
* "key": "ED-2",
|
|
1261
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
|
|
1262
|
+
* },
|
|
1263
|
+
* "type": {
|
|
1264
|
+
* "id": "10000",
|
|
1265
|
+
* "inward": "Parent",
|
|
1266
|
+
* "name": "",
|
|
1267
|
+
* "outward": "Sub-task"
|
|
1268
|
+
* }
|
|
1269
|
+
* }
|
|
1270
|
+
* ],
|
|
1271
|
+
* "description": "Main order flow broken",
|
|
1272
|
+
* "project": {
|
|
1273
|
+
* "avatarUrls": {
|
|
1274
|
+
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
1275
|
+
* "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
|
|
1276
|
+
* "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
|
|
1277
|
+
* "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
|
|
1278
|
+
* },
|
|
1279
|
+
* "id": "10000",
|
|
1280
|
+
* "insight": {
|
|
1281
|
+
* "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
|
|
1282
|
+
* "totalIssueCount": 100
|
|
1283
|
+
* },
|
|
1284
|
+
* "key": "EX",
|
|
1285
|
+
* "name": "Example",
|
|
1286
|
+
* "projectCategory": {
|
|
1287
|
+
* "description": "First Project Category",
|
|
1288
|
+
* "id": "10000",
|
|
1289
|
+
* "name": "FIRST",
|
|
1290
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
|
|
1291
|
+
* },
|
|
1292
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
|
|
1293
|
+
* "simplified": false,
|
|
1294
|
+
* "style": "classic"
|
|
1295
|
+
* },
|
|
1296
|
+
* "comment": [
|
|
1297
|
+
* {
|
|
1298
|
+
* "author": {
|
|
1299
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1300
|
+
* "active": false,
|
|
1301
|
+
* "displayName": "Mia Krystof",
|
|
1302
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1303
|
+
* },
|
|
1304
|
+
* "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
|
|
1305
|
+
* "created": "2021-01-17T12:34:00.000+0000",
|
|
1306
|
+
* "id": "10000",
|
|
1307
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
1308
|
+
* "updateAuthor": {
|
|
1309
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1310
|
+
* "active": false,
|
|
1311
|
+
* "displayName": "Mia Krystof",
|
|
1312
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1313
|
+
* },
|
|
1314
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
1315
|
+
* "visibility": {
|
|
1316
|
+
* "identifier": "Administrators",
|
|
1317
|
+
* "type": "role",
|
|
1318
|
+
* "value": "Administrators"
|
|
1319
|
+
* }
|
|
1320
|
+
* }
|
|
1321
|
+
* ],
|
|
1322
|
+
* "issuelinks": [
|
|
1323
|
+
* {
|
|
1324
|
+
* "id": "10001",
|
|
1325
|
+
* "outwardIssue": {
|
|
1326
|
+
* "fields": {
|
|
1327
|
+
* "status": {
|
|
1328
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
1329
|
+
* "name": "Open"
|
|
1330
|
+
* }
|
|
1331
|
+
* },
|
|
1332
|
+
* "id": "10004L",
|
|
1333
|
+
* "key": "PR-2",
|
|
1334
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
|
|
1335
|
+
* },
|
|
1336
|
+
* "type": {
|
|
1337
|
+
* "id": "10000",
|
|
1338
|
+
* "inward": "depends on",
|
|
1339
|
+
* "name": "Dependent",
|
|
1340
|
+
* "outward": "is depended by"
|
|
1341
|
+
* }
|
|
1342
|
+
* },
|
|
1343
|
+
* {
|
|
1344
|
+
* "id": "10002",
|
|
1345
|
+
* "inwardIssue": {
|
|
1346
|
+
* "fields": {
|
|
1347
|
+
* "status": {
|
|
1348
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
1349
|
+
* "name": "Open"
|
|
1350
|
+
* }
|
|
1351
|
+
* },
|
|
1352
|
+
* "id": "10004",
|
|
1353
|
+
* "key": "PR-3",
|
|
1354
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
|
|
1355
|
+
* },
|
|
1356
|
+
* "type": {
|
|
1357
|
+
* "id": "10000",
|
|
1358
|
+
* "inward": "depends on",
|
|
1359
|
+
* "name": "Dependent",
|
|
1360
|
+
* "outward": "is depended by"
|
|
1361
|
+
* }
|
|
1362
|
+
* }
|
|
1363
|
+
* ],
|
|
1364
|
+
* "worklog": [
|
|
1365
|
+
* {
|
|
1366
|
+
* "author": {
|
|
1367
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1368
|
+
* "active": false,
|
|
1369
|
+
* "displayName": "Mia Krystof",
|
|
1370
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1371
|
+
* },
|
|
1372
|
+
* "comment": "I did some work here.",
|
|
1373
|
+
* "id": "100028",
|
|
1374
|
+
* "issueId": "10002",
|
|
1375
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
1376
|
+
* "started": "2021-01-17T12:34:00.000+0000",
|
|
1377
|
+
* "timeSpent": "3h 20m",
|
|
1378
|
+
* "timeSpentSeconds": 12000,
|
|
1379
|
+
* "updateAuthor": {
|
|
1380
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1381
|
+
* "active": false,
|
|
1382
|
+
* "displayName": "Mia Krystof",
|
|
1383
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1384
|
+
* },
|
|
1385
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
1386
|
+
* "visibility": {
|
|
1387
|
+
* "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
|
|
1388
|
+
* "type": "group",
|
|
1389
|
+
* "value": "jira-developers"
|
|
1390
|
+
* }
|
|
1391
|
+
* }
|
|
1392
|
+
* ],
|
|
1393
|
+
* "updated": 1,
|
|
1394
|
+
* "timetracking": {
|
|
1395
|
+
* "originalEstimate": "10m",
|
|
1396
|
+
* "originalEstimateSeconds": 600,
|
|
1397
|
+
* "remainingEstimate": "3m",
|
|
1398
|
+
* "remainingEstimateSeconds": 200,
|
|
1399
|
+
* "timeSpent": "6m",
|
|
1400
|
+
* "timeSpentSeconds": 400
|
|
1401
|
+
* }
|
|
1402
|
+
* },
|
|
1403
|
+
* "id": "10002",
|
|
1404
|
+
* "key": "ED-1",
|
|
1405
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
|
|
1406
|
+
* }
|
|
1407
|
+
* ]
|
|
1408
|
+
* }
|
|
1409
|
+
* ```
|
|
1410
|
+
* @path GET `/rest/software/1.0/board/{boardId}/sprint/{sprintId}/issue`
|
|
1411
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-sprint-sprintid-issue-get
|
|
1412
|
+
* @param params
|
|
1413
|
+
*/
|
|
1414
|
+
getBoardIssuesForSprintJsis: ({ boardId, sprintId, nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }: {
|
|
1415
|
+
/** The ID of the board that contains the requested issues. */
|
|
1416
|
+
boardId: number;
|
|
1417
|
+
/** The ID of the sprint that contains the requested issues. */
|
|
1418
|
+
sprintId: number;
|
|
1419
|
+
/**
|
|
1420
|
+
* The token for a page to fetch that is not the first page. The first page has a
|
|
1421
|
+
* `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
|
|
1422
|
+
* issues.
|
|
1423
|
+
*
|
|
1424
|
+
* Note: The `nextPageToken` field is **not included** in the response for the
|
|
1425
|
+
* last page, indicating there is no next page.
|
|
1426
|
+
*/
|
|
1427
|
+
nextPageToken?: string | undefined;
|
|
1428
|
+
/**
|
|
1429
|
+
* The maximum number of items to return per page. To manage page size, the API
|
|
1430
|
+
* may return fewer items per page where there is a large number of fields or
|
|
1431
|
+
* properties returned. It returns max 5000 issues.
|
|
1432
|
+
*/
|
|
1433
|
+
maxResults?: number | undefined;
|
|
1434
|
+
/**
|
|
1435
|
+
* Strong consistency issue IDs to be reconciled with search results. Accepts max
|
|
1436
|
+
* 50 IDs. This list of IDs should be consistent with each paginated request
|
|
1437
|
+
* across different pages.
|
|
1438
|
+
*/
|
|
1439
|
+
reconcileIssues?: number[] | undefined;
|
|
1440
|
+
/**
|
|
1441
|
+
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
1442
|
+
* will override the default order of the returned issues.
|
|
1443
|
+
* Note that `username` and `userkey` can't be used as search terms for this
|
|
1444
|
+
* parameter due to privacy reasons. Use `accountId` instead.
|
|
1445
|
+
*/
|
|
1446
|
+
jql?: string | undefined;
|
|
1447
|
+
/** Specifies whether to validate the JQL query or not. Default: true. */
|
|
1448
|
+
validateQuery?: boolean | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* The list of fields to return for each issue. By default, all navigable and
|
|
1451
|
+
* Software project fields are returned.
|
|
1452
|
+
*/
|
|
1453
|
+
fields?: {}[] | undefined;
|
|
1454
|
+
/** A comma-separated list of the parameters to expand. */
|
|
1455
|
+
expand?: string | undefined;
|
|
1456
|
+
}) => Promise<SoftwareIssueResults>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Returns the value of the property with a given key from the board identified by
|
|
1459
|
+
* the provided id. The user who retrieves the property is required to have
|
|
1460
|
+
* permissions to view the board.
|
|
1461
|
+
*
|
|
1462
|
+
* @returns Returned if the board exists and the property was found.
|
|
1463
|
+
* @path GET `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
|
|
1464
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-get
|
|
1465
|
+
* @param params
|
|
1466
|
+
*/
|
|
1467
|
+
getBoardProperty: ({ boardId, propertyKey }: {
|
|
1468
|
+
/** the ID of the board from which the property will be returned. */
|
|
1469
|
+
boardId: string;
|
|
1470
|
+
/** the key of the property to return. */
|
|
1471
|
+
propertyKey: string;
|
|
1472
|
+
}) => Promise<unknown>;
|
|
1473
|
+
/**
|
|
1474
|
+
* Returns the keys of all properties for the board identified by the id. The user
|
|
1475
|
+
* who retrieves the property keys is required to have permissions to view the
|
|
1476
|
+
* board.
|
|
1477
|
+
*
|
|
1478
|
+
* @returns Returned if the board with given id exists.
|
|
1479
|
+
* @path GET `/rest/agile/1.0/board/{boardId}/properties`
|
|
1480
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get
|
|
1481
|
+
* @param params
|
|
1482
|
+
*/
|
|
1483
|
+
getBoardPropertyKeys: ({ boardId }: {
|
|
1484
|
+
/** the ID of the board from which property keys will be returned. */
|
|
1485
|
+
boardId: string;
|
|
1486
|
+
}) => Promise<unknown>;
|
|
1487
|
+
/**
|
|
1488
|
+
* Get the board configuration. The response contains the following fields:
|
|
1489
|
+
*
|
|
1490
|
+
* * `id` \- ID of the board.
|
|
1491
|
+
* * `name` \- Name of the board.
|
|
1492
|
+
* * `filter` \- Reference to the filter used by the given board.
|
|
1493
|
+
* * `location` \- Reference to the container that the board is located in.
|
|
1494
|
+
* Includes the container type (Valid values: project, user).
|
|
1495
|
+
* * `subQuery` (Kanban only) - JQL subquery used by the given board.
|
|
1496
|
+
* * `columnConfig` \- The column configuration lists the columns for the board,
|
|
1497
|
+
* in the order defined in the column configuration. For each column, it shows the
|
|
1498
|
+
* issue status mapping as well as the constraint type (Valid values: none,
|
|
1499
|
+
* issueCount, issueCountExclSubs) for the min/max number of issues. Note, the
|
|
1500
|
+
* last column with statuses mapped to it is treated as the "Done" column, which
|
|
1501
|
+
* means that issues in that column will be marked as already completed.
|
|
1502
|
+
* * `estimation` (Scrum only) - Contains information about type of estimation
|
|
1503
|
+
* used for the board. Valid values: none, issueCount, field. If the estimation
|
|
1504
|
+
* type is "field", the ID and display name of the field used for estimation is
|
|
1505
|
+
* also returned. Note, estimates for an issue can be updated by a PUT
|
|
1506
|
+
* /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the
|
|
1507
|
+
* screen. "timeoriginalestimate" field will never be on the screen, so in order
|
|
1508
|
+
* to update it "originalEstimate" in "timetracking" field should be updated.
|
|
1509
|
+
* * `ranking` \- Contains information about custom field used for ranking in
|
|
1510
|
+
* the given board.
|
|
1511
|
+
*
|
|
1512
|
+
* @returns Returns the configuration of the board for given boardId.
|
|
1513
|
+
*
|
|
1514
|
+
* example:
|
|
1515
|
+
* ```
|
|
1516
|
+
* {
|
|
1517
|
+
* "columnConfig": {
|
|
1518
|
+
* "columns": [
|
|
1519
|
+
* {
|
|
1520
|
+
* "name": "To Do",
|
|
1521
|
+
* "statuses": [
|
|
1522
|
+
* {
|
|
1523
|
+
* "id": "1",
|
|
1524
|
+
* "self": "https://your-domain.atlassian.net/status/1"
|
|
1525
|
+
* },
|
|
946
1526
|
* {
|
|
947
1527
|
* "id": "4",
|
|
948
1528
|
* "self": "https://your-domain.atlassian.net/status/4"
|
|
@@ -1077,13 +1657,701 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1077
1657
|
boardId: number;
|
|
1078
1658
|
}) => Promise<FeatureResponseBean>;
|
|
1079
1659
|
/**
|
|
1080
|
-
* Returns all issues from the board's backlog, for the given board ID. This only
|
|
1081
|
-
* includes issues that the user has permission to view. The backlog contains
|
|
1082
|
-
* incomplete issues that are not assigned to any future or active sprint. Note,
|
|
1083
|
-
* if the user does not have permission to view the board, no issues will be
|
|
1084
|
-
* returned at all. Issues returned from this resource include Agile fields, like
|
|
1085
|
-
* sprint, closedSprints, flagged, and epic. By default, the returned issues are
|
|
1086
|
-
* ordered by rank.
|
|
1660
|
+
* Returns all issues from the board's backlog, for the given board ID. This only
|
|
1661
|
+
* includes issues that the user has permission to view. The backlog contains
|
|
1662
|
+
* incomplete issues that are not assigned to any future or active sprint. Note,
|
|
1663
|
+
* if the user does not have permission to view the board, no issues will be
|
|
1664
|
+
* returned at all. Issues returned from this resource include Agile fields, like
|
|
1665
|
+
* sprint, closedSprints, flagged, and epic. By default, the returned issues are
|
|
1666
|
+
* ordered by rank.
|
|
1667
|
+
*
|
|
1668
|
+
* @deprecated
|
|
1669
|
+
* @returns Returns the requested issues, at the specified page of the results.
|
|
1670
|
+
*
|
|
1671
|
+
* example:
|
|
1672
|
+
* ```
|
|
1673
|
+
* {
|
|
1674
|
+
* "expand": "names,schema",
|
|
1675
|
+
* "issues": [
|
|
1676
|
+
* {
|
|
1677
|
+
* "expand": "",
|
|
1678
|
+
* "fields": {
|
|
1679
|
+
* "flagged": true,
|
|
1680
|
+
* "sprint": {
|
|
1681
|
+
* "id": 37,
|
|
1682
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
|
|
1683
|
+
* "state": "future",
|
|
1684
|
+
* "name": "sprint 2",
|
|
1685
|
+
* "goal": "sprint 2 goal"
|
|
1686
|
+
* },
|
|
1687
|
+
* "closedSprints": [
|
|
1688
|
+
* {
|
|
1689
|
+
* "id": 37,
|
|
1690
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
|
|
1691
|
+
* "state": "closed",
|
|
1692
|
+
* "name": "sprint 1",
|
|
1693
|
+
* "startDate": "2015-04-11T15:22:00.000+10:00",
|
|
1694
|
+
* "endDate": "2015-04-20T01:22:00.000+10:00",
|
|
1695
|
+
* "completeDate": "2015-04-20T11:04:00.000+10:00",
|
|
1696
|
+
* "goal": "sprint 1 goal"
|
|
1697
|
+
* }
|
|
1698
|
+
* ],
|
|
1699
|
+
* "description": "example bug report",
|
|
1700
|
+
* "project": {
|
|
1701
|
+
* "avatarUrls": {
|
|
1702
|
+
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
1703
|
+
* "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
|
|
1704
|
+
* "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
|
|
1705
|
+
* "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
|
|
1706
|
+
* },
|
|
1707
|
+
* "id": "10000",
|
|
1708
|
+
* "insight": {
|
|
1709
|
+
* "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
|
|
1710
|
+
* "totalIssueCount": 100
|
|
1711
|
+
* },
|
|
1712
|
+
* "key": "EX",
|
|
1713
|
+
* "name": "Example",
|
|
1714
|
+
* "projectCategory": {
|
|
1715
|
+
* "description": "First Project Category",
|
|
1716
|
+
* "id": "10000",
|
|
1717
|
+
* "name": "FIRST",
|
|
1718
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
|
|
1719
|
+
* },
|
|
1720
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
|
|
1721
|
+
* "simplified": false,
|
|
1722
|
+
* "style": "classic"
|
|
1723
|
+
* },
|
|
1724
|
+
* "comment": [
|
|
1725
|
+
* {
|
|
1726
|
+
* "author": {
|
|
1727
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1728
|
+
* "active": false,
|
|
1729
|
+
* "displayName": "Mia Krystof",
|
|
1730
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1731
|
+
* },
|
|
1732
|
+
* "body": {
|
|
1733
|
+
* "type": "doc",
|
|
1734
|
+
* "version": 1,
|
|
1735
|
+
* "content": [
|
|
1736
|
+
* {
|
|
1737
|
+
* "type": "paragraph",
|
|
1738
|
+
* "content": [
|
|
1739
|
+
* {
|
|
1740
|
+
* "type": "text",
|
|
1741
|
+
* "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
|
|
1742
|
+
* }
|
|
1743
|
+
* ]
|
|
1744
|
+
* }
|
|
1745
|
+
* ]
|
|
1746
|
+
* },
|
|
1747
|
+
* "created": "2021-01-17T12:34:00.000+0000",
|
|
1748
|
+
* "id": "10000",
|
|
1749
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
1750
|
+
* "updateAuthor": {
|
|
1751
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1752
|
+
* "active": false,
|
|
1753
|
+
* "displayName": "Mia Krystof",
|
|
1754
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1755
|
+
* },
|
|
1756
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
1757
|
+
* "visibility": {
|
|
1758
|
+
* "identifier": "Administrators",
|
|
1759
|
+
* "type": "role",
|
|
1760
|
+
* "value": "Administrators"
|
|
1761
|
+
* }
|
|
1762
|
+
* }
|
|
1763
|
+
* ],
|
|
1764
|
+
* "epic": {
|
|
1765
|
+
* "id": 37,
|
|
1766
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
|
|
1767
|
+
* "name": "epic 1",
|
|
1768
|
+
* "summary": "epic 1 summary",
|
|
1769
|
+
* "color": {
|
|
1770
|
+
* "key": "color_4"
|
|
1771
|
+
* },
|
|
1772
|
+
* "done": true
|
|
1773
|
+
* },
|
|
1774
|
+
* "worklog": [
|
|
1775
|
+
* {
|
|
1776
|
+
* "author": {
|
|
1777
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1778
|
+
* "active": false,
|
|
1779
|
+
* "displayName": "Mia Krystof",
|
|
1780
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1781
|
+
* },
|
|
1782
|
+
* "comment": {
|
|
1783
|
+
* "type": "doc",
|
|
1784
|
+
* "version": 1,
|
|
1785
|
+
* "content": [
|
|
1786
|
+
* {
|
|
1787
|
+
* "type": "paragraph",
|
|
1788
|
+
* "content": [
|
|
1789
|
+
* {
|
|
1790
|
+
* "type": "text",
|
|
1791
|
+
* "text": "I did some work here."
|
|
1792
|
+
* }
|
|
1793
|
+
* ]
|
|
1794
|
+
* }
|
|
1795
|
+
* ]
|
|
1796
|
+
* },
|
|
1797
|
+
* "id": "100028",
|
|
1798
|
+
* "issueId": "10002",
|
|
1799
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
1800
|
+
* "started": "2021-01-17T12:34:00.000+0000",
|
|
1801
|
+
* "timeSpent": "3h 20m",
|
|
1802
|
+
* "timeSpentSeconds": 12000,
|
|
1803
|
+
* "updateAuthor": {
|
|
1804
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1805
|
+
* "active": false,
|
|
1806
|
+
* "displayName": "Mia Krystof",
|
|
1807
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1808
|
+
* },
|
|
1809
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
1810
|
+
* "visibility": {
|
|
1811
|
+
* "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
|
|
1812
|
+
* "type": "group",
|
|
1813
|
+
* "value": "jira-developers"
|
|
1814
|
+
* }
|
|
1815
|
+
* }
|
|
1816
|
+
* ],
|
|
1817
|
+
* "updated": 1,
|
|
1818
|
+
* "timetracking": {
|
|
1819
|
+
* "originalEstimate": "10m",
|
|
1820
|
+
* "originalEstimateSeconds": 600,
|
|
1821
|
+
* "remainingEstimate": "3m",
|
|
1822
|
+
* "remainingEstimateSeconds": 200,
|
|
1823
|
+
* "timeSpent": "6m",
|
|
1824
|
+
* "timeSpentSeconds": 400
|
|
1825
|
+
* }
|
|
1826
|
+
* },
|
|
1827
|
+
* "id": "10001",
|
|
1828
|
+
* "key": "HSP-1",
|
|
1829
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
|
|
1830
|
+
* }
|
|
1831
|
+
* ],
|
|
1832
|
+
* "maxResults": 50,
|
|
1833
|
+
* "startAt": 0,
|
|
1834
|
+
* "total": 1
|
|
1835
|
+
* }
|
|
1836
|
+
* ```
|
|
1837
|
+
* @path GET `/rest/agile/1.0/board/{boardId}/backlog`
|
|
1838
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-backlog-get
|
|
1839
|
+
* @param params
|
|
1840
|
+
*/
|
|
1841
|
+
getIssuesForBacklog: ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand }: {
|
|
1842
|
+
/** The ID of the board that has the backlog containing the requested issues. */
|
|
1843
|
+
boardId: number;
|
|
1844
|
+
/**
|
|
1845
|
+
* The starting index of the returned issues. Base index: 0. See the 'Pagination'
|
|
1846
|
+
* section at the top of this page for more details.
|
|
1847
|
+
*/
|
|
1848
|
+
startAt?: number | undefined;
|
|
1849
|
+
/**
|
|
1850
|
+
* The maximum number of issues to return per page. Default: 50. See the
|
|
1851
|
+
* 'Pagination' section at the top of this page for more details. Note, the total
|
|
1852
|
+
* number of issues returned is limited by the property
|
|
1853
|
+
* 'jira.search.views.default.max' in your Jira instance. If you exceed this
|
|
1854
|
+
* limit, your results will be truncated.
|
|
1855
|
+
*/
|
|
1856
|
+
maxResults?: number | undefined;
|
|
1857
|
+
/**
|
|
1858
|
+
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
1859
|
+
* will override the default order of the returned issues.
|
|
1860
|
+
* Note that `username` and `userkey` can't be used as search terms for this
|
|
1861
|
+
* parameter due to privacy reasons. Use `accountId` instead.
|
|
1862
|
+
*/
|
|
1863
|
+
jql?: string | undefined;
|
|
1864
|
+
/** Specifies whether to validate the JQL query or not. Default: true. */
|
|
1865
|
+
validateQuery?: boolean | undefined;
|
|
1866
|
+
/**
|
|
1867
|
+
* The list of fields to return for each issue. By default, all navigable and
|
|
1868
|
+
* Agile fields are returned.
|
|
1869
|
+
*/
|
|
1870
|
+
fields?: {}[] | undefined;
|
|
1871
|
+
/** This parameter is currently not used. */
|
|
1872
|
+
expand?: string | undefined;
|
|
1873
|
+
}) => Promise<SearchResults>;
|
|
1874
|
+
/**
|
|
1875
|
+
* Returns all issues from the board's backlog, for the given board ID. Result
|
|
1876
|
+
* pagination is token based, using `nextPageToken` and `maxResults`. This only
|
|
1877
|
+
* includes issues that the user has permission to view. Note, if the user does
|
|
1878
|
+
* not have permission to view the board, no issues will be returned at all. The
|
|
1879
|
+
* backlog contains incomplete issues that are not assigned to any future or
|
|
1880
|
+
* active sprint. Issues returned from this resource include Software project
|
|
1881
|
+
* fields, like sprint, closedSprints, flagged, and epic. By default, the returned
|
|
1882
|
+
* issues are ordered by rank.
|
|
1883
|
+
*
|
|
1884
|
+
* @returns Returns the requested issues, at the specified page of the results.
|
|
1885
|
+
*
|
|
1886
|
+
* example:
|
|
1887
|
+
* ```
|
|
1888
|
+
* {
|
|
1889
|
+
* "expand": "names,schema",
|
|
1890
|
+
* "isLast": true,
|
|
1891
|
+
* "issues": [
|
|
1892
|
+
* {
|
|
1893
|
+
* "expand": "",
|
|
1894
|
+
* "fields": {
|
|
1895
|
+
* "watcher": {
|
|
1896
|
+
* "isWatching": false,
|
|
1897
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
|
|
1898
|
+
* "watchCount": 1
|
|
1899
|
+
* },
|
|
1900
|
+
* "attachment": [
|
|
1901
|
+
* {
|
|
1902
|
+
* "author": {
|
|
1903
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1904
|
+
* "accountType": "atlassian",
|
|
1905
|
+
* "active": false,
|
|
1906
|
+
* "avatarUrls": {
|
|
1907
|
+
* "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
1908
|
+
* "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
1909
|
+
* "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
1910
|
+
* "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
1911
|
+
* },
|
|
1912
|
+
* "displayName": "Mia Krystof",
|
|
1913
|
+
* "key": "",
|
|
1914
|
+
* "name": "",
|
|
1915
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1916
|
+
* },
|
|
1917
|
+
* "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
|
|
1918
|
+
* "created": "2023-06-24T19:24:50.000+0000",
|
|
1919
|
+
* "filename": "debuglog.txt",
|
|
1920
|
+
* "id": 10001,
|
|
1921
|
+
* "mimeType": "text/plain",
|
|
1922
|
+
* "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
|
|
1923
|
+
* "size": 2460
|
|
1924
|
+
* }
|
|
1925
|
+
* ],
|
|
1926
|
+
* "sub-tasks": [
|
|
1927
|
+
* {
|
|
1928
|
+
* "id": "10000",
|
|
1929
|
+
* "outwardIssue": {
|
|
1930
|
+
* "fields": {
|
|
1931
|
+
* "status": {
|
|
1932
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
1933
|
+
* "name": "Open"
|
|
1934
|
+
* }
|
|
1935
|
+
* },
|
|
1936
|
+
* "id": "10003",
|
|
1937
|
+
* "key": "ED-2",
|
|
1938
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
|
|
1939
|
+
* },
|
|
1940
|
+
* "type": {
|
|
1941
|
+
* "id": "10000",
|
|
1942
|
+
* "inward": "Parent",
|
|
1943
|
+
* "name": "",
|
|
1944
|
+
* "outward": "Sub-task"
|
|
1945
|
+
* }
|
|
1946
|
+
* }
|
|
1947
|
+
* ],
|
|
1948
|
+
* "description": "Main order flow broken",
|
|
1949
|
+
* "project": {
|
|
1950
|
+
* "avatarUrls": {
|
|
1951
|
+
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
1952
|
+
* "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
|
|
1953
|
+
* "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
|
|
1954
|
+
* "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
|
|
1955
|
+
* },
|
|
1956
|
+
* "id": "10000",
|
|
1957
|
+
* "insight": {
|
|
1958
|
+
* "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
|
|
1959
|
+
* "totalIssueCount": 100
|
|
1960
|
+
* },
|
|
1961
|
+
* "key": "EX",
|
|
1962
|
+
* "name": "Example",
|
|
1963
|
+
* "projectCategory": {
|
|
1964
|
+
* "description": "First Project Category",
|
|
1965
|
+
* "id": "10000",
|
|
1966
|
+
* "name": "FIRST",
|
|
1967
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
|
|
1968
|
+
* },
|
|
1969
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
|
|
1970
|
+
* "simplified": false,
|
|
1971
|
+
* "style": "classic"
|
|
1972
|
+
* },
|
|
1973
|
+
* "comment": [
|
|
1974
|
+
* {
|
|
1975
|
+
* "author": {
|
|
1976
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1977
|
+
* "active": false,
|
|
1978
|
+
* "displayName": "Mia Krystof",
|
|
1979
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1980
|
+
* },
|
|
1981
|
+
* "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
|
|
1982
|
+
* "created": "2021-01-17T12:34:00.000+0000",
|
|
1983
|
+
* "id": "10000",
|
|
1984
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
1985
|
+
* "updateAuthor": {
|
|
1986
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1987
|
+
* "active": false,
|
|
1988
|
+
* "displayName": "Mia Krystof",
|
|
1989
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1990
|
+
* },
|
|
1991
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
1992
|
+
* "visibility": {
|
|
1993
|
+
* "identifier": "Administrators",
|
|
1994
|
+
* "type": "role",
|
|
1995
|
+
* "value": "Administrators"
|
|
1996
|
+
* }
|
|
1997
|
+
* }
|
|
1998
|
+
* ],
|
|
1999
|
+
* "issuelinks": [
|
|
2000
|
+
* {
|
|
2001
|
+
* "id": "10001",
|
|
2002
|
+
* "outwardIssue": {
|
|
2003
|
+
* "fields": {
|
|
2004
|
+
* "status": {
|
|
2005
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2006
|
+
* "name": "Open"
|
|
2007
|
+
* }
|
|
2008
|
+
* },
|
|
2009
|
+
* "id": "10004L",
|
|
2010
|
+
* "key": "PR-2",
|
|
2011
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
|
|
2012
|
+
* },
|
|
2013
|
+
* "type": {
|
|
2014
|
+
* "id": "10000",
|
|
2015
|
+
* "inward": "depends on",
|
|
2016
|
+
* "name": "Dependent",
|
|
2017
|
+
* "outward": "is depended by"
|
|
2018
|
+
* }
|
|
2019
|
+
* },
|
|
2020
|
+
* {
|
|
2021
|
+
* "id": "10002",
|
|
2022
|
+
* "inwardIssue": {
|
|
2023
|
+
* "fields": {
|
|
2024
|
+
* "status": {
|
|
2025
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2026
|
+
* "name": "Open"
|
|
2027
|
+
* }
|
|
2028
|
+
* },
|
|
2029
|
+
* "id": "10004",
|
|
2030
|
+
* "key": "PR-3",
|
|
2031
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
|
|
2032
|
+
* },
|
|
2033
|
+
* "type": {
|
|
2034
|
+
* "id": "10000",
|
|
2035
|
+
* "inward": "depends on",
|
|
2036
|
+
* "name": "Dependent",
|
|
2037
|
+
* "outward": "is depended by"
|
|
2038
|
+
* }
|
|
2039
|
+
* }
|
|
2040
|
+
* ],
|
|
2041
|
+
* "worklog": [
|
|
2042
|
+
* {
|
|
2043
|
+
* "author": {
|
|
2044
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2045
|
+
* "active": false,
|
|
2046
|
+
* "displayName": "Mia Krystof",
|
|
2047
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2048
|
+
* },
|
|
2049
|
+
* "comment": "I did some work here.",
|
|
2050
|
+
* "id": "100028",
|
|
2051
|
+
* "issueId": "10002",
|
|
2052
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
2053
|
+
* "started": "2021-01-17T12:34:00.000+0000",
|
|
2054
|
+
* "timeSpent": "3h 20m",
|
|
2055
|
+
* "timeSpentSeconds": 12000,
|
|
2056
|
+
* "updateAuthor": {
|
|
2057
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2058
|
+
* "active": false,
|
|
2059
|
+
* "displayName": "Mia Krystof",
|
|
2060
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2061
|
+
* },
|
|
2062
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
2063
|
+
* "visibility": {
|
|
2064
|
+
* "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
|
|
2065
|
+
* "type": "group",
|
|
2066
|
+
* "value": "jira-developers"
|
|
2067
|
+
* }
|
|
2068
|
+
* }
|
|
2069
|
+
* ],
|
|
2070
|
+
* "updated": 1,
|
|
2071
|
+
* "timetracking": {
|
|
2072
|
+
* "originalEstimate": "10m",
|
|
2073
|
+
* "originalEstimateSeconds": 600,
|
|
2074
|
+
* "remainingEstimate": "3m",
|
|
2075
|
+
* "remainingEstimateSeconds": 200,
|
|
2076
|
+
* "timeSpent": "6m",
|
|
2077
|
+
* "timeSpentSeconds": 400
|
|
2078
|
+
* }
|
|
2079
|
+
* },
|
|
2080
|
+
* "id": "10002",
|
|
2081
|
+
* "key": "ED-1",
|
|
2082
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
|
|
2083
|
+
* }
|
|
2084
|
+
* ]
|
|
2085
|
+
* }
|
|
2086
|
+
* ```
|
|
2087
|
+
* @path GET `/rest/software/1.0/board/{boardId}/backlog`
|
|
2088
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-backlog-get
|
|
2089
|
+
* @param params
|
|
2090
|
+
*/
|
|
2091
|
+
getIssuesForBacklogJsis: ({ boardId, nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }: {
|
|
2092
|
+
/** The ID of the board that has the backlog containing the requested issues. */
|
|
2093
|
+
boardId: number;
|
|
2094
|
+
/**
|
|
2095
|
+
* The token for a page to fetch that is not the first page. The first page has a
|
|
2096
|
+
* `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
|
|
2097
|
+
* issues.
|
|
2098
|
+
*
|
|
2099
|
+
* Note: The `nextPageToken` field is **not included** in the response for the
|
|
2100
|
+
* last page, indicating there is no next page.
|
|
2101
|
+
*/
|
|
2102
|
+
nextPageToken?: string | undefined;
|
|
2103
|
+
/**
|
|
2104
|
+
* The maximum number of items to return per page. To manage page size, the API
|
|
2105
|
+
* may return fewer items per page where there is a large number of fields or
|
|
2106
|
+
* properties returned. It returns max 5000 issues.
|
|
2107
|
+
*/
|
|
2108
|
+
maxResults?: number | undefined;
|
|
2109
|
+
/**
|
|
2110
|
+
* Strong consistency issue IDs to be reconciled with search results. Accepts max
|
|
2111
|
+
* 50 IDs. This list of IDs should be consistent with each paginated request
|
|
2112
|
+
* across different pages.
|
|
2113
|
+
*/
|
|
2114
|
+
reconcileIssues?: number[] | undefined;
|
|
2115
|
+
/**
|
|
2116
|
+
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
2117
|
+
* will override the default order of the returned issues.
|
|
2118
|
+
* Note that `username` and `userkey` can't be used as search terms for this
|
|
2119
|
+
* parameter due to privacy reasons. Use `accountId` instead.
|
|
2120
|
+
*/
|
|
2121
|
+
jql?: string | undefined;
|
|
2122
|
+
/** Specifies whether to validate the JQL query or not. Default: true. */
|
|
2123
|
+
validateQuery?: boolean | undefined;
|
|
2124
|
+
/**
|
|
2125
|
+
* The list of fields to return for each issue. By default, all navigable and
|
|
2126
|
+
* Software project fields are returned.
|
|
2127
|
+
*/
|
|
2128
|
+
fields?: {}[] | undefined;
|
|
2129
|
+
/** A comma-separated list of the parameters to expand. */
|
|
2130
|
+
expand?: string | undefined;
|
|
2131
|
+
}) => Promise<SoftwareIssueResults>;
|
|
2132
|
+
/**
|
|
2133
|
+
* Returns all issues from a board, for a given board ID. This only includes
|
|
2134
|
+
* issues that the user has permission to view. An issue belongs to the board if
|
|
2135
|
+
* its status is mapped to the board's column. Epic issues do not belongs to the
|
|
2136
|
+
* scrum boards. Note, if the user does not have permission to view the board, no
|
|
2137
|
+
* issues will be returned at all. Issues returned from this resource include
|
|
2138
|
+
* Agile fields, like sprint, closedSprints, flagged, and epic. By default, the
|
|
2139
|
+
* returned issues are ordered by rank.
|
|
2140
|
+
*
|
|
2141
|
+
* @deprecated
|
|
2142
|
+
* @returns Returns the requested issues, at the specified page of the results.
|
|
2143
|
+
*
|
|
2144
|
+
* example:
|
|
2145
|
+
* ```
|
|
2146
|
+
* {
|
|
2147
|
+
* "expand": "names,schema",
|
|
2148
|
+
* "issues": [
|
|
2149
|
+
* {
|
|
2150
|
+
* "expand": "",
|
|
2151
|
+
* "fields": {
|
|
2152
|
+
* "flagged": true,
|
|
2153
|
+
* "sprint": {
|
|
2154
|
+
* "id": 37,
|
|
2155
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
|
|
2156
|
+
* "state": "future",
|
|
2157
|
+
* "name": "sprint 2",
|
|
2158
|
+
* "goal": "sprint 2 goal"
|
|
2159
|
+
* },
|
|
2160
|
+
* "closedSprints": [
|
|
2161
|
+
* {
|
|
2162
|
+
* "id": 37,
|
|
2163
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
|
|
2164
|
+
* "state": "closed",
|
|
2165
|
+
* "name": "sprint 1",
|
|
2166
|
+
* "startDate": "2015-04-11T15:22:00.000+10:00",
|
|
2167
|
+
* "endDate": "2015-04-20T01:22:00.000+10:00",
|
|
2168
|
+
* "completeDate": "2015-04-20T11:04:00.000+10:00",
|
|
2169
|
+
* "goal": "sprint 1 goal"
|
|
2170
|
+
* }
|
|
2171
|
+
* ],
|
|
2172
|
+
* "description": "example bug report",
|
|
2173
|
+
* "project": {
|
|
2174
|
+
* "avatarUrls": {
|
|
2175
|
+
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
2176
|
+
* "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
|
|
2177
|
+
* "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
|
|
2178
|
+
* "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
|
|
2179
|
+
* },
|
|
2180
|
+
* "id": "10000",
|
|
2181
|
+
* "insight": {
|
|
2182
|
+
* "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
|
|
2183
|
+
* "totalIssueCount": 100
|
|
2184
|
+
* },
|
|
2185
|
+
* "key": "EX",
|
|
2186
|
+
* "name": "Example",
|
|
2187
|
+
* "projectCategory": {
|
|
2188
|
+
* "description": "First Project Category",
|
|
2189
|
+
* "id": "10000",
|
|
2190
|
+
* "name": "FIRST",
|
|
2191
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
|
|
2192
|
+
* },
|
|
2193
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
|
|
2194
|
+
* "simplified": false,
|
|
2195
|
+
* "style": "classic"
|
|
2196
|
+
* },
|
|
2197
|
+
* "comment": [
|
|
2198
|
+
* {
|
|
2199
|
+
* "author": {
|
|
2200
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2201
|
+
* "active": false,
|
|
2202
|
+
* "displayName": "Mia Krystof",
|
|
2203
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2204
|
+
* },
|
|
2205
|
+
* "body": {
|
|
2206
|
+
* "type": "doc",
|
|
2207
|
+
* "version": 1,
|
|
2208
|
+
* "content": [
|
|
2209
|
+
* {
|
|
2210
|
+
* "type": "paragraph",
|
|
2211
|
+
* "content": [
|
|
2212
|
+
* {
|
|
2213
|
+
* "type": "text",
|
|
2214
|
+
* "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
|
|
2215
|
+
* }
|
|
2216
|
+
* ]
|
|
2217
|
+
* }
|
|
2218
|
+
* ]
|
|
2219
|
+
* },
|
|
2220
|
+
* "created": "2021-01-17T12:34:00.000+0000",
|
|
2221
|
+
* "id": "10000",
|
|
2222
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
2223
|
+
* "updateAuthor": {
|
|
2224
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2225
|
+
* "active": false,
|
|
2226
|
+
* "displayName": "Mia Krystof",
|
|
2227
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2228
|
+
* },
|
|
2229
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
2230
|
+
* "visibility": {
|
|
2231
|
+
* "identifier": "Administrators",
|
|
2232
|
+
* "type": "role",
|
|
2233
|
+
* "value": "Administrators"
|
|
2234
|
+
* }
|
|
2235
|
+
* }
|
|
2236
|
+
* ],
|
|
2237
|
+
* "epic": {
|
|
2238
|
+
* "id": 37,
|
|
2239
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
|
|
2240
|
+
* "name": "epic 1",
|
|
2241
|
+
* "summary": "epic 1 summary",
|
|
2242
|
+
* "color": {
|
|
2243
|
+
* "key": "color_4"
|
|
2244
|
+
* },
|
|
2245
|
+
* "done": true
|
|
2246
|
+
* },
|
|
2247
|
+
* "worklog": [
|
|
2248
|
+
* {
|
|
2249
|
+
* "author": {
|
|
2250
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2251
|
+
* "active": false,
|
|
2252
|
+
* "displayName": "Mia Krystof",
|
|
2253
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2254
|
+
* },
|
|
2255
|
+
* "comment": {
|
|
2256
|
+
* "type": "doc",
|
|
2257
|
+
* "version": 1,
|
|
2258
|
+
* "content": [
|
|
2259
|
+
* {
|
|
2260
|
+
* "type": "paragraph",
|
|
2261
|
+
* "content": [
|
|
2262
|
+
* {
|
|
2263
|
+
* "type": "text",
|
|
2264
|
+
* "text": "I did some work here."
|
|
2265
|
+
* }
|
|
2266
|
+
* ]
|
|
2267
|
+
* }
|
|
2268
|
+
* ]
|
|
2269
|
+
* },
|
|
2270
|
+
* "id": "100028",
|
|
2271
|
+
* "issueId": "10002",
|
|
2272
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
2273
|
+
* "started": "2021-01-17T12:34:00.000+0000",
|
|
2274
|
+
* "timeSpent": "3h 20m",
|
|
2275
|
+
* "timeSpentSeconds": 12000,
|
|
2276
|
+
* "updateAuthor": {
|
|
2277
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2278
|
+
* "active": false,
|
|
2279
|
+
* "displayName": "Mia Krystof",
|
|
2280
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2281
|
+
* },
|
|
2282
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
2283
|
+
* "visibility": {
|
|
2284
|
+
* "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
|
|
2285
|
+
* "type": "group",
|
|
2286
|
+
* "value": "jira-developers"
|
|
2287
|
+
* }
|
|
2288
|
+
* }
|
|
2289
|
+
* ],
|
|
2290
|
+
* "updated": 1,
|
|
2291
|
+
* "timetracking": {
|
|
2292
|
+
* "originalEstimate": "10m",
|
|
2293
|
+
* "originalEstimateSeconds": 600,
|
|
2294
|
+
* "remainingEstimate": "3m",
|
|
2295
|
+
* "remainingEstimateSeconds": 200,
|
|
2296
|
+
* "timeSpent": "6m",
|
|
2297
|
+
* "timeSpentSeconds": 400
|
|
2298
|
+
* }
|
|
2299
|
+
* },
|
|
2300
|
+
* "id": "10001",
|
|
2301
|
+
* "key": "HSP-1",
|
|
2302
|
+
* "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
|
|
2303
|
+
* }
|
|
2304
|
+
* ],
|
|
2305
|
+
* "maxResults": 50,
|
|
2306
|
+
* "startAt": 0,
|
|
2307
|
+
* "total": 1
|
|
2308
|
+
* }
|
|
2309
|
+
* ```
|
|
2310
|
+
* @path GET `/rest/agile/1.0/board/{boardId}/issue`
|
|
2311
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-get
|
|
2312
|
+
* @param params
|
|
2313
|
+
*/
|
|
2314
|
+
getIssuesForBoard: ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand }: {
|
|
2315
|
+
/** The ID of the board that contains the requested issues. */
|
|
2316
|
+
boardId: number;
|
|
2317
|
+
/**
|
|
2318
|
+
* The starting index of the returned issues. Base index: 0. See the 'Pagination'
|
|
2319
|
+
* section at the top of this page for more details.
|
|
2320
|
+
*/
|
|
2321
|
+
startAt?: number | undefined;
|
|
2322
|
+
/**
|
|
2323
|
+
* The maximum number of issues to return per page. See the 'Pagination' section
|
|
2324
|
+
* at the top of this page for more details. Note, the total number of issues
|
|
2325
|
+
* returned is limited by the property 'jira.search.views.default.max' in your
|
|
2326
|
+
* Jira instance. If you exceed this limit, your results will be truncated.
|
|
2327
|
+
*/
|
|
2328
|
+
maxResults?: number | undefined;
|
|
2329
|
+
/**
|
|
2330
|
+
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
2331
|
+
* will override the default order of the returned issues.
|
|
2332
|
+
* Note that `username` and `userkey` can't be used as search terms for this
|
|
2333
|
+
* parameter due to privacy reasons. Use `accountId` instead.
|
|
2334
|
+
*/
|
|
2335
|
+
jql?: string | undefined;
|
|
2336
|
+
/** Specifies whether to validate the JQL query or not. Default: true. */
|
|
2337
|
+
validateQuery?: boolean | undefined;
|
|
2338
|
+
/**
|
|
2339
|
+
* The list of fields to return for each issue. By default, all navigable and
|
|
2340
|
+
* Agile fields are returned.
|
|
2341
|
+
*/
|
|
2342
|
+
fields?: {}[] | undefined;
|
|
2343
|
+
/** This parameter is currently not used. */
|
|
2344
|
+
expand?: string | undefined;
|
|
2345
|
+
}) => Promise<SearchResults>;
|
|
2346
|
+
/**
|
|
2347
|
+
* Returns all issues from a board, for a given board ID. Result pagination is
|
|
2348
|
+
* token based, using `nextPageToken` and `maxResults`. This only includes issues
|
|
2349
|
+
* that the user has permission to view. Note, if the user does not have
|
|
2350
|
+
* permission to view the board, no issues will be returned at all. An issue
|
|
2351
|
+
* belongs to the board if its status is mapped to the board's column. Epic issues
|
|
2352
|
+
* do not belong to scrum boards. Issues returned from this resource include
|
|
2353
|
+
* Software project fields, like sprint, closedSprints, flagged, and epic. By
|
|
2354
|
+
* default, the returned issues are ordered by rank.
|
|
1087
2355
|
*
|
|
1088
2356
|
* @returns Returns the requested issues, at the specified page of the results.
|
|
1089
2357
|
*
|
|
@@ -1091,31 +2359,65 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1091
2359
|
* ```
|
|
1092
2360
|
* {
|
|
1093
2361
|
* "expand": "names,schema",
|
|
2362
|
+
* "isLast": true,
|
|
1094
2363
|
* "issues": [
|
|
1095
2364
|
* {
|
|
1096
2365
|
* "expand": "",
|
|
1097
2366
|
* "fields": {
|
|
1098
|
-
* "
|
|
1099
|
-
*
|
|
1100
|
-
* "
|
|
1101
|
-
* "
|
|
1102
|
-
* "state": "future",
|
|
1103
|
-
* "name": "sprint 2",
|
|
1104
|
-
* "goal": "sprint 2 goal"
|
|
2367
|
+
* "watcher": {
|
|
2368
|
+
* "isWatching": false,
|
|
2369
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
|
|
2370
|
+
* "watchCount": 1
|
|
1105
2371
|
* },
|
|
1106
|
-
* "
|
|
2372
|
+
* "attachment": [
|
|
1107
2373
|
* {
|
|
1108
|
-
* "
|
|
1109
|
-
*
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1113
|
-
*
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
2374
|
+
* "author": {
|
|
2375
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2376
|
+
* "accountType": "atlassian",
|
|
2377
|
+
* "active": false,
|
|
2378
|
+
* "avatarUrls": {
|
|
2379
|
+
* "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
2380
|
+
* "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
2381
|
+
* "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
2382
|
+
* "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
2383
|
+
* },
|
|
2384
|
+
* "displayName": "Mia Krystof",
|
|
2385
|
+
* "key": "",
|
|
2386
|
+
* "name": "",
|
|
2387
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2388
|
+
* },
|
|
2389
|
+
* "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
|
|
2390
|
+
* "created": "2023-06-24T19:24:50.000+0000",
|
|
2391
|
+
* "filename": "debuglog.txt",
|
|
2392
|
+
* "id": 10001,
|
|
2393
|
+
* "mimeType": "text/plain",
|
|
2394
|
+
* "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
|
|
2395
|
+
* "size": 2460
|
|
1116
2396
|
* }
|
|
1117
2397
|
* ],
|
|
1118
|
-
* "
|
|
2398
|
+
* "sub-tasks": [
|
|
2399
|
+
* {
|
|
2400
|
+
* "id": "10000",
|
|
2401
|
+
* "outwardIssue": {
|
|
2402
|
+
* "fields": {
|
|
2403
|
+
* "status": {
|
|
2404
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2405
|
+
* "name": "Open"
|
|
2406
|
+
* }
|
|
2407
|
+
* },
|
|
2408
|
+
* "id": "10003",
|
|
2409
|
+
* "key": "ED-2",
|
|
2410
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
|
|
2411
|
+
* },
|
|
2412
|
+
* "type": {
|
|
2413
|
+
* "id": "10000",
|
|
2414
|
+
* "inward": "Parent",
|
|
2415
|
+
* "name": "",
|
|
2416
|
+
* "outward": "Sub-task"
|
|
2417
|
+
* }
|
|
2418
|
+
* }
|
|
2419
|
+
* ],
|
|
2420
|
+
* "description": "Main order flow broken",
|
|
1119
2421
|
* "project": {
|
|
1120
2422
|
* "avatarUrls": {
|
|
1121
2423
|
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
@@ -1148,21 +2450,7 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1148
2450
|
* "displayName": "Mia Krystof",
|
|
1149
2451
|
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1150
2452
|
* },
|
|
1151
|
-
* "body":
|
|
1152
|
-
* "type": "doc",
|
|
1153
|
-
* "version": 1,
|
|
1154
|
-
* "content": [
|
|
1155
|
-
* {
|
|
1156
|
-
* "type": "paragraph",
|
|
1157
|
-
* "content": [
|
|
1158
|
-
* {
|
|
1159
|
-
* "type": "text",
|
|
1160
|
-
* "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
|
|
1161
|
-
* }
|
|
1162
|
-
* ]
|
|
1163
|
-
* }
|
|
1164
|
-
* ]
|
|
1165
|
-
* },
|
|
2453
|
+
* "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
|
|
1166
2454
|
* "created": "2021-01-17T12:34:00.000+0000",
|
|
1167
2455
|
* "id": "10000",
|
|
1168
2456
|
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
@@ -1180,16 +2468,48 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1180
2468
|
* }
|
|
1181
2469
|
* }
|
|
1182
2470
|
* ],
|
|
1183
|
-
* "
|
|
1184
|
-
*
|
|
1185
|
-
*
|
|
1186
|
-
*
|
|
1187
|
-
*
|
|
1188
|
-
*
|
|
1189
|
-
*
|
|
2471
|
+
* "issuelinks": [
|
|
2472
|
+
* {
|
|
2473
|
+
* "id": "10001",
|
|
2474
|
+
* "outwardIssue": {
|
|
2475
|
+
* "fields": {
|
|
2476
|
+
* "status": {
|
|
2477
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2478
|
+
* "name": "Open"
|
|
2479
|
+
* }
|
|
2480
|
+
* },
|
|
2481
|
+
* "id": "10004L",
|
|
2482
|
+
* "key": "PR-2",
|
|
2483
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
|
|
2484
|
+
* },
|
|
2485
|
+
* "type": {
|
|
2486
|
+
* "id": "10000",
|
|
2487
|
+
* "inward": "depends on",
|
|
2488
|
+
* "name": "Dependent",
|
|
2489
|
+
* "outward": "is depended by"
|
|
2490
|
+
* }
|
|
1190
2491
|
* },
|
|
1191
|
-
*
|
|
1192
|
-
*
|
|
2492
|
+
* {
|
|
2493
|
+
* "id": "10002",
|
|
2494
|
+
* "inwardIssue": {
|
|
2495
|
+
* "fields": {
|
|
2496
|
+
* "status": {
|
|
2497
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2498
|
+
* "name": "Open"
|
|
2499
|
+
* }
|
|
2500
|
+
* },
|
|
2501
|
+
* "id": "10004",
|
|
2502
|
+
* "key": "PR-3",
|
|
2503
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
|
|
2504
|
+
* },
|
|
2505
|
+
* "type": {
|
|
2506
|
+
* "id": "10000",
|
|
2507
|
+
* "inward": "depends on",
|
|
2508
|
+
* "name": "Dependent",
|
|
2509
|
+
* "outward": "is depended by"
|
|
2510
|
+
* }
|
|
2511
|
+
* }
|
|
2512
|
+
* ],
|
|
1193
2513
|
* "worklog": [
|
|
1194
2514
|
* {
|
|
1195
2515
|
* "author": {
|
|
@@ -1198,21 +2518,7 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1198
2518
|
* "displayName": "Mia Krystof",
|
|
1199
2519
|
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1200
2520
|
* },
|
|
1201
|
-
* "comment":
|
|
1202
|
-
* "type": "doc",
|
|
1203
|
-
* "version": 1,
|
|
1204
|
-
* "content": [
|
|
1205
|
-
* {
|
|
1206
|
-
* "type": "paragraph",
|
|
1207
|
-
* "content": [
|
|
1208
|
-
* {
|
|
1209
|
-
* "type": "text",
|
|
1210
|
-
* "text": "I did some work here."
|
|
1211
|
-
* }
|
|
1212
|
-
* ]
|
|
1213
|
-
* }
|
|
1214
|
-
* ]
|
|
1215
|
-
* },
|
|
2521
|
+
* "comment": "I did some work here.",
|
|
1216
2522
|
* "id": "100028",
|
|
1217
2523
|
* "issueId": "10002",
|
|
1218
2524
|
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
@@ -1243,36 +2549,41 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1243
2549
|
* "timeSpentSeconds": 400
|
|
1244
2550
|
* }
|
|
1245
2551
|
* },
|
|
1246
|
-
* "id": "
|
|
1247
|
-
* "key": "
|
|
1248
|
-
* "self": "https://your-domain.atlassian.net/rest/
|
|
2552
|
+
* "id": "10002",
|
|
2553
|
+
* "key": "ED-1",
|
|
2554
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
|
|
1249
2555
|
* }
|
|
1250
|
-
* ]
|
|
1251
|
-
* "maxResults": 50,
|
|
1252
|
-
* "startAt": 0,
|
|
1253
|
-
* "total": 1
|
|
2556
|
+
* ]
|
|
1254
2557
|
* }
|
|
1255
2558
|
* ```
|
|
1256
|
-
* @path GET `/rest/
|
|
1257
|
-
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-
|
|
2559
|
+
* @path GET `/rest/software/1.0/board/{boardId}/issue`
|
|
2560
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-issue-get
|
|
1258
2561
|
* @param params
|
|
1259
2562
|
*/
|
|
1260
|
-
|
|
1261
|
-
/** The ID of the board that
|
|
2563
|
+
getIssuesForBoardJsis: ({ boardId, nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }: {
|
|
2564
|
+
/** The ID of the board that contains the requested issues. */
|
|
1262
2565
|
boardId: number;
|
|
1263
2566
|
/**
|
|
1264
|
-
* The
|
|
1265
|
-
*
|
|
2567
|
+
* The token for a page to fetch that is not the first page. The first page has a
|
|
2568
|
+
* `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
|
|
2569
|
+
* issues.
|
|
2570
|
+
*
|
|
2571
|
+
* Note: The `nextPageToken` field is **not included** in the response for the
|
|
2572
|
+
* last page, indicating there is no next page.
|
|
1266
2573
|
*/
|
|
1267
|
-
|
|
2574
|
+
nextPageToken?: string | undefined;
|
|
1268
2575
|
/**
|
|
1269
|
-
* The maximum number of
|
|
1270
|
-
*
|
|
1271
|
-
*
|
|
1272
|
-
* 'jira.search.views.default.max' in your Jira instance. If you exceed this
|
|
1273
|
-
* limit, your results will be truncated.
|
|
2576
|
+
* The maximum number of items to return per page. To manage page size, the API
|
|
2577
|
+
* may return fewer items per page where there is a large number of fields or
|
|
2578
|
+
* properties returned. It returns max 5000 issues.
|
|
1274
2579
|
*/
|
|
1275
2580
|
maxResults?: number | undefined;
|
|
2581
|
+
/**
|
|
2582
|
+
* Strong consistency issue IDs to be reconciled with search results. Accepts max
|
|
2583
|
+
* 50 IDs. This list of IDs should be consistent with each paginated request
|
|
2584
|
+
* across different pages.
|
|
2585
|
+
*/
|
|
2586
|
+
reconcileIssues?: number[] | undefined;
|
|
1276
2587
|
/**
|
|
1277
2588
|
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
1278
2589
|
* will override the default order of the returned issues.
|
|
@@ -1284,21 +2595,19 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1284
2595
|
validateQuery?: boolean | undefined;
|
|
1285
2596
|
/**
|
|
1286
2597
|
* The list of fields to return for each issue. By default, all navigable and
|
|
1287
|
-
*
|
|
2598
|
+
* Software project fields are returned.
|
|
1288
2599
|
*/
|
|
1289
2600
|
fields?: {}[] | undefined;
|
|
1290
|
-
/**
|
|
2601
|
+
/** A comma-separated list of the parameters to expand. */
|
|
1291
2602
|
expand?: string | undefined;
|
|
1292
|
-
}) => Promise<
|
|
2603
|
+
}) => Promise<SoftwareIssueResults>;
|
|
1293
2604
|
/**
|
|
1294
|
-
* Returns all issues
|
|
1295
|
-
* issues that the user has permission to view.
|
|
1296
|
-
*
|
|
1297
|
-
*
|
|
1298
|
-
* issues will be returned at all. Issues returned from this resource include
|
|
1299
|
-
* Agile fields, like sprint, closedSprints, flagged, and epic. By default, the
|
|
1300
|
-
* returned issues are ordered by rank.
|
|
2605
|
+
* Returns all issues that do not belong to any epic on a board, for a given board
|
|
2606
|
+
* ID. This only includes issues that the user has permission to view. Issues
|
|
2607
|
+
* returned from this resource include Agile fields, like sprint, closedSprints,
|
|
2608
|
+
* flagged, and epic. By default, the returned issues are ordered by rank.
|
|
1301
2609
|
*
|
|
2610
|
+
* @deprecated
|
|
1302
2611
|
* @returns Returns the requested issues, at the specified page of the results.
|
|
1303
2612
|
*
|
|
1304
2613
|
* example:
|
|
@@ -1467,11 +2776,11 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1467
2776
|
* "total": 1
|
|
1468
2777
|
* }
|
|
1469
2778
|
* ```
|
|
1470
|
-
* @path GET `/rest/agile/1.0/board/{boardId}/issue`
|
|
1471
|
-
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-get
|
|
2779
|
+
* @path GET `/rest/agile/1.0/board/{boardId}/epic/none/issue`
|
|
2780
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-none-issue-get
|
|
1472
2781
|
* @param params
|
|
1473
2782
|
*/
|
|
1474
|
-
|
|
2783
|
+
getIssuesWithoutEpicForBoard: ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand }: {
|
|
1475
2784
|
/** The ID of the board that contains the requested issues. */
|
|
1476
2785
|
boardId: number;
|
|
1477
2786
|
/**
|
|
@@ -1500,14 +2809,17 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1500
2809
|
* Agile fields are returned.
|
|
1501
2810
|
*/
|
|
1502
2811
|
fields?: {}[] | undefined;
|
|
1503
|
-
/**
|
|
2812
|
+
/** A comma-separated list of the parameters to expand. */
|
|
1504
2813
|
expand?: string | undefined;
|
|
1505
|
-
}) => Promise<
|
|
2814
|
+
}) => Promise<unknown>;
|
|
1506
2815
|
/**
|
|
1507
2816
|
* Returns all issues that do not belong to any epic on a board, for a given board
|
|
1508
|
-
* ID.
|
|
1509
|
-
*
|
|
1510
|
-
*
|
|
2817
|
+
* ID. Result pagination is token based, using `nextPageToken` and `maxResults`.
|
|
2818
|
+
* This only includes issues that the user has permission to view. Note, if the
|
|
2819
|
+
* user does not have permission to view the board, no issues will be returned at
|
|
2820
|
+
* all. Issues returned from this resource include Software project fields, like
|
|
2821
|
+
* sprint, closedSprints, flagged, and epic. By default, the returned issues are
|
|
2822
|
+
* ordered by rank.
|
|
1511
2823
|
*
|
|
1512
2824
|
* @returns Returns the requested issues, at the specified page of the results.
|
|
1513
2825
|
*
|
|
@@ -1515,31 +2827,65 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1515
2827
|
* ```
|
|
1516
2828
|
* {
|
|
1517
2829
|
* "expand": "names,schema",
|
|
2830
|
+
* "isLast": true,
|
|
1518
2831
|
* "issues": [
|
|
1519
2832
|
* {
|
|
1520
2833
|
* "expand": "",
|
|
1521
2834
|
* "fields": {
|
|
1522
|
-
* "
|
|
1523
|
-
*
|
|
1524
|
-
* "
|
|
1525
|
-
* "
|
|
1526
|
-
* "state": "future",
|
|
1527
|
-
* "name": "sprint 2",
|
|
1528
|
-
* "goal": "sprint 2 goal"
|
|
2835
|
+
* "watcher": {
|
|
2836
|
+
* "isWatching": false,
|
|
2837
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
|
|
2838
|
+
* "watchCount": 1
|
|
1529
2839
|
* },
|
|
1530
|
-
* "
|
|
2840
|
+
* "attachment": [
|
|
1531
2841
|
* {
|
|
1532
|
-
* "
|
|
1533
|
-
*
|
|
1534
|
-
*
|
|
1535
|
-
*
|
|
1536
|
-
*
|
|
1537
|
-
*
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
2842
|
+
* "author": {
|
|
2843
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2844
|
+
* "accountType": "atlassian",
|
|
2845
|
+
* "active": false,
|
|
2846
|
+
* "avatarUrls": {
|
|
2847
|
+
* "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
2848
|
+
* "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
2849
|
+
* "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
2850
|
+
* "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
2851
|
+
* },
|
|
2852
|
+
* "displayName": "Mia Krystof",
|
|
2853
|
+
* "key": "",
|
|
2854
|
+
* "name": "",
|
|
2855
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2856
|
+
* },
|
|
2857
|
+
* "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
|
|
2858
|
+
* "created": "2023-06-24T19:24:50.000+0000",
|
|
2859
|
+
* "filename": "debuglog.txt",
|
|
2860
|
+
* "id": 10001,
|
|
2861
|
+
* "mimeType": "text/plain",
|
|
2862
|
+
* "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
|
|
2863
|
+
* "size": 2460
|
|
1540
2864
|
* }
|
|
1541
2865
|
* ],
|
|
1542
|
-
* "
|
|
2866
|
+
* "sub-tasks": [
|
|
2867
|
+
* {
|
|
2868
|
+
* "id": "10000",
|
|
2869
|
+
* "outwardIssue": {
|
|
2870
|
+
* "fields": {
|
|
2871
|
+
* "status": {
|
|
2872
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2873
|
+
* "name": "Open"
|
|
2874
|
+
* }
|
|
2875
|
+
* },
|
|
2876
|
+
* "id": "10003",
|
|
2877
|
+
* "key": "ED-2",
|
|
2878
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
|
|
2879
|
+
* },
|
|
2880
|
+
* "type": {
|
|
2881
|
+
* "id": "10000",
|
|
2882
|
+
* "inward": "Parent",
|
|
2883
|
+
* "name": "",
|
|
2884
|
+
* "outward": "Sub-task"
|
|
2885
|
+
* }
|
|
2886
|
+
* }
|
|
2887
|
+
* ],
|
|
2888
|
+
* "description": "Main order flow broken",
|
|
1543
2889
|
* "project": {
|
|
1544
2890
|
* "avatarUrls": {
|
|
1545
2891
|
* "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
@@ -1572,21 +2918,7 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1572
2918
|
* "displayName": "Mia Krystof",
|
|
1573
2919
|
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1574
2920
|
* },
|
|
1575
|
-
* "body":
|
|
1576
|
-
* "type": "doc",
|
|
1577
|
-
* "version": 1,
|
|
1578
|
-
* "content": [
|
|
1579
|
-
* {
|
|
1580
|
-
* "type": "paragraph",
|
|
1581
|
-
* "content": [
|
|
1582
|
-
* {
|
|
1583
|
-
* "type": "text",
|
|
1584
|
-
* "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
|
|
1585
|
-
* }
|
|
1586
|
-
* ]
|
|
1587
|
-
* }
|
|
1588
|
-
* ]
|
|
1589
|
-
* },
|
|
2921
|
+
* "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
|
|
1590
2922
|
* "created": "2021-01-17T12:34:00.000+0000",
|
|
1591
2923
|
* "id": "10000",
|
|
1592
2924
|
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
@@ -1604,16 +2936,48 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1604
2936
|
* }
|
|
1605
2937
|
* }
|
|
1606
2938
|
* ],
|
|
1607
|
-
* "
|
|
1608
|
-
*
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1613
|
-
*
|
|
2939
|
+
* "issuelinks": [
|
|
2940
|
+
* {
|
|
2941
|
+
* "id": "10001",
|
|
2942
|
+
* "outwardIssue": {
|
|
2943
|
+
* "fields": {
|
|
2944
|
+
* "status": {
|
|
2945
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2946
|
+
* "name": "Open"
|
|
2947
|
+
* }
|
|
2948
|
+
* },
|
|
2949
|
+
* "id": "10004L",
|
|
2950
|
+
* "key": "PR-2",
|
|
2951
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
|
|
2952
|
+
* },
|
|
2953
|
+
* "type": {
|
|
2954
|
+
* "id": "10000",
|
|
2955
|
+
* "inward": "depends on",
|
|
2956
|
+
* "name": "Dependent",
|
|
2957
|
+
* "outward": "is depended by"
|
|
2958
|
+
* }
|
|
1614
2959
|
* },
|
|
1615
|
-
*
|
|
1616
|
-
*
|
|
2960
|
+
* {
|
|
2961
|
+
* "id": "10002",
|
|
2962
|
+
* "inwardIssue": {
|
|
2963
|
+
* "fields": {
|
|
2964
|
+
* "status": {
|
|
2965
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2966
|
+
* "name": "Open"
|
|
2967
|
+
* }
|
|
2968
|
+
* },
|
|
2969
|
+
* "id": "10004",
|
|
2970
|
+
* "key": "PR-3",
|
|
2971
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
|
|
2972
|
+
* },
|
|
2973
|
+
* "type": {
|
|
2974
|
+
* "id": "10000",
|
|
2975
|
+
* "inward": "depends on",
|
|
2976
|
+
* "name": "Dependent",
|
|
2977
|
+
* "outward": "is depended by"
|
|
2978
|
+
* }
|
|
2979
|
+
* }
|
|
2980
|
+
* ],
|
|
1617
2981
|
* "worklog": [
|
|
1618
2982
|
* {
|
|
1619
2983
|
* "author": {
|
|
@@ -1622,21 +2986,7 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1622
2986
|
* "displayName": "Mia Krystof",
|
|
1623
2987
|
* "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
1624
2988
|
* },
|
|
1625
|
-
* "comment":
|
|
1626
|
-
* "type": "doc",
|
|
1627
|
-
* "version": 1,
|
|
1628
|
-
* "content": [
|
|
1629
|
-
* {
|
|
1630
|
-
* "type": "paragraph",
|
|
1631
|
-
* "content": [
|
|
1632
|
-
* {
|
|
1633
|
-
* "type": "text",
|
|
1634
|
-
* "text": "I did some work here."
|
|
1635
|
-
* }
|
|
1636
|
-
* ]
|
|
1637
|
-
* }
|
|
1638
|
-
* ]
|
|
1639
|
-
* },
|
|
2989
|
+
* "comment": "I did some work here.",
|
|
1640
2990
|
* "id": "100028",
|
|
1641
2991
|
* "issueId": "10002",
|
|
1642
2992
|
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
@@ -1667,35 +3017,41 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1667
3017
|
* "timeSpentSeconds": 400
|
|
1668
3018
|
* }
|
|
1669
3019
|
* },
|
|
1670
|
-
* "id": "
|
|
1671
|
-
* "key": "
|
|
1672
|
-
* "self": "https://your-domain.atlassian.net/rest/
|
|
3020
|
+
* "id": "10002",
|
|
3021
|
+
* "key": "ED-1",
|
|
3022
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
|
|
1673
3023
|
* }
|
|
1674
|
-
* ]
|
|
1675
|
-
* "maxResults": 50,
|
|
1676
|
-
* "startAt": 0,
|
|
1677
|
-
* "total": 1
|
|
3024
|
+
* ]
|
|
1678
3025
|
* }
|
|
1679
3026
|
* ```
|
|
1680
|
-
* @path GET `/rest/
|
|
1681
|
-
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-
|
|
3027
|
+
* @path GET `/rest/software/1.0/board/{boardId}/epic/none/issue`
|
|
3028
|
+
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-software-1-0-board-boardid-epic-none-issue-get
|
|
1682
3029
|
* @param params
|
|
1683
3030
|
*/
|
|
1684
|
-
|
|
3031
|
+
getIssuesWithoutEpicForBoardJsis: ({ boardId, nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }: {
|
|
1685
3032
|
/** The ID of the board that contains the requested issues. */
|
|
1686
3033
|
boardId: number;
|
|
1687
3034
|
/**
|
|
1688
|
-
* The
|
|
1689
|
-
*
|
|
3035
|
+
* The token for a page to fetch that is not the first page. The first page has a
|
|
3036
|
+
* `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
|
|
3037
|
+
* issues.
|
|
3038
|
+
*
|
|
3039
|
+
* Note: The `nextPageToken` field is **not included** in the response for the
|
|
3040
|
+
* last page, indicating there is no next page.
|
|
1690
3041
|
*/
|
|
1691
|
-
|
|
3042
|
+
nextPageToken?: string | undefined;
|
|
1692
3043
|
/**
|
|
1693
|
-
* The maximum number of
|
|
1694
|
-
*
|
|
1695
|
-
* returned
|
|
1696
|
-
* Jira instance. If you exceed this limit, your results will be truncated.
|
|
3044
|
+
* The maximum number of items to return per page. To manage page size, the API
|
|
3045
|
+
* may return fewer items per page where there is a large number of fields or
|
|
3046
|
+
* properties returned. It returns max 5000 issues.
|
|
1697
3047
|
*/
|
|
1698
3048
|
maxResults?: number | undefined;
|
|
3049
|
+
/**
|
|
3050
|
+
* Strong consistency issue IDs to be reconciled with search results. Accepts max
|
|
3051
|
+
* 50 IDs. This list of IDs should be consistent with each paginated request
|
|
3052
|
+
* across different pages.
|
|
3053
|
+
*/
|
|
3054
|
+
reconcileIssues?: number[] | undefined;
|
|
1699
3055
|
/**
|
|
1700
3056
|
* Filters results using a JQL query. If you define an order in your JQL query, it
|
|
1701
3057
|
* will override the default order of the returned issues.
|
|
@@ -1707,12 +3063,12 @@ export declare class BoardService extends CommonHttpService {
|
|
|
1707
3063
|
validateQuery?: boolean | undefined;
|
|
1708
3064
|
/**
|
|
1709
3065
|
* The list of fields to return for each issue. By default, all navigable and
|
|
1710
|
-
*
|
|
3066
|
+
* Software project fields are returned.
|
|
1711
3067
|
*/
|
|
1712
3068
|
fields?: {}[] | undefined;
|
|
1713
3069
|
/** A comma-separated list of the parameters to expand. */
|
|
1714
3070
|
expand?: string | undefined;
|
|
1715
|
-
}) => Promise<
|
|
3071
|
+
}) => Promise<SoftwareIssueResults>;
|
|
1716
3072
|
/**
|
|
1717
3073
|
* Returns all projects that are associated with the board, for the given board
|
|
1718
3074
|
* ID. If the user does not have permission to view the board, no projects will be
|