ProjectsApi class
Jira Cloud platform REST API documentation
Constructors
- ProjectsApi(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
-
archiveProject(
String projectIdOrKey) → Future - Archives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.
-
createProject(
{required CreateProjectDetails body}) → Future< ProjectIdentifiers> - Creates a project based on a project type template, as shown in the following table:
-
deleteProject(
{required String projectIdOrKey, bool? enableUndo}) → Future< void> - Deletes a project.
-
deleteProjectAsynchronously(
String projectIdOrKey) → Future< TaskProgressBeanObject> - Deletes a project asynchronously.
-
getAllProjects(
{String? expand, int? recent, List< String> ? properties}) → Future<List< Project> > - Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.
-
getAllStatuses(
String projectIdOrKey) → Future< List< IssueTypeWithStatus> > - Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.
-
getHierarchy(
int projectId) → Future< ProjectIssueTypeHierarchy> - Get the issue type hierarchy for a next-gen project.
-
getNotificationSchemeForProject(
{required String projectKeyOrId, String? expand}) → Future< NotificationScheme> - Gets a notification scheme associated with the project.
-
getProject(
{required String projectIdOrKey, String? expand, List< String> ? properties}) → Future<Project> - Returns the project details for a project.
-
getRecent(
{String? expand, List< StringList> ? properties}) → Future<List< Project> > - Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
restore(
String projectIdOrKey) → Future< Project> - Restores a project that has been archived or placed in the Jira recycle bin.
-
searchProjects(
{int? startAt, int? maxResults, String? orderBy, List< int> ? id, List<String> ? keys, String? query, String? typeKey, int? categoryId, String? action, String? expand, List<String> ? status, List<StringList> ? properties, String? propertyQuery}) → Future<PageBeanProject> - Returns a paginated list of projects visible to the user.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateProject(
{required String projectIdOrKey, String? expand, required UpdateProjectDetails body}) → Future< Project> - Updates the project details of a project.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited