IssuesApi class - jira_platform library

Constructors

IssuesApi(ApiClient _client)

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

archiveIssues({required IssueArchivalSyncRequest body}) → Future<IssueArchivalSyncResponse>: Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.
archiveIssuesAsync({required ArchiveIssueAsyncRequest body}) → Future<String>: Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request.
assignIssue({required String issueIdOrKey, required User body}) → Future: Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in.
createIssue({bool? updateHistory, required IssueUpdateDetails body}) → Future<CreatedIssue>: Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.
createIssues({required IssuesUpdateBean body}) → Future<CreatedIssues>: Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.
deleteIssue({required String issueIdOrKey, String? deleteSubtasks}) → Future<void>: Deletes an issue.
doTransition({required String issueIdOrKey, required IssueUpdateDetails body}) → Future: Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
editIssue({required String issueIdOrKey, bool? notifyUsers, bool? overrideScreenSecurity, bool? overrideEditableFlag, required IssueUpdateDetails body}) → Future: Edits an issue. A transition may be applied and issue properties updated as part of the edit.
exportArchivedIssues({required ArchivedIssuesFilterRequest body}) → Future<ExportArchivedIssuesTaskProgressResponse>: Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details.
getChangeLogs({required String issueIdOrKey, int? startAt, int? maxResults}) → Future<PageBeanChangelog>: Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest.
getChangeLogsByIds({required String issueIdOrKey, required IssueChangelogIds body}) → Future<PageOfChangelogs>: Returns changelogs for an issue specified by a list of changelog IDs.
getCreateIssueMeta({List<String>? projectIds, List<String>? projectKeys, List<String>? issuetypeIds, List<String>? issuetypeNames, String? expand}) → Future<IssueCreateMetadata>: Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.
getEditIssueMeta({required String issueIdOrKey, bool? overrideScreenSecurity, bool? overrideEditableFlag}) → Future<IssueUpdateMetadata>: Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue.
getEvents() → Future<List<IssueEvent>>: Returns all issue events.
getIssue({required String issueIdOrKey, List<String>? fields, bool? fieldsByKeys, String? expand, List<String>? properties, bool? updateHistory}) → Future<IssueBean>: Returns the details for an issue.
getTransitions({required String issueIdOrKey, String? expand, String? transitionId, bool? skipRemoteOnlyCondition, bool? includeUnavailableTransitions, bool? sortByOpsBarAndStatus}) → Future<Transitions>: Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notify({required String issueIdOrKey, required Notification body}) → Future: Creates an email notification for an issue and adds it to the mail queue.
toString() → String: A string representation of this object.
inherited
unarchiveIssues({required IssueArchivalSyncRequest body}) → Future<IssueArchivalSyncResponse>: Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any.

Operators

operator ==(Object other) → bool: The equality operator.
inherited