io.github.primelib.jira4j.restv3.api.JiraRESTV3Api Maven / Gradle / Ivy
Show all versions of jira4j-rest-v3 Show documentation
package io.github.primelib.jira4j.restv3.api;
import java.util.List;
import java.util.Map;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.annotation.processing.Generated;
import io.github.primelib.jira4j.restv3.model.ActorInputBean;
import io.github.primelib.jira4j.restv3.model.ActorsMap;
import io.github.primelib.jira4j.restv3.model.AddFieldBean;
import io.github.primelib.jira4j.restv3.model.AddGroupBean;
import io.github.primelib.jira4j.restv3.model.AddNotificationsDetails;
import io.github.primelib.jira4j.restv3.model.AddSecuritySchemeLevelsRequestBean;
import io.github.primelib.jira4j.restv3.model.AnnouncementBannerConfiguration;
import io.github.primelib.jira4j.restv3.model.AnnouncementBannerConfigurationUpdate;
import io.github.primelib.jira4j.restv3.model.ApplicationProperty;
import io.github.primelib.jira4j.restv3.model.ApplicationRole;
import io.github.primelib.jira4j.restv3.model.ArchiveIssueAsyncRequest;
import io.github.primelib.jira4j.restv3.model.ArchivedIssuesFilterRequest;
import io.github.primelib.jira4j.restv3.model.AssociateFieldConfigurationsWithIssueTypesRequest;
import io.github.primelib.jira4j.restv3.model.AssociateSecuritySchemeWithProjectDetails;
import io.github.primelib.jira4j.restv3.model.Attachment;
import io.github.primelib.jira4j.restv3.model.AttachmentArchiveImpl;
import io.github.primelib.jira4j.restv3.model.AttachmentArchiveMetadataReadable;
import io.github.primelib.jira4j.restv3.model.AttachmentMetadata;
import io.github.primelib.jira4j.restv3.model.AttachmentSettings;
import io.github.primelib.jira4j.restv3.model.AuditRecords;
import io.github.primelib.jira4j.restv3.model.AutoCompleteSuggestions;
import io.github.primelib.jira4j.restv3.model.AvailableDashboardGadgetsResponse;
import io.github.primelib.jira4j.restv3.model.Avatar;
import io.github.primelib.jira4j.restv3.model.Avatars;
import io.github.primelib.jira4j.restv3.model.BulkCustomFieldOptionCreateRequest;
import io.github.primelib.jira4j.restv3.model.BulkCustomFieldOptionUpdateRequest;
import io.github.primelib.jira4j.restv3.model.BulkEditShareableEntityRequest;
import io.github.primelib.jira4j.restv3.model.BulkEditShareableEntityResponse;
import io.github.primelib.jira4j.restv3.model.BulkIssueIsWatching;
import io.github.primelib.jira4j.restv3.model.BulkIssuePropertyUpdateRequest;
import io.github.primelib.jira4j.restv3.model.BulkPermissionGrants;
import io.github.primelib.jira4j.restv3.model.BulkPermissionsRequestBean;
import io.github.primelib.jira4j.restv3.model.ChangeFilterOwner;
import io.github.primelib.jira4j.restv3.model.ChangedWorklogs;
import io.github.primelib.jira4j.restv3.model.ColumnItem;
import io.github.primelib.jira4j.restv3.model.ColumnRequestBody;
import io.github.primelib.jira4j.restv3.model.Comment;
import io.github.primelib.jira4j.restv3.model.ComponentIssuesCount;
import io.github.primelib.jira4j.restv3.model.Configuration;
import io.github.primelib.jira4j.restv3.model.ConnectCustomFieldValues;
import io.github.primelib.jira4j.restv3.model.ConnectModules;
import io.github.primelib.jira4j.restv3.model.ContainerForProjectFeatures;
import io.github.primelib.jira4j.restv3.model.ContainerForRegisteredWebhooks;
import io.github.primelib.jira4j.restv3.model.ContainerForWebhookIDs;
import io.github.primelib.jira4j.restv3.model.ContainerOfWorkflowSchemeAssociations;
import io.github.primelib.jira4j.restv3.model.ConvertedJQLQueries;
import io.github.primelib.jira4j.restv3.model.CreateCustomFieldContext;
import io.github.primelib.jira4j.restv3.model.CreateIssueSecuritySchemeDetails;
import io.github.primelib.jira4j.restv3.model.CreateNotificationSchemeDetails;
import io.github.primelib.jira4j.restv3.model.CreatePriorityDetails;
import io.github.primelib.jira4j.restv3.model.CreateProjectDetails;
import io.github.primelib.jira4j.restv3.model.CreateResolutionDetails;
import io.github.primelib.jira4j.restv3.model.CreateUiModificationDetails;
import io.github.primelib.jira4j.restv3.model.CreateUpdateRoleRequestBean;
import io.github.primelib.jira4j.restv3.model.CreateWorkflowDetails;
import io.github.primelib.jira4j.restv3.model.CreatedIssue;
import io.github.primelib.jira4j.restv3.model.CreatedIssues;
import io.github.primelib.jira4j.restv3.model.CustomFieldConfigurations;
import io.github.primelib.jira4j.restv3.model.CustomFieldContextDefaultValueUpdate;
import io.github.primelib.jira4j.restv3.model.CustomFieldContextUpdateDetails;
import io.github.primelib.jira4j.restv3.model.CustomFieldCreatedContextOptionsList;
import io.github.primelib.jira4j.restv3.model.CustomFieldDefinitionJsonBean;
import io.github.primelib.jira4j.restv3.model.CustomFieldOption;
import io.github.primelib.jira4j.restv3.model.CustomFieldUpdatedContextOptionsList;
import io.github.primelib.jira4j.restv3.model.CustomFieldValueUpdateDetails;
import io.github.primelib.jira4j.restv3.model.Dashboard;
import io.github.primelib.jira4j.restv3.model.DashboardDetails;
import io.github.primelib.jira4j.restv3.model.DashboardGadget;
import io.github.primelib.jira4j.restv3.model.DashboardGadgetResponse;
import io.github.primelib.jira4j.restv3.model.DashboardGadgetSettings;
import io.github.primelib.jira4j.restv3.model.DashboardGadgetUpdateRequest;
import io.github.primelib.jira4j.restv3.model.DefaultShareScope;
import io.github.primelib.jira4j.restv3.model.DefaultWorkflow;
import io.github.primelib.jira4j.restv3.model.DeleteAndReplaceVersionBean;
import io.github.primelib.jira4j.restv3.model.DeprecatedWorkflow;
import io.github.primelib.jira4j.restv3.model.EntityProperty;
import io.github.primelib.jira4j.restv3.model.EntityPropertyDetails;
import io.github.primelib.jira4j.restv3.model.ErrorCollection;
import io.github.primelib.jira4j.restv3.model.ExportArchivedIssuesTaskProgressResponse;
import io.github.primelib.jira4j.restv3.model.FailedWebhooks;
import io.github.primelib.jira4j.restv3.model.FieldConfiguration;
import io.github.primelib.jira4j.restv3.model.FieldConfigurationDetails;
import io.github.primelib.jira4j.restv3.model.FieldConfigurationItemsDetails;
import io.github.primelib.jira4j.restv3.model.FieldConfigurationScheme;
import io.github.primelib.jira4j.restv3.model.FieldConfigurationSchemeProjectAssociation;
import io.github.primelib.jira4j.restv3.model.FieldDetails;
import io.github.primelib.jira4j.restv3.model.Filter;
import io.github.primelib.jira4j.restv3.model.FoundGroups;
import io.github.primelib.jira4j.restv3.model.FoundUsers;
import io.github.primelib.jira4j.restv3.model.FoundUsersAndGroups;
import io.github.primelib.jira4j.restv3.model.GetWorkflowTransitionRuleConfigurationsRequest;
import io.github.primelib.jira4j.restv3.model.Group;
import io.github.primelib.jira4j.restv3.model.GroupName;
import io.github.primelib.jira4j.restv3.model.IdBean;
import io.github.primelib.jira4j.restv3.model.IssueArchivalSyncRequest;
import io.github.primelib.jira4j.restv3.model.IssueArchivalSyncResponse;
import io.github.primelib.jira4j.restv3.model.IssueBean;
import io.github.primelib.jira4j.restv3.model.IssueChangelogIds;
import io.github.primelib.jira4j.restv3.model.IssueCommentListRequestBean;
import io.github.primelib.jira4j.restv3.model.IssueCreateMetadata;
import io.github.primelib.jira4j.restv3.model.IssueEntityProperties;
import io.github.primelib.jira4j.restv3.model.IssueEvent;
import io.github.primelib.jira4j.restv3.model.IssueFieldOption;
import io.github.primelib.jira4j.restv3.model.IssueFieldOptionCreateBean;
import io.github.primelib.jira4j.restv3.model.IssueFilterForBulkPropertyDelete;
import io.github.primelib.jira4j.restv3.model.IssueLink;
import io.github.primelib.jira4j.restv3.model.IssueLinkType;
import io.github.primelib.jira4j.restv3.model.IssueLinkTypes;
import io.github.primelib.jira4j.restv3.model.IssueList;
import io.github.primelib.jira4j.restv3.model.IssueMatches;
import io.github.primelib.jira4j.restv3.model.IssuePickerSuggestions;
import io.github.primelib.jira4j.restv3.model.IssueTypeCreateBean;
import io.github.primelib.jira4j.restv3.model.IssueTypeDetails;
import io.github.primelib.jira4j.restv3.model.IssueTypeIds;
import io.github.primelib.jira4j.restv3.model.IssueTypeIdsToRemove;
import io.github.primelib.jira4j.restv3.model.IssueTypeSchemeDetails;
import io.github.primelib.jira4j.restv3.model.IssueTypeSchemeID;
import io.github.primelib.jira4j.restv3.model.IssueTypeSchemeProjectAssociation;
import io.github.primelib.jira4j.restv3.model.IssueTypeSchemeUpdateDetails;
import io.github.primelib.jira4j.restv3.model.IssueTypeScreenSchemeDetails;
import io.github.primelib.jira4j.restv3.model.IssueTypeScreenSchemeId;
import io.github.primelib.jira4j.restv3.model.IssueTypeScreenSchemeMappingDetails;
import io.github.primelib.jira4j.restv3.model.IssueTypeScreenSchemeProjectAssociation;
import io.github.primelib.jira4j.restv3.model.IssueTypeScreenSchemeUpdateDetails;
import io.github.primelib.jira4j.restv3.model.IssueTypeUpdateBean;
import io.github.primelib.jira4j.restv3.model.IssueTypeWithStatus;
import io.github.primelib.jira4j.restv3.model.IssueTypeWorkflowMapping;
import io.github.primelib.jira4j.restv3.model.IssueTypesWorkflowMapping;
import io.github.primelib.jira4j.restv3.model.IssueUpdateDetails;
import io.github.primelib.jira4j.restv3.model.IssueUpdateMetadata;
import io.github.primelib.jira4j.restv3.model.IssuesAndJQLQueries;
import io.github.primelib.jira4j.restv3.model.IssuesUpdateBean;
import io.github.primelib.jira4j.restv3.model.JQLPersonalDataMigrationRequest;
import io.github.primelib.jira4j.restv3.model.JQLReferenceData;
import io.github.primelib.jira4j.restv3.model.JiraExpressionEvalRequestBean;
import io.github.primelib.jira4j.restv3.model.JiraExpressionForAnalysis;
import io.github.primelib.jira4j.restv3.model.JiraExpressionResult;
import io.github.primelib.jira4j.restv3.model.JiraExpressionsAnalysis;
import io.github.primelib.jira4j.restv3.model.JiraStatus;
import io.github.primelib.jira4j.restv3.model.JqlFunctionPrecomputationUpdateRequestBean;
import io.github.primelib.jira4j.restv3.model.JqlQueriesToParse;
import io.github.primelib.jira4j.restv3.model.JqlQueriesToSanitize;
import io.github.primelib.jira4j.restv3.model.License;
import io.github.primelib.jira4j.restv3.model.LicenseMetric;
import io.github.primelib.jira4j.restv3.model.LinkIssueRequestJsonBean;
import io.github.primelib.jira4j.restv3.model.Locale;
import io.github.primelib.jira4j.restv3.model.MoveFieldBean;
import io.github.primelib.jira4j.restv3.model.MultiIssueEntityProperties;
import io.github.primelib.jira4j.restv3.model.MultipleCustomFieldValuesUpdateDetails;
import io.github.primelib.jira4j.restv3.model.NewUserDetails;
import io.github.primelib.jira4j.restv3.model.Notification;
import io.github.primelib.jira4j.restv3.model.NotificationScheme;
import io.github.primelib.jira4j.restv3.model.NotificationSchemeId;
import io.github.primelib.jira4j.restv3.model.OperationMessage;
import io.github.primelib.jira4j.restv3.model.OrderOfCustomFieldOptions;
import io.github.primelib.jira4j.restv3.model.OrderOfIssueTypes;
import io.github.primelib.jira4j.restv3.model.PageBeanChangelog;
import io.github.primelib.jira4j.restv3.model.PageBeanComment;
import io.github.primelib.jira4j.restv3.model.PageBeanComponentWithIssueCount;
import io.github.primelib.jira4j.restv3.model.PageBeanContext;
import io.github.primelib.jira4j.restv3.model.PageBeanContextForProjectAndIssueType;
import io.github.primelib.jira4j.restv3.model.PageBeanContextualConfiguration;
import io.github.primelib.jira4j.restv3.model.PageBeanCustomFieldContext;
import io.github.primelib.jira4j.restv3.model.PageBeanCustomFieldContextDefaultValue;
import io.github.primelib.jira4j.restv3.model.PageBeanCustomFieldContextOption;
import io.github.primelib.jira4j.restv3.model.PageBeanCustomFieldContextProjectMapping;
import io.github.primelib.jira4j.restv3.model.PageBeanDashboard;
import io.github.primelib.jira4j.restv3.model.PageBeanField;
import io.github.primelib.jira4j.restv3.model.PageBeanFieldConfigurationDetails;
import io.github.primelib.jira4j.restv3.model.PageBeanFieldConfigurationIssueTypeItem;
import io.github.primelib.jira4j.restv3.model.PageBeanFieldConfigurationItem;
import io.github.primelib.jira4j.restv3.model.PageBeanFieldConfigurationScheme;
import io.github.primelib.jira4j.restv3.model.PageBeanFieldConfigurationSchemeProjects;
import io.github.primelib.jira4j.restv3.model.PageBeanFilterDetails;
import io.github.primelib.jira4j.restv3.model.PageBeanGroupDetails;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueFieldOption;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueSecurityLevelMember;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueSecuritySchemeToProjectMapping;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeScheme;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeSchemeMapping;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeSchemeProjects;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeScreenScheme;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeScreenSchemeItem;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeScreenSchemesProjects;
import io.github.primelib.jira4j.restv3.model.PageBeanIssueTypeToContextMapping;
import io.github.primelib.jira4j.restv3.model.PageBeanJqlFunctionPrecomputationBean;
import io.github.primelib.jira4j.restv3.model.PageBeanNotificationScheme;
import io.github.primelib.jira4j.restv3.model.PageBeanNotificationSchemeAndProjectMappingJsonBean;
import io.github.primelib.jira4j.restv3.model.PageBeanPriority;
import io.github.primelib.jira4j.restv3.model.PageBeanProject;
import io.github.primelib.jira4j.restv3.model.PageBeanProjectDetails;
import io.github.primelib.jira4j.restv3.model.PageBeanResolutionJsonBean;
import io.github.primelib.jira4j.restv3.model.PageBeanScreen;
import io.github.primelib.jira4j.restv3.model.PageBeanScreenScheme;
import io.github.primelib.jira4j.restv3.model.PageBeanScreenWithTab;
import io.github.primelib.jira4j.restv3.model.PageBeanSecurityLevel;
import io.github.primelib.jira4j.restv3.model.PageBeanSecurityLevelMember;
import io.github.primelib.jira4j.restv3.model.PageBeanSecuritySchemeWithProjects;
import io.github.primelib.jira4j.restv3.model.PageBeanString;
import io.github.primelib.jira4j.restv3.model.PageBeanUiModificationDetails;
import io.github.primelib.jira4j.restv3.model.PageBeanUser;
import io.github.primelib.jira4j.restv3.model.PageBeanUserDetails;
import io.github.primelib.jira4j.restv3.model.PageBeanUserKey;
import io.github.primelib.jira4j.restv3.model.PageBeanVersion;
import io.github.primelib.jira4j.restv3.model.PageBeanWebhook;
import io.github.primelib.jira4j.restv3.model.PageBeanWorkflow;
import io.github.primelib.jira4j.restv3.model.PageBeanWorkflowScheme;
import io.github.primelib.jira4j.restv3.model.PageBeanWorkflowTransitionRules;
import io.github.primelib.jira4j.restv3.model.PageOfChangelogs;
import io.github.primelib.jira4j.restv3.model.PageOfComments;
import io.github.primelib.jira4j.restv3.model.PageOfCreateMetaIssueTypeWithField;
import io.github.primelib.jira4j.restv3.model.PageOfCreateMetaIssueTypes;
import io.github.primelib.jira4j.restv3.model.PageOfDashboards;
import io.github.primelib.jira4j.restv3.model.PageOfStatuses;
import io.github.primelib.jira4j.restv3.model.PageOfWorklogs;
import io.github.primelib.jira4j.restv3.model.ParsedJqlQueries;
import io.github.primelib.jira4j.restv3.model.PermissionGrant;
import io.github.primelib.jira4j.restv3.model.PermissionGrants;
import io.github.primelib.jira4j.restv3.model.PermissionScheme;
import io.github.primelib.jira4j.restv3.model.PermissionSchemes;
import io.github.primelib.jira4j.restv3.model.Permissions;
import io.github.primelib.jira4j.restv3.model.PermissionsKeysBean;
import io.github.primelib.jira4j.restv3.model.PermittedProjects;
import io.github.primelib.jira4j.restv3.model.Priority;
import io.github.primelib.jira4j.restv3.model.PriorityId;
import io.github.primelib.jira4j.restv3.model.Project;
import io.github.primelib.jira4j.restv3.model.ProjectAvatars;
import io.github.primelib.jira4j.restv3.model.ProjectCategory;
import io.github.primelib.jira4j.restv3.model.ProjectComponent;
import io.github.primelib.jira4j.restv3.model.ProjectEmailAddress;
import io.github.primelib.jira4j.restv3.model.ProjectFeatureState;
import io.github.primelib.jira4j.restv3.model.ProjectIdentifiers;
import io.github.primelib.jira4j.restv3.model.ProjectIds;
import io.github.primelib.jira4j.restv3.model.ProjectIssueSecurityLevels;
import io.github.primelib.jira4j.restv3.model.ProjectIssueTypeHierarchy;
import io.github.primelib.jira4j.restv3.model.ProjectIssueTypeMappings;
import io.github.primelib.jira4j.restv3.model.ProjectRole;
import io.github.primelib.jira4j.restv3.model.ProjectRoleActorsUpdateBean;
import io.github.primelib.jira4j.restv3.model.ProjectRoleDetails;
import io.github.primelib.jira4j.restv3.model.ProjectType;
import io.github.primelib.jira4j.restv3.model.PropertyKeys;
import io.github.primelib.jira4j.restv3.model.PublishDraftWorkflowScheme;
import io.github.primelib.jira4j.restv3.model.RemoteIssueLink;
import io.github.primelib.jira4j.restv3.model.RemoteIssueLinkIdentifies;
import io.github.primelib.jira4j.restv3.model.RemoteIssueLinkRequest;
import io.github.primelib.jira4j.restv3.model.ReorderIssuePriorities;
import io.github.primelib.jira4j.restv3.model.ReorderIssueResolutionsRequest;
import io.github.primelib.jira4j.restv3.model.Resolution;
import io.github.primelib.jira4j.restv3.model.ResolutionId;
import io.github.primelib.jira4j.restv3.model.SanitizedJqlQueries;
import io.github.primelib.jira4j.restv3.model.Screen;
import io.github.primelib.jira4j.restv3.model.ScreenDetails;
import io.github.primelib.jira4j.restv3.model.ScreenSchemeDetails;
import io.github.primelib.jira4j.restv3.model.ScreenSchemeId;
import io.github.primelib.jira4j.restv3.model.ScreenableField;
import io.github.primelib.jira4j.restv3.model.ScreenableTab;
import io.github.primelib.jira4j.restv3.model.SearchAutoCompleteFilter;
import io.github.primelib.jira4j.restv3.model.SearchRequestBean;
import io.github.primelib.jira4j.restv3.model.SearchResults;
import io.github.primelib.jira4j.restv3.model.SecurityLevel;
import io.github.primelib.jira4j.restv3.model.SecurityScheme;
import io.github.primelib.jira4j.restv3.model.SecuritySchemeId;
import io.github.primelib.jira4j.restv3.model.SecuritySchemeMembersRequest;
import io.github.primelib.jira4j.restv3.model.SecuritySchemes;
import io.github.primelib.jira4j.restv3.model.ServerInformation;
import io.github.primelib.jira4j.restv3.model.ServiceRegistry;
import java.util.Set;
import io.github.primelib.jira4j.restv3.model.SetDefaultLevelsRequest;
import io.github.primelib.jira4j.restv3.model.SetDefaultPriorityRequest;
import io.github.primelib.jira4j.restv3.model.SetDefaultResolutionRequest;
import io.github.primelib.jira4j.restv3.model.SharePermission;
import io.github.primelib.jira4j.restv3.model.SharePermissionInputBean;
import io.github.primelib.jira4j.restv3.model.SimpleApplicationPropertyBean;
import io.github.primelib.jira4j.restv3.model.StatusCategory;
import io.github.primelib.jira4j.restv3.model.StatusCreateRequest;
import io.github.primelib.jira4j.restv3.model.StatusDetails;
import io.github.primelib.jira4j.restv3.model.StatusUpdateRequest;
import io.github.primelib.jira4j.restv3.model.SystemAvatars;
import io.github.primelib.jira4j.restv3.model.TaskProgressBeanObject;
import io.github.primelib.jira4j.restv3.model.TimeTrackingConfiguration;
import io.github.primelib.jira4j.restv3.model.TimeTrackingProvider;
import io.github.primelib.jira4j.restv3.model.Transitions;
import java.net.URI;
import java.util.UUID;
import io.github.primelib.jira4j.restv3.model.UiModificationIdentifiers;
import io.github.primelib.jira4j.restv3.model.UnrestrictedUserEmail;
import io.github.primelib.jira4j.restv3.model.UpdateCustomFieldDetails;
import io.github.primelib.jira4j.restv3.model.UpdateDefaultScreenScheme;
import io.github.primelib.jira4j.restv3.model.UpdateFieldConfigurationSchemeDetails;
import io.github.primelib.jira4j.restv3.model.UpdateIssueSecurityLevelDetails;
import io.github.primelib.jira4j.restv3.model.UpdateIssueSecuritySchemeRequestBean;
import io.github.primelib.jira4j.restv3.model.UpdateNotificationSchemeDetails;
import io.github.primelib.jira4j.restv3.model.UpdatePriorityDetails;
import io.github.primelib.jira4j.restv3.model.UpdateProjectDetails;
import io.github.primelib.jira4j.restv3.model.UpdateResolutionDetails;
import io.github.primelib.jira4j.restv3.model.UpdateScreenDetails;
import io.github.primelib.jira4j.restv3.model.UpdateScreenSchemeDetails;
import io.github.primelib.jira4j.restv3.model.UpdateUiModificationDetails;
import io.github.primelib.jira4j.restv3.model.UpdateUserToGroupBean;
import io.github.primelib.jira4j.restv3.model.UpdatedProjectCategory;
import io.github.primelib.jira4j.restv3.model.User;
import io.github.primelib.jira4j.restv3.model.UserColumnRequestBody;
import io.github.primelib.jira4j.restv3.model.UserMigrationBean;
import io.github.primelib.jira4j.restv3.model.Version;
import io.github.primelib.jira4j.restv3.model.VersionIssueCounts;
import io.github.primelib.jira4j.restv3.model.VersionMoveBean;
import io.github.primelib.jira4j.restv3.model.VersionRelatedWork;
import io.github.primelib.jira4j.restv3.model.VersionUnresolvedIssuesCount;
import io.github.primelib.jira4j.restv3.model.Votes;
import io.github.primelib.jira4j.restv3.model.Watchers;
import io.github.primelib.jira4j.restv3.model.WebhookRegistrationDetails;
import io.github.primelib.jira4j.restv3.model.WebhooksExpirationDate;
import io.github.primelib.jira4j.restv3.model.WorkflowCapabilities;
import io.github.primelib.jira4j.restv3.model.WorkflowCreateRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowCreateResponse;
import io.github.primelib.jira4j.restv3.model.WorkflowCreateValidateRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowIDs;
import io.github.primelib.jira4j.restv3.model.WorkflowReadRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowReadResponse;
import io.github.primelib.jira4j.restv3.model.WorkflowRulesSearch;
import io.github.primelib.jira4j.restv3.model.WorkflowRulesSearchDetails;
import io.github.primelib.jira4j.restv3.model.WorkflowScheme;
import io.github.primelib.jira4j.restv3.model.WorkflowSchemeProjectAssociation;
import io.github.primelib.jira4j.restv3.model.WorkflowSchemeReadRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowSchemeReadResponse;
import io.github.primelib.jira4j.restv3.model.WorkflowSchemeUpdateRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowSchemeUpdateRequiredMappingsRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowSchemeUpdateRequiredMappingsResponse;
import io.github.primelib.jira4j.restv3.model.WorkflowTransitionProperty;
import io.github.primelib.jira4j.restv3.model.WorkflowTransitionRulesUpdate;
import io.github.primelib.jira4j.restv3.model.WorkflowTransitionRulesUpdateErrors;
import io.github.primelib.jira4j.restv3.model.WorkflowUpdateRequest;
import io.github.primelib.jira4j.restv3.model.WorkflowUpdateResponse;
import io.github.primelib.jira4j.restv3.model.WorkflowUpdateValidateRequestBean;
import io.github.primelib.jira4j.restv3.model.WorkflowValidationErrorList;
import io.github.primelib.jira4j.restv3.model.WorkflowsWithTransitionRulesDetails;
import io.github.primelib.jira4j.restv3.model.Worklog;
import io.github.primelib.jira4j.restv3.model.WorklogIdsRequestBean;
import feign.RequestLine;
import feign.Param;
import feign.Headers;
@Generated(value = "io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public interface JiraRESTV3Api {
/**
* Add actors to project role
*
* Adds actors to a project role for the project.
* To replace all actors for the project, use [Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param actorsMap The groups or users to associate with the project role for this project. Provide the user account ID, group name, or group ID. As a group's name can change, use of group ID is recommended. (required)
*/
@RequestLine("POST /rest/api/3/project/{projectIdOrKey}/role/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectRole addActorUsers(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("id") @NotNull Long id, @NotNull ActorsMap actorsMap);
/**
* Add attachment
*
* Adds one or more attachments to an issue. Attachments are posted as multipart/form-data ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)).
* Note that:
* *
* The request must have a {@code X-Atlassian-Token: no-check} header, if not it is blocked. See [Special headers](#special-request-headers) for more information.
* *
* The name of the multipart/form-data parameter that contains the attachments must be {@code file}.
* The following examples upload a file called *myfile.txt* to the issue *TEST-123*:
* #### curl ####
*
*
* curl --location --request POST 'https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments'
*
*
* -u '[email protected]:<api_token>'
*
*
* -H 'X-Atlassian-Token: no-check'
*
*
* --form 'file=@"myfile.txt"'
* #### Node.js ####
*
*
* // This code sample uses the 'node-fetch' and 'form-data' libraries:
*
*
* // https://www.npmjs.com/package/node-fetch
*
*
* // https://www.npmjs.com/package/form-data
*
*
* const fetch = require('node-fetch');
*
*
* const FormData = require('form-data');
*
*
* const fs = require('fs');
*
*
*
*
* const filePath = 'myfile.txt';
*
*
* const form = new FormData();
*
*
* const stats = fs.statSync(filePath);
*
*
* const fileSizeInBytes = stats.size;
*
*
* const fileStream = fs.createReadStream(filePath);
*
*
*
*
* form.append('file', fileStream, {knownLength: fileSizeInBytes});
*
*
*
*
* fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments', {
*
*
*
*
* method: 'POST',
*
*
*
*
* body: form,
*
*
*
*
* headers: {
*
*
*
*
*
*
* 'Authorization': `Basic ${Buffer.from(
*
*
*
*
*
*
*
*
* '[email protected]:'
*
*
*
*
*
*
* ).toString('base64')}`,
*
*
*
*
*
*
* 'Accept': 'application/json',
*
*
*
*
*
*
* 'X-Atlassian-Token': 'no-check'
*
*
*
*
* }
*
*
* })
*
*
*
*
* .then(response => {
*
*
*
*
*
*
* console.log(
*
*
*
*
*
*
*
*
* {@code Response: ${response.status} ${response.statusText}}
*
*
*
*
*
*
* );
*
*
*
*
*
*
* return response.text();
*
*
*
*
* })
*
*
*
*
* .then(text => console.log(text))
*
*
*
*
* .catch(err => console.error(err));
* #### Java ####
*
*
* // This code sample uses the
* 'Unirest' library:
*
*
* // http://unirest.io/java.html
*
*
* HttpResponse response = Unirest.post("https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments")
*
*
*
*
*
*
* .basicAuth("[email protected]", "")
*
*
*
*
*
*
* .header("Accept", "application/json")
*
*
*
*
*
*
* .header("X-Atlassian-Token", "no-check")
*
*
*
*
*
*
* .field("file", new File("myfile.txt"))
*
*
*
*
*
*
* .asJson();
*
*
*
*
*
*
*
*
* System.out.println(response.getBody());
* #### Python ####
*
*
* # This code sample uses the 'requests' library:
*
*
* # http://docs.python-requests.org
*
*
* import requests
*
*
* from requests.auth import HTTPBasicAuth
*
*
* import json
*
*
*
*
* url = "https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments"
*
*
*
*
* auth = HTTPBasicAuth("[email protected]", "")
*
*
*
*
* headers = {
*
*
*
* "Accept": "application/json",
*
*
*
* "X-Atlassian-Token": "no-check"
*
*
* }
*
*
*
*
* response = requests.request(
*
*
*
* "POST",
*
*
*
* url,
*
*
*
* headers = headers,
*
*
*
* auth = auth,
*
*
*
* files = {
*
*
*
*
*
*
* "file": ("myfile.txt", open("myfile.txt","rb"), "application-type")
*
*
*
* }
*
*
* )
*
*
*
*
* print(json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(",", ": ")))
* #### PHP ####
*
*
* // This code sample uses the 'Unirest' library:
*
*
* // http://unirest.io/php.html
*
*
* Unirest\\Request::auth('[email protected]', '');
*
*
*
*
* $headers = array(
*
*
*
* 'Accept' => 'application/json',
*
*
*
* 'X-Atlassian-Token' => 'no-check'
*
*
* );
*
*
*
*
* $parameters = array(
*
*
*
* 'file' => File::add('myfile.txt')
*
*
* );
*
*
*
*
* $response = Unirest\\Request::post(
*
*
*
* 'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',
*
*
*
* $headers,
*
*
*
* $parameters
*
*
* );
*
*
*
*
* var_dump($response)
* #### Forge ####
*
*
* // This sample uses Atlassian Forge and the {@code form-data} library.
*
*
* // https://developer.atlassian.com/platform/forge/
*
*
* // https://www.npmjs.com/package/form-data
*
*
* import api from "@forge/api";
*
*
* import FormData from "form-data";
*
*
*
*
* const form = new FormData();
*
*
* form.append('file', fileStream, {knownLength: fileSizeInBytes});
*
*
*
*
* const response = await api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', {
*
*
*
*
* method: 'POST',
*
*
*
*
* body: form,
*
*
*
*
* headers: {
*
*
*
*
*
*
* 'Accept': 'application/json',
*
*
*
*
*
*
* 'X-Atlassian-Token': 'no-check'
*
*
*
*
* }
*
*
* });
*
*
*
*
* console.log({@code Response: ${response.status} ${response.statusText}});
*
*
* console.log(await response.json());
* Tip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) class for multipart POST operations.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
*
* *
* *Browse Projects* and *Create attachments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue that attachments are added to. (required)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/attachments")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json"
})
List addAttachment(@Param("issueIdOrKey") @NotNull String issueIdOrKey);
/**
* Add comment
*
* Adds a comment to an issue.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param comment (required)
* @param expand Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts {@code renderedBody}, which returns the comment body rendered in HTML. (optional)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/comment?expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Comment addComment(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull Comment comment, @Param("expand") @Nullable String expand);
/**
* Add field to default screen
*
* Adds a field to the default tab of the default screen.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param fieldId The ID of the field. (required)
*/
@RequestLine("POST /rest/api/3/screens/addToDefault/{fieldId}")
@Headers({
"Accept: application/json"
})
Object addFieldToDefaultScreen(@Param("fieldId") @NotNull String fieldId);
/**
* Add gadget to dashboard
*
* Adds a gadget to a dashboard.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [write:jira-work, read:jira-work]
* @param dashboardId The ID of the dashboard. (required)
* @param dashboardGadgetSettings (required)
*/
@RequestLine("POST /rest/api/3/dashboard/{dashboardId}/gadget")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
DashboardGadget addGadget(@Param("dashboardId") @NotNull Long dashboardId, @NotNull DashboardGadgetSettings dashboardGadgetSettings);
/**
* Add issue types to context
*
* Adds issue types to a custom field context, appending the issue types to the issue types list.
* A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types.
* If any of the issue types exists in the custom field context, the operation fails and no issue types are added.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context. (required)
* @param issueTypeIds (required)
*/
@RequestLine("PUT /rest/api/3/field/{fieldId}/context/{contextId}/issuetype")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object addIssueTypesToContext(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @NotNull Long contextId, @NotNull IssueTypeIds issueTypeIds);
/**
* Add issue types to issue type scheme
*
* Adds issue types to an issue type scheme.
* The added issue types are appended to the issue types list.
* If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeSchemeId The ID of the issue type scheme. (required)
* @param issueTypeIds (required)
*/
@RequestLine("PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object addIssueTypesToIssueTypeScheme(@Param("issueTypeSchemeId") @NotNull Long issueTypeSchemeId, @NotNull IssueTypeIds issueTypeIds);
/**
* Add notifications to notification scheme
*
* Adds notifications to a notification scheme. You can add up to 1000 notifications per request.
* *Deprecated: The notification type {@code EmailAddress} is no longer supported in Cloud. Refer to the [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details.*
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the notification scheme. (required)
* @param addNotificationsDetails (required)
*/
@RequestLine("PUT /rest/api/3/notificationscheme/{id}/notification")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object addNotifications(@Param("id") @NotNull String id, @NotNull AddNotificationsDetails addNotificationsDetails);
/**
* Add default actors to project role
*
* Adds [default actors](#api-rest-api-3-resolution-get) to a role. You may add groups or users, but you cannot add groups and users in the same request.
* Changing a project role's default actors does not affect project role members for projects already created.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param actorInputBean (required)
*/
@RequestLine("POST /rest/api/3/role/{id}/actors")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectRole addProjectRoleActorsToRole(@Param("id") @NotNull Long id, @NotNull ActorInputBean actorInputBean);
/**
* Create screen tab
*
* Creates a tab for a screen.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
* @param screenableTab (required)
*/
@RequestLine("POST /rest/api/3/screens/{screenId}/tabs")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ScreenableTab addScreenTab(@Param("screenId") @NotNull Long screenId, @NotNull ScreenableTab screenableTab);
/**
* Add screen tab field
*
* Adds a field to a screen tab.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @param addFieldBean (required)
*/
@RequestLine("POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ScreenableField addScreenTabField(@Param("screenId") @NotNull Long screenId, @Param("tabId") @NotNull Long tabId, @NotNull AddFieldBean addFieldBean);
/**
* Add issue security levels
*
* Adds levels and levels' members to the issue security scheme. You can add up to 100 levels per request.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param schemeId The ID of the issue security scheme. (required)
* @param addSecuritySchemeLevelsRequestBean (required)
*/
@RequestLine("PUT /rest/api/3/issuesecurityschemes/{schemeId}/level")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object addSecurityLevel(@Param("schemeId") @NotNull String schemeId, @NotNull AddSecuritySchemeLevelsRequestBean addSecuritySchemeLevelsRequestBean);
/**
* Add issue security level members
*
* Adds members to the issue security level. You can add up to 100 members per request.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param schemeId The ID of the issue security scheme. (required)
* @param levelId The ID of the issue security level. (required)
* @param securitySchemeMembersRequest (required)
*/
@RequestLine("PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object addSecurityLevelMembers(@Param("schemeId") @NotNull String schemeId, @Param("levelId") @NotNull String levelId, @NotNull SecuritySchemeMembersRequest securitySchemeMembersRequest);
/**
* Add share permission
*
* Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.
* Be aware that this operation uses different objects for updating share permissions compared to [Update filter](#api-rest-api-3-filter-id-put).
* **[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter.
*
* Authentication - Required Scopes: [write:jira-work]
* @param id The ID of the filter. (required)
* @param sharePermissionInputBean (required)
*/
@RequestLine("POST /rest/api/3/filter/{id}/permission")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
List addSharePermission(@Param("id") @NotNull Long id, @NotNull SharePermissionInputBean sharePermissionInputBean);
/**
* Add user to group
*
* Adds a user to a group.
* **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param updateUserToGroupBean The user to add to the group. (required)
* @param groupname As a group's name can change, use of {@code groupId} is recommended to identify a group. The name of the group. This parameter cannot be used with the {@code groupId} parameter. (optional)
* @param groupId The ID of the group. This parameter cannot be used with the {@code groupName} parameter. (optional)
*/
@RequestLine("POST /rest/api/3/group/user?groupname={groupname}&groupId={groupId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Group addUserToGroup(@NotNull UpdateUserToGroupBean updateUserToGroupBean, @Param("groupname") @Nullable String groupname, @Param("groupId") @Nullable String groupId);
/**
* Add vote
*
* Adds the user's vote to an issue. This is the equivalent of the user clicking *Vote* on an issue in Jira.
* This operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/votes")
@Headers({
"Accept: application/json"
})
Object addVote(@Param("issueIdOrKey") @NotNull String issueIdOrKey);
/**
* Add watcher
*
* Adds a user as a watcher of an issue by passing the account ID of the user. For example, {@code "5b10ac8d82e05b22cc7d4ef5"}. If no user is specified the calling user is added.
* This operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* To add users other than themselves to the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param body The account ID of the user. Note that username cannot be used due to privacy changes. (required)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/watchers")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object addWatcher(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull String body);
/**
* Add worklog
*
* Adds a worklog to an issue.
* Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key the issue. (required)
* @param worklog (required)
* @param notifyUsers Whether users watching the issue are notified by email. (optional, defaults to true)
* @param adjustEstimate Defines how to update the issue's time estimate, the options are: * {@code new} Sets the estimate to a specific value, defined in {@code newEstimate}. * {@code leave} Leaves the estimate unchanged. * {@code manual} Reduces the estimate by amount specified in {@code reduceBy}. * {@code auto} Reduces the estimate by the value of {@code timeSpent} in the worklog. (optional, defaults to auto)
* @param newEstimate The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when {@code adjustEstimate} is {@code new}. (optional)
* @param reduceBy The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when {@code adjustEstimate} is {@code manual}. (optional)
* @param expand Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts {@code properties}, which returns worklog properties. (optional)
* @param overrideEditableFlag Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. (optional, defaults to false)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/worklog?notifyUsers={notifyUsers}&adjustEstimate={adjustEstimate}&newEstimate={newEstimate}&reduceBy={reduceBy}&expand={expand}&overrideEditableFlag={overrideEditableFlag}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Worklog addWorklog(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull Worklog worklog, @Param("notifyUsers") @Nullable Boolean notifyUsers, @Param("adjustEstimate") @Nullable String adjustEstimate, @Param("newEstimate") @Nullable String newEstimate, @Param("reduceBy") @Nullable String reduceBy, @Param("expand") @Nullable String expand, @Param("overrideEditableFlag") @Nullable Boolean overrideEditableFlag);
/**
* Delete app property
*
* Deletes an app's property.
* **[Permissions](#permissions) required:** Only a Connect app whose key matches {@code addonKey} can make this request.
*
* @param addonKey The key of the app, as defined in its descriptor. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("DELETE /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void addonPropertiesResourceDeleteAddonPropertyDelete(@Param("addonKey") @NotNull String addonKey, @Param("propertyKey") @NotNull String propertyKey);
/**
* Delete app property (Forge)
*
* Deletes a Forge app's property.
* **[Permissions](#permissions) required:** Only Forge apps can make this request.
*
* @param propertyKey The key of the property. (required)
*/
@RequestLine("DELETE /rest/forge/1/app/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void addonPropertiesResourceDeleteAppPropertyDelete(@Param("propertyKey") @NotNull String propertyKey);
/**
* Get app properties
*
* Gets all the properties of an app.
* **[Permissions](#permissions) required:** Only a Connect app whose key matches {@code addonKey} can make this request. Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were [migrated from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
*
* @param addonKey The key of the app, as defined in its descriptor. (required)
*/
@RequestLine("GET /rest/atlassian-connect/1/addons/{addonKey}/properties")
@Headers({
"Accept: application/json"
})
PropertyKeys addonPropertiesResourceGetAddonPropertiesGet(@Param("addonKey") @NotNull String addonKey);
/**
* Get app property
*
* Returns the key and value of an app's property.
* **[Permissions](#permissions) required:** Only a Connect app whose key matches {@code addonKey} can make this request. Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were [migrated from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
*
* @param addonKey The key of the app, as defined in its descriptor. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("GET /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
EntityProperty addonPropertiesResourceGetAddonPropertyGet(@Param("addonKey") @NotNull String addonKey, @Param("propertyKey") @NotNull String propertyKey);
/**
* Set app property
*
* Sets the value of an app's property. Use this resource to store custom data for your app.
* The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
* **[Permissions](#permissions) required:** Only a Connect app whose key matches {@code addonKey} can make this request.
*
* @param addonKey The key of the app, as defined in its descriptor. (required)
* @param propertyKey The key of the property. (required)
* @param body (required)
*/
@RequestLine("PUT /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
OperationMessage addonPropertiesResourcePutAddonPropertyPut(@Param("addonKey") @NotNull String addonKey, @Param("propertyKey") @NotNull String propertyKey, @NotNull Object body);
/**
* Set app property (Forge)
*
* Sets the value of a Forge app's property. These values can be retrieved in [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/) through the {@code app} [context variable](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables).
* For other use cases, use the [Storage API](https://developer.atlassian.com/platform/forge/runtime-reference/storage-api/).
* The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
* **[Permissions](#permissions) required:** Only Forge apps can make this request.
*
* @param propertyKey The key of the property. (required)
* @param body (required)
*/
@RequestLine("PUT /rest/forge/1/app/properties/{propertyKey}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
OperationMessage addonPropertiesResourcePutAppPropertyPut(@Param("propertyKey") @NotNull String propertyKey, @NotNull Object body);
/**
* Analyse Jira expression
*
* Analyses and validates Jira expressions.
* As an experimental feature, this operation can also attempt to type-check the expressions.
* Learn more about Jira expressions in the [documentation](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
* **[Permissions](#permissions) required**: None.
*
* Authentication - Required Scopes: [read:jira-work, read:jira-user]
* @param jiraExpressionForAnalysis The Jira expressions to analyse. (required)
* @param check The check to perform: * {@code syntax} Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length. * {@code type} EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check. * {@code complexity} EXPERIMENTAL. Determines the formulae for how many [expensive operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each expression may execute. (optional, defaults to syntax)
*/
@RequestLine("POST /rest/api/3/expression/analyse?check={check}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
JiraExpressionsAnalysis analyseExpression(@NotNull JiraExpressionForAnalysis jiraExpressionForAnalysis, @Param("check") @Nullable String check);
/**
* Bulk update custom field value
*
* Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated.
* **[Permissions](#permissions) required:** Only Connect apps can make this request
*
* @param atlassianTransferId The ID of the transfer. (required)
* @param connectCustomFieldValues (required)
*/
@RequestLine("PUT /rest/atlassian-connect/1/migration/field")
@Headers({
"Atlassian-Transfer-Id: {atlassianTransferId}",
"Content-Type: application/json",
"Accept: application/json"
})
Object appIssueFieldValueUpdateResourceUpdateIssueFieldsPut(@Param("atlassianTransferId") @NotNull UUID atlassianTransferId, @NotNull ConnectCustomFieldValues connectCustomFieldValues);
/**
* Append mappings to issue type screen scheme
*
* Appends issue type to screen scheme mappings to an issue type screen scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeScreenSchemeId The ID of the issue type screen scheme. (required)
* @param issueTypeScreenSchemeMappingDetails (required)
*/
@RequestLine("PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object appendMappingsForIssueTypeScreenScheme(@Param("issueTypeScreenSchemeId") @NotNull String issueTypeScreenSchemeId, @NotNull IssueTypeScreenSchemeMappingDetails issueTypeScreenSchemeMappingDetails);
/**
* Archive issue(s) by issue ID/key
*
* 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.
* **Note that:**
* *
* you can't archive subtasks directly, only through their parent issues
* *
* you can only archive issues from software, service management, and business projects
* **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
* **License required:** Premium or Enterprise
* **Signed-in users only:** This API can't be accessed anonymously.
*
*
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueArchivalSyncRequest Contains a list of issue keys or IDs to be archived. (required)
*/
@RequestLine("PUT /rest/api/3/issue/archive")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
IssueArchivalSyncResponse archiveIssues(@NotNull IssueArchivalSyncRequest issueArchivalSyncRequest);
/**
* Archive issue(s) by JQL
*
* 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.
* You can use the [get task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) and [cancel task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post) APIs to manage the request.
* **Note that:**
* *
* you can't archive subtasks directly, only through their parent issues
* *
* you can only archive issues from software, service management, and business projects
* **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
* **License required:** Premium or Enterprise
* **Signed-in users only:** This API can't be accessed anonymously.
* **Rate limiting:** Only a single request per jira instance can be active at any given time.
*
*
*
* Authentication - Required Scopes: [write:jira-work]
* @param archiveIssueAsyncRequest A JQL query specifying the issues to archive. Note that subtasks can only be archived through their parent issues. (required)
*/
@RequestLine("POST /rest/api/3/issue/archive")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
String archiveIssuesAsync(@NotNull ArchiveIssueAsyncRequest archiveIssueAsyncRequest);
/**
* Archive project
*
* 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.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
*/
@RequestLine("POST /rest/api/3/project/{projectIdOrKey}/archive")
@Headers({
"Accept: application/json"
})
Object archiveProject(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Assign field configuration scheme to project
*
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is {@code null}, the operation assigns the default field configuration scheme.
* Field configuration schemes can only be assigned to classic projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldConfigurationSchemeProjectAssociation (required)
*/
@RequestLine("PUT /rest/api/3/fieldconfigurationscheme/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object assignFieldConfigurationSchemeToProject(@NotNull FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation);
/**
* Assign issue
*
* 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.
* If {@code name} or {@code accountId} is set to:
* *
* {@code "-1"}, the issue is assigned to the default assignee for the project.
* *
* {@code null}, the issue is set to unassigned.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse Projects* and *Assign Issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue to be assigned. (required)
* @param user The request object with the user that the issue is assigned to. (required)
*/
@RequestLine("PUT /rest/api/3/issue/{issueIdOrKey}/assignee")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object assignIssue(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull User user);
/**
* Assign issue type scheme to project
*
* Assigns an issue type scheme to a project.
* If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.
* Issue type schemes can only be assigned to classic projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeSchemeProjectAssociation (required)
*/
@RequestLine("PUT /rest/api/3/issuetypescheme/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object assignIssueTypeSchemeToProject(@NotNull IssueTypeSchemeProjectAssociation issueTypeSchemeProjectAssociation);
/**
* Assign issue type screen scheme to project
*
* Assigns an issue type screen scheme to a project.
* Issue type screen schemes can only be assigned to classic projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeScreenSchemeProjectAssociation (required)
*/
@RequestLine("PUT /rest/api/3/issuetypescreenscheme/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object assignIssueTypeScreenSchemeToProject(@NotNull IssueTypeScreenSchemeProjectAssociation issueTypeScreenSchemeProjectAssociation);
/**
* Assign permission scheme
*
* Assigns a permission scheme with a project. See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectKeyOrId The project ID or project key (case sensitive). (required)
* @param idBean (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code permissions} Returns all permission grants for each permission scheme. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("PUT /rest/api/3/project/{projectKeyOrId}/permissionscheme?expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PermissionScheme assignPermissionScheme(@Param("projectKeyOrId") @NotNull String projectKeyOrId, @NotNull IdBean idBean, @Param("expand") @Nullable String expand);
/**
* Assign custom field context to projects
*
* Assigns a custom field context to projects.
* If any project in the request is assigned to any context of the custom field, the operation fails.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context. (required)
* @param projectIds (required)
*/
@RequestLine("PUT /rest/api/3/field/{fieldId}/context/{contextId}/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object assignProjectsToCustomFieldContext(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @NotNull Long contextId, @NotNull ProjectIds projectIds);
/**
* Assign workflow scheme to project
*
* Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.
* Workflow schemes can only be assigned to classic projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param workflowSchemeProjectAssociation (required)
*/
@RequestLine("PUT /rest/api/3/workflowscheme/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object assignSchemeToProject(@NotNull WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation);
/**
* Associate security scheme to project
*
* Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided.
* This operation is [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param associateSecuritySchemeWithProjectDetails (required)
*/
@RequestLine("PUT /rest/api/3/issuesecurityschemes/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void associateSchemesToProjects(@NotNull AssociateSecuritySchemeWithProjectDetails associateSecuritySchemeWithProjectDetails);
/**
* Bulk delete issue property
*
* Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.
* The criteria the filter used to identify eligible issues are:
* *
* {@code entityIds} Only issues from this list are eligible.
* *
* {@code currentValue} Only issues with the property set to this value are eligible.
* If both criteria is specified, they are joined with the logical *AND*: only issues that satisfy both criteria are considered eligible.
* If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT\\_ISSUES permission for the issue are considered eligible.
* This operation is:
* *
* transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
* *
* [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [ project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param propertyKey The key of the property. (required)
* @param issueFilterForBulkPropertyDelete (required)
*/
@RequestLine("DELETE /rest/api/3/issue/properties/{propertyKey}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void bulkDeleteIssueProperty(@Param("propertyKey") @NotNull String propertyKey, @NotNull IssueFilterForBulkPropertyDelete issueFilterForBulkPropertyDelete);
/**
* Bulk edit dashboards
*
* Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100.
* **[Permissions](#permissions) required:** None
* The dashboards to be updated must be owned by the user, or the user must be an administrator.
*
* Authentication - Required Scopes: [write:jira-work]
* @param bulkEditShareableEntityRequest The details of dashboards being updated in bulk. (required)
*/
@RequestLine("PUT /rest/api/3/dashboard/bulk/edit")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
BulkEditShareableEntityResponse bulkEditDashboards(@NotNull BulkEditShareableEntityRequest bulkEditShareableEntityRequest);
/**
* Bulk get groups
*
* Returns a [paginated](#pagination) list of groups.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-user]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param groupId The ID of a group. To specify multiple IDs, pass multiple {@code groupId} parameters. For example, {@code groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5}. (optional)
* @param groupName The name of a group. To specify multiple names, pass multiple {@code groupName} parameters. For example, {@code groupName=administrators&groupName=jira-software-users}. (optional)
* @param accessType The access level of a group. Valid values: 'site-admin', 'admin', 'user'. (optional)
* @param applicationKey The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'. (optional)
*/
@RequestLine("GET /rest/api/3/group/bulk?startAt={startAt}&maxResults={maxResults}&groupId={groupId}&groupName={groupName}&accessType={accessType}&applicationKey={applicationKey}")
@Headers({
"Accept: application/json"
})
PageBeanGroupDetails bulkGetGroups(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("groupId") @Nullable Set groupId, @Param("groupName") @Nullable Set groupName, @Param("accessType") @Nullable String accessType, @Param("applicationKey") @Nullable String applicationKey);
/**
* Bulk get users
*
* Returns a [paginated](#pagination) list of the users specified by one or more account IDs.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-user]
* @param accountId The account ID of a user. To specify multiple users, pass multiple {@code accountId} parameters. For example, {@code accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5}. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 10)
* @param username This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param key This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
*/
@RequestLine("GET /rest/api/3/user/bulk?startAt={startAt}&maxResults={maxResults}&username={username}&key={key}&accountId={accountId}")
@Headers({
"Accept: application/json"
})
PageBeanUser bulkGetUsers(@Param("accountId") @NotNull List accountId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("username") @Nullable List username, @Param("key") @Nullable List key);
/**
* Get account IDs for users
*
* Returns the account IDs for the users specified in the {@code key} or {@code username} parameters. Note that multiple {@code key} or {@code username} parameters can be specified.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-user]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 10)
* @param username Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, {@code username=fred&username=barney}. Required if {@code key} isn't provided. Cannot be provided if {@code key} is present. (optional)
* @param key Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, {@code key=fred&key=barney}. Required if {@code username} isn't provided. Cannot be provided if {@code username} is present. (optional)
*/
@RequestLine("GET /rest/api/3/user/bulk/migration?startAt={startAt}&maxResults={maxResults}&username={username}&key={key}")
@Headers({
"Accept: application/json"
})
List bulkGetUsersMigration(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("username") @Nullable List username, @Param("key") @Nullable List key);
/**
* Bulk set issue properties by issue
*
* Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up to 100 issues included in the request.
* The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON.
* This operation is:
* *
* [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* *
* non-transactional. Updating some entities may fail. Such information will available in the task result.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param multiIssueEntityProperties Details of the issue properties to be set or updated. Note that if an issue is not found, it is ignored. (required)
*/
@RequestLine("POST /rest/api/3/issue/properties/multi")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void bulkSetIssuePropertiesByIssue(@NotNull MultiIssueEntityProperties multiIssueEntityProperties);
/**
* Bulk set issue property
*
* Sets a property value on multiple issues.
* The value set can be a constant or determined by a [Jira expression](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/). Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the [restrictions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions) that apply to all Jira expressions.
* The issues to be updated can be specified by a filter.
* The filter identifies issues eligible for update using these criteria:
* *
* {@code entityIds} Only issues from this list are eligible.
* *
* {@code currentValue} Only issues with the property set to this value are eligible.
* *
* {@code hasProperty}:
*
*
*
*
* *
* If *true*, only issues with the property are eligible.
*
*
* *
* If *false*, only issues without the property are eligible.
* If more than one criteria is specified, they are joined with the logical *AND*: only issues that satisfy all criteria are eligible.
* If an invalid combination of criteria is provided, an error is returned. For example, specifying a {@code currentValue} and {@code hasProperty} as *false* would not match any issues (because without the property the property cannot have a value).
* The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT\\_ISSUES permission for the issue are considered eligible.
* This operation is:
* *
* transactional, either all eligible issues are updated or, when errors occur, none are updated.
* *
* [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param propertyKey The key of the property. The maximum length is 255 characters. (required)
* @param bulkIssuePropertyUpdateRequest (required)
*/
@RequestLine("PUT /rest/api/3/issue/properties/{propertyKey}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void bulkSetIssueProperty(@Param("propertyKey") @NotNull String propertyKey, @NotNull BulkIssuePropertyUpdateRequest bulkIssuePropertyUpdateRequest);
/**
* Bulk set issues properties by list
*
* Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified along with up to 10,000 issues on which to set or update that list of entity properties.
* The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously.
* This operation is:
* *
* transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated.
* *
* [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueEntityProperties Issue properties to be set or updated with values. (required)
*/
@RequestLine("POST /rest/api/3/issue/properties")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void bulkSetIssuesPropertiesList(@NotNull IssueEntityProperties issueEntityProperties);
/**
* Cancel task
*
* Cancels a task.
* **[Permissions](#permissions) required:** either of:
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* *
* Creator of the task.
*
* Authentication - Required Scopes: [write:jira-work]
* @param taskId The ID of the task. (required)
*/
@RequestLine("POST /rest/api/3/task/{taskId}/cancel")
@Headers({
"Accept: application/json"
})
Object cancelTask(@Param("taskId") @NotNull String taskId);
/**
* Change filter owner
*
* Changes the owner of the filter.
* **[Permissions](#permissions) required:** Permission to access Jira. However, the user must own the filter or have the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [write:jira-work]
* @param id The ID of the filter to update. (required)
* @param changeFilterOwner The account ID of the new owner of the filter. (required)
*/
@RequestLine("PUT /rest/api/3/filter/{id}/owner")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object changeFilterOwner(@Param("id") @NotNull Long id, @NotNull ChangeFilterOwner changeFilterOwner);
/**
* Copy dashboard
*
* Copies a dashboard. Any values provided in the {@code dashboard} parameter replace those in the copied dashboard.
* **[Permissions](#permissions) required:** None
* The dashboard to be copied must be owned by or shared with the user.
*
* Authentication - Required Scopes: [write:jira-work]
* @param id (required)
* @param dashboardDetails Dashboard details. (required)
*/
@RequestLine("POST /rest/api/3/dashboard/{id}/copy")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Dashboard copyDashboard(@Param("id") @NotNull String id, @NotNull DashboardDetails dashboardDetails);
/**
* Create component
*
* Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectComponent (required)
*/
@RequestLine("POST /rest/api/3/component")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectComponent createComponent(@NotNull ProjectComponent projectComponent);
/**
* Create custom field
*
* Creates a custom field.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param customFieldDefinitionJsonBean Definition of the custom field to be created (required)
*/
@RequestLine("POST /rest/api/3/field")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
FieldDetails createCustomField(@NotNull CustomFieldDefinitionJsonBean customFieldDefinitionJsonBean);
/**
* Create custom field context
*
* Creates a custom field context.
* If {@code projectIds} is empty, a global context is created. A global context is one that applies to all project. If {@code issueTypeIds} is empty, the context applies to all issue types.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param createCustomFieldContext (required)
*/
@RequestLine("POST /rest/api/3/field/{fieldId}/context")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
CreateCustomFieldContext createCustomFieldContext(@Param("fieldId") @NotNull String fieldId, @NotNull CreateCustomFieldContext createCustomFieldContext);
/**
* Create custom field options (context)
*
* Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field.
* The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.
* This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context. (required)
* @param bulkCustomFieldOptionCreateRequest (required)
*/
@RequestLine("POST /rest/api/3/field/{fieldId}/context/{contextId}/option")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
CustomFieldCreatedContextOptionsList createCustomFieldOption(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @NotNull Long contextId, @NotNull BulkCustomFieldOptionCreateRequest bulkCustomFieldOptionCreateRequest);
/**
* Create dashboard
*
* Creates a dashboard.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [write:jira-work]
* @param dashboardDetails Dashboard details. (required)
*/
@RequestLine("POST /rest/api/3/dashboard")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Dashboard createDashboard(@NotNull DashboardDetails dashboardDetails);
/**
* Create field configuration
*
* Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.
* This operation can only create configurations for use in company-managed (classic) projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldConfigurationDetails (required)
*/
@RequestLine("POST /rest/api/3/fieldconfiguration")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
FieldConfiguration createFieldConfiguration(@NotNull FieldConfigurationDetails fieldConfigurationDetails);
/**
* Create field configuration scheme
*
* Creates a field configuration scheme.
* This operation can only create field configuration schemes used in company-managed (classic) projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (required)
*/
@RequestLine("POST /rest/api/3/fieldconfigurationscheme")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
FieldConfigurationScheme createFieldConfigurationScheme(@NotNull UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails);
/**
* Create filter
*
* Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [write:jira-work]
* @param filter The filter to create. (required)
* @param expand Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * {@code sharedUsers} Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify {@code sharedUsers}, then the {@code sharedUsers} object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 users, use {@code ?expand=sharedUsers[1001:2000]}. * {@code subscriptions} Returns the users that are subscribed to the filter. If you don't specify {@code subscriptions}, the {@code subscriptions} object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 subscriptions, use {@code ?expand=subscriptions[1001:2000]}. (optional)
* @param overrideSharePermissions EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
*/
@RequestLine("POST /rest/api/3/filter?expand={expand}&overrideSharePermissions={overrideSharePermissions}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Filter createFilter(@NotNull Filter filter, @Param("expand") @Nullable String expand, @Param("overrideSharePermissions") @Nullable Boolean overrideSharePermissions);
/**
* Create group
*
* Creates a group.
* **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param addGroupBean The name of the group. (required)
*/
@RequestLine("POST /rest/api/3/group")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Group createGroup(@NotNull AddGroupBean addGroupBean);
/**
* Create issue
*
* 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.
* The content of the issue or subtask is defined using {@code update} and {@code fields}. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issue's create screen. Note that the {@code description}, {@code environment}, and any {@code textarea} type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields ({@code textfield}) accept a string and don't handle Atlassian Document Format content.
* Creating a subtask differs from creating an issue as follows:
* *
* {@code issueType} must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* *
* {@code parent} must contain the ID or key of the parent issue.
* In a next-gen project any issue may be made a child providing that the parent and child are members of the same project.
* **[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue or subtask is created.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueUpdateDetails (required)
* @param updateHistory Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen. (optional, defaults to false)
*/
@RequestLine("POST /rest/api/3/issue?updateHistory={updateHistory}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
CreatedIssue createIssue(@NotNull IssueUpdateDetails issueUpdateDetails, @Param("updateHistory") @Nullable Boolean updateHistory);
/**
* Create issue field option
*
* Creates an option for a select list issue field.
* Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
* Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldKey The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the {@code fieldKey} value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the {@code jiraIssueFields} module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in {@code key}. For example, {@code "key": "teams-add-on__team-issue-field"} (required)
* @param issueFieldOptionCreateBean (required)
*/
@RequestLine("POST /rest/api/3/field/{fieldKey}/option")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
IssueFieldOption createIssueFieldOption(@Param("fieldKey") @NotNull String fieldKey, @NotNull IssueFieldOptionCreateBean issueFieldOptionCreateBean);
/**
* Create issue link type
*
* Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.
* To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueLinkType (required)
*/
@RequestLine("POST /rest/api/3/issueLinkType")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
IssueLinkType createIssueLinkType(@NotNull IssueLinkType issueLinkType);
/**
* Create issue security scheme
*
* Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme levels and security scheme levels' members per request.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createIssueSecuritySchemeDetails (required)
*/
@RequestLine("POST /rest/api/3/issuesecurityschemes")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
SecuritySchemeId createIssueSecurityScheme(@NotNull CreateIssueSecuritySchemeDetails createIssueSecuritySchemeDetails);
/**
* Create issue type
*
* Creates an issue type and adds it to the default issue type scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeCreateBean (required)
*/
@RequestLine("POST /rest/api/3/issuetype")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
IssueTypeDetails createIssueType(@NotNull IssueTypeCreateBean issueTypeCreateBean);
/**
* Load issue type avatar
*
* Loads an avatar for the issue type.
* Specify the avatar's local file location in the body of the request. Also, include the following headers:
* *
* {@code X-Atlassian-Token: no-check} To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).
* *
* {@code Content-Type: image/image type} Valid image types are JPEG, GIF, or PNG.
* For example:
* {@code curl --request POST \\ --user [email protected]:<api_token> \\ --header 'X-Atlassian-Token: no-check' \\ --header 'Content-Type: image/< image_type>' \\ --data-binary "<@/path/to/file/with/your/avatar>" \\ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This}
* The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
* The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
* After creating the avatar, use [ Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the issue type. (required)
* @param size The length of each side of the crop region. (required)
* @param body (required)
* @param x The X coordinate of the top-left corner of the crop region. (optional, defaults to 0)
* @param y The Y coordinate of the top-left corner of the crop region. (optional, defaults to 0)
*/
@RequestLine("POST /rest/api/3/issuetype/{id}/avatar2?x={x}&y={y}&size={size}")
@Headers({
"Content-Type: */*",
"Accept: application/json"
})
Avatar createIssueTypeAvatar(@Param("id") @NotNull String id, @Param("size") @NotNull Integer size, @NotNull Object body, @Param("x") @Nullable Integer x, @Param("y") @Nullable Integer y);
/**
* Create issue type scheme
*
* Creates an issue type scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeSchemeDetails (required)
*/
@RequestLine("POST /rest/api/3/issuetypescheme")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
IssueTypeSchemeID createIssueTypeScheme(@NotNull IssueTypeSchemeDetails issueTypeSchemeDetails);
/**
* Create issue type screen scheme
*
* Creates an issue type screen scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeScreenSchemeDetails An issue type screen scheme bean. (required)
*/
@RequestLine("POST /rest/api/3/issuetypescreenscheme")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
IssueTypeScreenSchemeId createIssueTypeScreenScheme(@NotNull IssueTypeScreenSchemeDetails issueTypeScreenSchemeDetails);
/**
* Bulk create issue
*
* 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.
* The content of each issue or subtask is defined using {@code update} and {@code fields}. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issues' create screens. Note that the {@code description}, {@code environment}, and any {@code textarea} type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields ({@code textfield}) accept a string and don't handle Atlassian Document Format content.
* Creating a subtask differs from creating an issue as follows:
* *
* {@code issueType} must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* *
* {@code parent} the must contain the ID or key of the parent issue.
* **[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which each issue or subtask is created.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issuesUpdateBean (required)
*/
@RequestLine("POST /rest/api/3/issue/bulk")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
CreatedIssues createIssues(@NotNull IssuesUpdateBean issuesUpdateBean);
/**
* Create notification scheme
*
* Creates a notification scheme with notifications. You can create up to 1000 notifications per request.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createNotificationSchemeDetails (required)
*/
@RequestLine("POST /rest/api/3/notificationscheme")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
NotificationSchemeId createNotificationScheme(@NotNull CreateNotificationSchemeDetails createNotificationSchemeDetails);
/**
* Create or update remote issue link
*
* Creates or updates a remote issue link for an issue.
* If a {@code globalId} is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.
* This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param remoteIssueLinkRequest (required)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/remotelink")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
RemoteIssueLinkIdentifies createOrUpdateRemoteIssueLink(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull RemoteIssueLinkRequest remoteIssueLinkRequest);
/**
* Create permission grant
*
* Creates a permission grant in a permission scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param schemeId The ID of the permission scheme in which to create a new permission grant. (required)
* @param permissionGrant The permission grant to create. (required)
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * {@code permissions} Returns all permission grants for each permission scheme. * {@code user} Returns information about the user who is granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code projectRole} Returns information about the project role granted the permission. * {@code field} Returns information about the custom field granted the permission. * {@code all} Returns all expandable information. (optional)
*/
@RequestLine("POST /rest/api/3/permissionscheme/{schemeId}/permission?expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PermissionGrant createPermissionGrant(@Param("schemeId") @NotNull Long schemeId, @NotNull PermissionGrant permissionGrant, @Param("expand") @Nullable String expand);
/**
* Create permission scheme
*
* Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param permissionScheme The permission scheme to create. (required)
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code permissions} Returns all permission grants for each permission scheme. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("POST /rest/api/3/permissionscheme?expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PermissionScheme createPermissionScheme(@NotNull PermissionScheme permissionScheme, @Param("expand") @Nullable String expand);
/**
* Create priority
*
* Creates an issue priority.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createPriorityDetails (required)
*/
@RequestLine("POST /rest/api/3/priority")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PriorityId createPriority(@NotNull CreatePriorityDetails createPriorityDetails);
/**
* Create project
*
* Creates a project based on a project type template, as shown in the following table:
* | Project Type Key | Project Template Key |
* |--|--|
* | {@code business} | {@code com.atlassian.jira-core-project-templates:jira-core-simplified-content-management}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-process-control}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-procurement}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-project-management}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment}, {@code com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking} |
* | {@code service_desk} | {@code com.atlassian.servicedesk:simplified-it-service-management}, {@code com.atlassian.servicedesk:simplified-general-service-desk-it}, {@code com.atlassian.servicedesk:simplified-general-service-desk-business}, {@code com.atlassian.servicedesk:simplified-external-service-desk}, {@code com.atlassian.servicedesk:simplified-hr-service-desk}, {@code com.atlassian.servicedesk:simplified-facilities-service-desk}, {@code com.atlassian.servicedesk:simplified-legal-service-desk}, {@code com.atlassian.servicedesk:simplified-analytics-service-desk}, {@code com.atlassian.servicedesk:simplified-marketing-service-desk}, {@code com.atlassian.servicedesk:simplified-design-service-desk}, {@code com.atlassian.servicedesk:simplified-sales-service-desk}, {@code com.atlassian.servicedesk:simplified-blank-project-business}, {@code com.atlassian.servicedesk:simplified-blank-project-it}, {@code com.atlassian.servicedesk:simplified-finance-service-desk}, {@code com.atlassian.servicedesk:next-gen-it-service-desk}, {@code com.atlassian.servicedesk:next-gen-hr-service-desk}, {@code com.atlassian.servicedesk:next-gen-legal-service-desk}, {@code com.atlassian.servicedesk:next-gen-marketing-service-desk}, {@code com.atlassian.servicedesk:next-gen-facilities-service-desk}, {@code com.atlassian.servicedesk:next-gen-general-it-service-desk}, {@code com.atlassian.servicedesk:next-gen-general-business-service-desk}, {@code com.atlassian.servicedesk:next-gen-analytics-service-desk}, {@code com.atlassian.servicedesk:next-gen-finance-service-desk}, {@code com.atlassian.servicedesk:next-gen-design-service-desk}, {@code com.atlassian.servicedesk:next-gen-sales-service-desk} |
* | {@code software} | {@code com.pyxis.greenhopper.jira:gh-simplified-agility-kanban}, {@code com.pyxis.greenhopper.jira:gh-simplified-agility-scrum}, {@code com.pyxis.greenhopper.jira:gh-simplified-basic}, {@code com.pyxis.greenhopper.jira:gh-simplified-kanban-classic}, {@code com.pyxis.greenhopper.jira:gh-simplified-scrum-classic} |
* The project types are available according to the installed Jira features as follows:
* *
* Jira Core, the default, enables {@code business} projects.
* *
* Jira Service Management enables {@code service_desk} projects.
* *
* Jira Software enables {@code software} projects.
* To determine which features are installed, go to **Jira settings** > **Apps** > **Manage apps** and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use **Jira settings** > **Apps** > **Finding new apps**. For more information, see [ Managing add-ons](https://confluence.atlassian.com/x/S31NLg).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createProjectDetails The JSON representation of the project being created. (required)
*/
@RequestLine("POST /rest/api/3/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectIdentifiers createProject(@NotNull CreateProjectDetails createProjectDetails);
/**
* Load project avatar
*
* Loads an avatar for a project.
* Specify the avatar's local file location in the body of the request. Also, include the following headers:
* *
* {@code X-Atlassian-Token: no-check} To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).
* *
* {@code Content-Type: image/image type} Valid image types are JPEG, GIF, or PNG.
* For example:
* {@code curl --request POST }
* {@code --user [email protected]:<api_token> }
* {@code --header 'X-Atlassian-Token: no-check' }
* {@code --header 'Content-Type: image/< image_type>' }
* {@code --data-binary "<@/path/to/file/with/your/avatar>" }
* {@code --url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'}
* The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
* The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
* After creating the avatar use [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar.
* **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectIdOrKey The ID or (case-sensitive) key of the project. (required)
* @param body (required)
* @param x The X coordinate of the top-left corner of the crop region. (optional, defaults to 0)
* @param y The Y coordinate of the top-left corner of the crop region. (optional, defaults to 0)
* @param size The length of each side of the crop region. (optional)
*/
@RequestLine("POST /rest/api/3/project/{projectIdOrKey}/avatar2?x={x}&y={y}&size={size}")
@Headers({
"Content-Type: */*",
"Accept: application/json"
})
Avatar createProjectAvatar(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @NotNull Object body, @Param("x") @Nullable Integer x, @Param("y") @Nullable Integer y, @Param("size") @Nullable Integer size);
/**
* Create project category
*
* Creates a project category.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectCategory (required)
*/
@RequestLine("POST /rest/api/3/projectCategory")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectCategory createProjectCategory(@NotNull ProjectCategory projectCategory);
/**
* Create project role
*
* Creates a new project role with no [default actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to project role](#api-rest-api-3-role-id-actors-post) operation to add default actors to the project role after creating it.
* *Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.*<
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createUpdateRoleRequestBean (required)
*/
@RequestLine("POST /rest/api/3/role")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectRole createProjectRole(@NotNull CreateUpdateRoleRequestBean createUpdateRoleRequestBean);
/**
* Create related work
*
* Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues* [Managing project permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html) for the project that contains the version.
*
* Authentication - Required Scopes: [write:jira-work]
* @param id (required)
* @param versionRelatedWork (required)
*/
@RequestLine("POST /rest/api/3/version/{id}/relatedwork")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
VersionRelatedWork createRelatedWork(@Param("id") @NotNull String id, @NotNull VersionRelatedWork versionRelatedWork);
/**
* Create resolution
*
* Creates an issue resolution.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createResolutionDetails (required)
*/
@RequestLine("POST /rest/api/3/resolution")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ResolutionId createResolution(@NotNull CreateResolutionDetails createResolutionDetails);
/**
* Create screen
*
* Creates a screen with a default field tab.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenDetails (required)
*/
@RequestLine("POST /rest/api/3/screens")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Screen createScreen(@NotNull ScreenDetails screenDetails);
/**
* Create screen scheme
*
* Creates a screen scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param screenSchemeDetails (required)
*/
@RequestLine("POST /rest/api/3/screenscheme")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ScreenSchemeId createScreenScheme(@NotNull ScreenSchemeDetails screenSchemeDetails);
/**
* Bulk create statuses
*
* Creates statuses for a global or project scope.
* **[Permissions](#permissions) required:**
* *
* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param statusCreateRequest Details of the statuses being created and their scope. (required)
*/
@RequestLine("POST /rest/api/3/statuses")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
List createStatuses(@NotNull StatusCreateRequest statusCreateRequest);
/**
* Create UI modification
*
* Creates a UI modification. UI modification can only be created by Forge apps.
* Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.
* **[Permissions](#permissions) required:**
* *
* *None* if the UI modification is created without contexts.
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.
*
* Authentication - Required Scopes: [read:jira-work]
* @param createUiModificationDetails Details of the UI modification. (required)
*/
@RequestLine("POST /rest/api/3/uiModifications")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
UiModificationIdentifiers createUiModification(@NotNull CreateUiModificationDetails createUiModificationDetails);
/**
* Create user
*
* Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.
* If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* @param newUserDetails Details about the user to be created. (required)
*/
@RequestLine("POST /rest/api/3/user")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
User createUser(@NotNull NewUserDetails newUserDetails);
/**
* Create version
*
* Creates a project version.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param version (required)
*/
@RequestLine("POST /rest/api/3/version")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Version createVersion(@NotNull Version version);
/**
* Create workflow
*
* Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use [bulk create workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-create-post) to create both team and company-managed scoped workflows.
* #### Conditions ####
* Conditions enable workflow rules that govern whether a transition can execute.
* ##### Always false condition #####
* A condition that always fails.
*
*
* {
*
*
*
* "type": "AlwaysFalseCondition"
*
*
* }
* ##### Block transition until approval #####
* A condition that blocks issue transition if there is a pending approval.
*
*
* {
*
*
*
* "type": "BlockInProgressApprovalCondition"
*
*
* }
* ##### Compare number custom field condition #####
* A condition that allows transition if a comparison between a number custom field and a value is true.
*
*
* {
*
*
*
* "type": "CompareNumberCFCondition",
*
*
*
* "configuration": {
*
*
*
*
* "comparator": "=",
*
*
*
*
* "fieldId": "customfield_10029",
*
*
*
*
* "fieldValue": 2
*
*
*
* }
*
*
* }
* *
* {@code comparator} One of the supported comparator: {@code =}, {@code >}, and {@code <}.
* *
* {@code fieldId} The custom numeric field ID. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:float}
*
*
* *
* {@code com.pyxis.greenhopper.jira:jsw-story-points}
* *
* {@code fieldValue} The value for comparison.
* ##### Hide from user condition #####
* A condition that hides a transition from users. The transition can only be triggered from a workflow function or REST API operation.
*
*
* {
*
*
*
* "type": "RemoteOnlyCondition"
*
*
* }
* ##### Only assignee condition #####
* A condition that allows only the assignee to execute a transition.
*
*
* {
*
*
*
* "type": "AllowOnlyAssignee"
*
*
* }
* ##### Only Bamboo notifications workflow condition (deprecated) #####
* A condition that makes the transition available only to Bamboo build notifications.
*
*
* {
*
*
*
* "type": "OnlyBambooNotificationsCondition"
*
*
* }
* ##### Only reporter condition #####
* A condition that allows only the reporter to execute a transition.
*
*
* {
*
*
*
* "type": "AllowOnlyReporter"
*
*
* }
* ##### Permission condition #####
* A condition that allows only users with a permission to execute a transition.
*
*
* {
*
*
*
* "type": "PermissionCondition",
*
*
*
* "configuration": {
*
*
*
*
*
* "permissionKey": "BROWSE_PROJECTS"
*
*
*
* }
*
*
* }
* *
* {@code permissionKey} The permission required to perform the transition. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions.
* ##### Previous status condition #####
* A condition that allows a transition based on whether an issue has or has not transitioned through a status.
*
*
* {
*
*
*
* "type": "PreviousStatusCondition",
*
*
*
* "configuration": {
*
*
*
*
* "ignoreLoopTransitions": true,
*
*
*
*
* "includeCurrentStatus": true,
*
*
*
*
* "mostRecentStatusOnly": true,
*
*
*
*
* "reverseCondition": true,
*
*
*
*
* "previousStatus": {
*
*
*
*
*
* "id": "5"
*
*
*
*
* }
*
*
*
* }
*
*
* }
* By default this condition allows the transition if the status, as defined by its ID in the {@code previousStatus} object, matches any previous issue status, unless:
* *
* {@code ignoreLoopTransitions} is {@code true}, then loop transitions (from and to the same status) are ignored.
* *
* {@code includeCurrentStatus} is {@code true}, then the current issue status is also checked.
* *
* {@code mostRecentStatusOnly} is {@code true}, then only the issue's preceding status (the one immediately before the current status) is checked.
* *
* {@code reverseCondition} is {@code true}, then the status must not be present.
* ##### Separation of duties condition #####
* A condition that prevents a user to perform the transition, if the user has already performed a transition on the issue.
*
*
* {
*
*
*
* "type": "SeparationOfDutiesCondition",
*
*
*
* "configuration": {
*
*
*
*
* "fromStatus": {
*
*
*
*
*
* "id": "5"
*
*
*
*
* },
*
*
*
*
* "toStatus": {
*
*
*
*
*
* "id": "6"
*
*
*
*
* }
*
*
*
* }
*
*
* }
* *
* {@code fromStatus} OPTIONAL. An object containing the ID of the source status of the transition that is blocked. If omitted any transition to {@code toStatus} is blocked.
* *
* {@code toStatus} An object containing the ID of the target status of the transition that is blocked.
* ##### Subtask blocking condition #####
* A condition that blocks transition on a parent issue if any of its subtasks are in any of one or more statuses.
*
*
* {
*
*
*
* "type": "SubTaskBlockingCondition",
*
*
*
* "configuration": {
*
*
*
*
* "statuses": [
*
*
*
*
*
* {
*
*
*
*
*
*
* "id": "1"
*
*
*
*
*
* },
*
*
*
*
*
* {
*
*
*
*
*
*
* "id": "3"
*
*
*
*
*
* }
*
*
*
*
* ]
*
*
*
* }
*
*
* }
* *
* {@code statuses} A list of objects containing status IDs.
* ##### User is in any group condition #####
* A condition that allows users belonging to any group from a list of groups to execute a transition.
*
*
* {
*
*
*
* "type": "UserInAnyGroupCondition",
*
*
*
* "configuration": {
*
*
*
*
* "groups": [
*
*
*
*
*
* "administrators",
*
*
*
*
*
* "atlassian-addons-admin"
*
*
*
*
* ]
*
*
*
* }
*
*
* }
* *
* {@code groups} A list of group names.
* ##### User is in any project role condition #####
* A condition that allows only users with at least one project roles from a list of project roles to execute a transition.
*
*
* {
*
*
*
* "type": "InAnyProjectRoleCondition",
*
*
*
* "configuration": {
*
*
*
*
* "projectRoles": [
*
*
*
*
*
* {
*
*
*
*
*
*
* "id": "10002"
*
*
*
*
*
* },
*
*
*
*
*
* {
*
*
*
*
*
*
* "id": "10003"
*
*
*
*
*
* },
*
*
*
*
*
* {
*
*
*
*
*
*
* "id": "10012"
*
*
*
*
*
* },
*
*
*
*
*
* {
*
*
*
*
*
*
* "id": "10013"
*
*
*
*
*
* }
*
*
*
*
* ]
*
*
*
* }
*
*
* }
* *
* {@code projectRoles} A list of objects containing project role IDs.
* ##### User is in custom field condition #####
* A condition that allows only users listed in a given custom field to execute the transition.
*
*
* {
*
*
*
* "type": "UserIsInCustomFieldCondition",
*
*
*
* "configuration": {
*
*
*
*
* "allowUserInField": false,
*
*
*
*
* "fieldId": "customfield_10010"
*
*
*
* }
*
*
* }
* *
* {@code allowUserInField} If {@code true} only a user who is listed in {@code fieldId} can perform the transition, otherwise, only a user who is not listed in {@code fieldId} can perform the transition.
* *
* {@code fieldId} The ID of the field containing the list of users.
* ##### User is in group condition #####
* A condition that allows users belonging to a group to execute a transition.
*
*
* {
*
*
*
* "type": "UserInGroupCondition",
*
*
*
* "configuration": {
*
*
*
*
* "group": "administrators"
*
*
*
* }
*
*
* }
* *
* {@code group} The name of the group.
* ##### User is in group custom field condition #####
* A condition that allows users belonging to a group specified in a custom field to execute a transition.
*
*
* {
*
*
*
* "type": "InGroupCFCondition",
*
*
*
* "configuration": {
*
*
*
*
* "fieldId": "customfield_10012"
*
*
*
* }
*
*
* }
* *
* {@code fieldId} The ID of the field. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:grouppicker}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:select}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:multiselect}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes}
*
*
* *
* {@code com.pyxis.greenhopper.jira:gh-epic-status}
* ##### User is in project role condition #####
* A condition that allows users with a project role to execute a transition.
*
*
* {
*
*
*
* "type": "InProjectRoleCondition",
*
*
*
* "configuration": {
*
*
*
*
* "projectRole": {
*
*
*
*
*
* "id": "10002"
*
*
*
*
* }
*
*
*
* }
*
*
* }
* *
* {@code projectRole} An object containing the ID of a project role.
* ##### Value field condition #####
* A conditions that allows a transition to execute if the value of a field is equal to a constant value or simply set.
*
*
* {
*
*
*
* "type": "ValueFieldCondition",
*
*
*
* "configuration": {
*
*
*
*
* "fieldId": "assignee",
*
*
*
*
* "fieldValue": "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",
*
*
*
*
* "comparisonType": "NUMBER",
*
*
*
*
* "comparator": "="
*
*
*
* }
*
*
* }
* *
* {@code fieldId} The ID of a field used in the comparison.
* *
* {@code fieldValue} The expected value of the field.
* *
* {@code comparisonType} The type of the comparison. Allowed values: {@code STRING}, {@code NUMBER}, {@code DATE}, {@code DATE_WITHOUT_TIME}, or {@code OPTIONID}.
* *
* {@code comparator} One of the supported comparator: {@code >}, {@code >=}, {@code =}, {@code <=}, {@code <}, {@code !=}.
* **Notes:**
* *
* If you choose the comparison type {@code STRING}, only {@code =} and {@code !=} are valid options.
* *
* You may leave {@code fieldValue} empty when comparison type is {@code !=} to indicate that a value is required in the field.
* *
* For date fields without time format values as {@code yyyy-MM-dd}, and for those with time as {@code yyyy-MM-dd HH:mm}. For example, for July 16 2021 use {@code 2021-07-16}, for 8:05 AM use {@code 2021-07-16 08:05}, and for 4 PM: {@code 2021-07-16 16:00}.
* #### Validators ####
* Validators check that any input made to the transition is valid before the transition is performed.
* ##### Date field validator #####
* A validator that compares two dates.
*
*
* {
*
*
*
* "type": "DateFieldValidator",
*
*
*
* "configuration": {
*
*
*
*
*
* "comparator": ">",
*
*
*
*
*
* "date1": "updated",
*
*
*
*
*
* "date2": "created",
*
*
*
*
*
* "expression": "1d",
*
*
*
*
*
* "includeTime": true
*
*
*
*
* }
*
*
* }
* *
* {@code comparator} One of the supported comparator: {@code >}, {@code >=}, {@code =}, {@code <=}, {@code <}, or {@code !=}.
* *
* {@code date1} The date field to validate. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datepicker}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datetime}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-end}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-start}
*
*
* *
* {@code duedate}
*
*
* *
* {@code created}
*
*
* *
* {@code updated}
*
*
* *
* {@code resolutiondate}
* *
* {@code date2} The second date field. Required, if {@code expression} is not passed. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datepicker}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datetime}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-end}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-start}
*
*
* *
* {@code duedate}
*
*
* *
* {@code created}
*
*
* *
* {@code updated}
*
*
* *
* {@code resolutiondate}
* *
* {@code expression} An expression specifying an offset. Required, if {@code date2} is not passed. Offsets are built with a number, with {@code -} as prefix for the past, and one of these time units: {@code d} for day, {@code w} for week, {@code m} for month, or {@code y} for year. For example, -2d means two days into the past and 1w means one week into the future. The {@code now} keyword enables a comparison with the current date.
* *
* {@code includeTime} If {@code true}, then the time part of the data is included for the comparison. If the field doesn't have a time part, 00:00:00 is used.
* ##### Windows date validator #####
* A validator that checks that a date falls on or after a reference date and before or on the reference date plus a number of days.
*
*
* {
*
*
*
* "type": "WindowsDateValidator",
*
*
*
* "configuration": {
*
*
*
*
*
* "date1": "customfield_10009",
*
*
*
*
*
* "date2": "created",
*
*
*
*
*
* "windowsDays": 5
*
*
*
*
* }
*
*
* }
* *
* {@code date1} The date field to validate. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datepicker}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datetime}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-end}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-start}
*
*
* *
* {@code duedate}
*
*
* *
* {@code created}
*
*
* *
* {@code updated}
*
*
* *
* {@code resolutiondate}
* *
* {@code date2} The reference date. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datepicker}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:datetime}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-end}
*
*
* *
* {@code com.atlassian.jpo:jpo-custom-field-baseline-start}
*
*
* *
* {@code duedate}
*
*
* *
* {@code created}
*
*
* *
* {@code updated}
*
*
* *
* {@code resolutiondate}
* *
* {@code windowsDays} A positive integer indicating a number of days.
* ##### Field required validator #####
* A validator that checks fields are not empty. By default, if a field is not included in the current context it's ignored and not validated.
*
*
* {
*
*
*
*
* "type": "FieldRequiredValidator",
*
*
*
*
* "configuration": {
*
*
*
*
*
*
* "ignoreContext": true,
*
*
*
*
*
*
* "errorMessage": "Hey",
*
*
*
*
*
*
* "fieldIds": [
*
*
*
*
*
*
*
*
* "versions",
*
*
*
*
*
*
*
*
* "customfield_10037",
*
*
*
*
*
*
*
*
* "customfield_10003"
*
*
*
*
*
*
* ]
*
*
*
*
* }
*
*
* }
* *
* {@code ignoreContext} If {@code true}, then the context is ignored and all the fields are validated.
* *
* {@code errorMessage} OPTIONAL. The error message displayed when one or more fields are empty. A default error message is shown if an error message is not provided.
* *
* {@code fieldIds} The list of fields to validate.
* ##### Field changed validator #####
* A validator that checks that a field value is changed. However, this validation can be ignored for users from a list of groups.
*
*
* {
*
*
*
*
* "type": "FieldChangedValidator",
*
*
*
*
* "configuration": {
*
*
*
*
*
*
* "fieldId": "comment",
*
*
*
*
*
*
* "errorMessage": "Hey",
*
*
*
*
*
*
* "exemptedGroups": [
*
*
*
*
*
*
*
*
* "administrators",
*
*
*
*
*
*
*
*
* "atlassian-addons-admin"
*
*
*
*
*
*
* ]
*
*
*
*
* }
*
*
* }
* *
* {@code fieldId} The ID of a field.
* *
* {@code errorMessage} OPTIONAL. The error message displayed if the field is not changed. A default error message is shown if the error message is not provided.
* *
* {@code exemptedGroups} OPTIONAL. The list of groups.
* ##### Field has single value validator #####
* A validator that checks that a multi-select field has only one value. Optionally, the validation can ignore values copied from subtasks.
*
*
* {
*
*
*
*
* "type": "FieldHasSingleValueValidator",
*
*
*
*
* "configuration": {
*
*
*
*
*
*
* "fieldId": "attachment,
*
*
*
*
*
*
* "excludeSubtasks": true
*
*
*
*
* }
*
*
* }
* *
* {@code fieldId} The ID of a field.
* *
* {@code excludeSubtasks} If {@code true}, then values copied from subtasks are ignored.
* ##### Parent status validator #####
* A validator that checks the status of the parent issue of a subtask. Ìf the issue is not a subtask, no validation is performed.
*
*
* {
*
*
*
*
* "type": "ParentStatusValidator",
*
*
*
*
* "configuration": {
*
*
*
*
*
*
* "parentStatuses": [
*
*
*
*
*
*
*
*
* {
*
*
*
*
*
*
*
*
*
* "id":"1"
*
*
*
*
*
*
*
*
* },
*
*
*
*
*
*
*
*
* {
*
*
*
*
*
*
*
*
*
* "id":"2"
*
*
*
*
*
*
*
*
* }
*
*
*
*
*
*
* ]
*
*
*
*
* }
*
*
* }
* *
* {@code parentStatus} The list of required parent issue statuses.
* ##### Permission validator #####
* A validator that checks the user has a permission.
*
*
* {
*
*
*
* "type": "PermissionValidator",
*
*
*
* "configuration": {
*
*
*
*
*
* "permissionKey": "ADMINISTER_PROJECTS"
*
*
*
* }
*
*
* }
* *
* {@code permissionKey} The permission required to perform the transition. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions.
* ##### Previous status validator #####
* A validator that checks if the issue has held a status.
*
*
* {
*
*
*
* "type": "PreviousStatusValidator",
*
*
*
* "configuration": {
*
*
*
*
*
* "mostRecentStatusOnly": false,
*
*
*
*
*
* "previousStatus": {
*
*
*
*
*
*
*
* "id": "15"
*
*
*
*
*
* }
*
*
*
* }
*
*
* }
* *
* {@code mostRecentStatusOnly} If {@code true}, then only the issue's preceding status (the one immediately before the current status) is checked.
* *
* {@code previousStatus} An object containing the ID of an issue status.
* ##### Regular expression validator #####
* A validator that checks the content of a field against a regular expression.
*
*
* {
*
*
*
* "type": "RegexpFieldValidator",
*
*
*
* "configuration": {
*
*
*
*
*
* "regExp": "[0-9]",
*
*
*
*
*
* "fieldId": "customfield_10029"
*
*
*
* }
*
*
* }
* *
* {@code regExp}A regular expression.
* *
* {@code fieldId} The ID of a field. Allowed field types:
*
*
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:select}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:multiselect}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:textarea}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:textfield}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:url}
*
*
* *
* {@code com.atlassian.jira.plugin.system.customfieldtypes:float}
*
*
* *
* {@code com.pyxis.greenhopper.jira:jsw-story-points}
*
*
* *
* {@code com.pyxis.greenhopper.jira:gh-epic-status}
*
*
* *
* {@code description}
*
*
* *
* {@code summary}
* ##### User permission validator #####
* A validator that checks if a user has a permission. Obsolete. You may encounter this validator when getting transition rules and can pass it when updating or creating rules, for example, when you want to duplicate the rules from a workflow on a new workflow.
*
*
* {
*
*
*
*
* "type": "UserPermissionValidator",
*
*
*
*
* "configuration": {
*
*
*
*
*
*
* "permissionKey": "BROWSE_PROJECTS",
*
*
*
*
*
*
* "nullAllowed": false,
*
*
*
*
*
*
* "username": "TestUser"
*
*
*
*
* }
*
*
* }
* *
* {@code permissionKey} The permission to be validated. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions.
* *
* {@code nullAllowed} If {@code true}, allows the transition when {@code username} is empty.
* *
* {@code username} The username to validate against the {@code permissionKey}.
* #### Post functions ####
* Post functions carry out any additional processing required after a Jira workflow transition is executed.
* ##### Fire issue event function #####
* A post function that fires an event that is processed by the listeners.
*
*
* {
*
*
*
* "type": "FireIssueEventFunction",
*
*
*
* "configuration": {
*
*
*
*
* "event": {
*
*
*
*
*
* "id":"1"
*
*
*
*
* }
*
*
*
* }
*
*
* }
* **Note:** If provided, this post function overrides the default {@code FireIssueEventFunction}. Can be included once in a transition.
* *
* {@code event} An object containing the ID of the issue event.
* ##### Update issue status #####
* A post function that sets issue status to the linked status of the destination workflow status.
*
*
* {
*
*
*
* "type": "UpdateIssueStatusFunction"
*
*
* }
* **Note:** This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.
* ##### Create comment #####
* A post function that adds a comment entered during the transition to an issue.
*
*
* {
*
*
*
* "type": "CreateCommentFunction"
*
*
* }
* **Note:** This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.
* ##### Store issue #####
* A post function that stores updates to an issue.
*
*
* {
*
*
*
* "type": "IssueStoreFunction"
*
*
* }
* **Note:** This post function can only be added to the initial transition and can only be added once.
* ##### Assign to current user function #####
* A post function that assigns the issue to the current user if the current user has the {@code ASSIGNABLE_USER} permission.
*
*
* {
*
*
*
*
* "type": "AssignToCurrentUserFunction"
*
*
* }
* **Note:** This post function can be included once in a transition.
* ##### Assign to lead function #####
* A post function that assigns the issue to the project or component lead developer.
*
*
* {
*
*
*
*
* "type": "AssignToLeadFunction"
*
*
* }
* **Note:** This post function can be included once in a transition.
* ##### Assign to reporter function #####
* A post function that assigns the issue to the reporter.
*
*
* {
*
*
*
*
* "type": "AssignToReporterFunction"
*
*
* }
* **Note:** This post function can be included once in a transition.
* ##### Clear field value function #####
* A post function that clears the value from a field.
*
*
* {
*
*
*
* "type": "ClearFieldValuePostFunction",
*
*
*
* "configuration": {
*
*
*
*
* "fieldId": "assignee"
*
*
*
* }
*
*
* }
* *
* {@code fieldId} The ID of the field.
* ##### Copy value from other field function #####
* A post function that copies the value of one field to another, either within an issue or from parent to subtask.
*
*
* {
*
*
*
* "type": "CopyValueFromOtherFieldPostFunction",
*
*
*
* "configuration": {
*
*
*
*
* "sourceFieldId": "assignee",
*
*
*
*
* "destinationFieldId": "creator",
*
*
*
*
* "copyType": "same"
*
*
*
* }
*
*
* }
* *
* {@code sourceFieldId} The ID of the source field.
* *
* {@code destinationFieldId} The ID of the destination field.
* *
* {@code copyType} Use {@code same} to copy the value from a field inside the issue, or {@code parent} to copy the value from the parent issue.
* ##### Create Crucible review workflow function (deprecated) #####
* A post function that creates a Crucible review for all unreviewed code for the issue.
*
*
* {
*
*
*
*
* "type": "CreateCrucibleReviewWorkflowFunction"
*
*
* }
* **Note:** This post function can be included once in a transition.
* ##### Set issue security level based on user's project role function #####
* A post function that sets the issue's security level if the current user has a project role.
*
*
* {
*
*
*
* "type": "SetIssueSecurityFromRoleFunction",
*
*
*
* "configuration": {
*
*
*
*
* "projectRole": {
*
*
*
*
*
*
* "id":"10002"
*
*
*
*
* },
*
*
*
*
* "issueSecurityLevel": {
*
*
*
*
*
*
* "id":"10000"
*
*
*
*
* }
*
*
*
* }
*
*
* }
* *
* {@code projectRole} An object containing the ID of the project role.
* *
* {@code issueSecurityLevel} OPTIONAL. The object containing the ID of the security level. If not passed, then the security level is set to {@code none}.
* ##### Trigger a webhook function #####
* A post function that triggers a webhook.
*
*
* {
*
*
*
* "type": "TriggerWebhookFunction",
*
*
*
* "configuration": {
*
*
*
*
* "webhook": {
*
*
*
*
*
* "id": "1"
*
*
*
*
* }
*
*
*
* }
*
*
* }
* *
* {@code webhook} An object containing the ID of the webhook listener to trigger.
* ##### Update issue custom field function #####
* A post function that updates the content of an issue custom field.
*
*
* {
*
*
*
* "type": "UpdateIssueCustomFieldPostFunction",
*
*
*
* "configuration": {
*
*
*
*
* "mode": "append",
*
*
*
*
* "fieldId": "customfield_10003",
*
*
*
*
* "fieldValue": "yikes"
*
*
*
* }
*
*
* }
* *
* {@code mode} Use {@code replace} to override the field content with {@code fieldValue} or {@code append} to add {@code fieldValue} to the end of the field content.
* *
* {@code fieldId} The ID of the field.
* *
* {@code fieldValue} The update content.
* ##### Update issue field function #####
* A post function that updates a simple issue field.
*
*
* {
*
*
*
* "type": "UpdateIssueFieldFunction",
*
*
*
* "configuration": {
*
*
*
*
* "fieldId": "assignee",
*
*
*
*
* "fieldValue": "5f0c277e70b8a90025a00776"
*
*
*
* }
*
*
* }
* *
* {@code fieldId} The ID of the field. Allowed field types:
*
*
*
*
* *
* {@code assignee}
*
*
* *
* {@code description}
*
*
* *
* {@code environment}
*
*
* *
* {@code priority}
*
*
* *
* {@code resolution}
*
*
* *
* {@code summary}
*
*
* *
* {@code timeoriginalestimate}
*
*
* *
* {@code timeestimate}
*
*
* *
* {@code timespent}
* *
* {@code fieldValue} The update value.
* *
* If the {@code fieldId} is {@code assignee}, the {@code fieldValue} should be one of these values:
*
*
*
*
* *
* an account ID.
*
*
* *
* {@code automatic}.
*
*
* *
* a blank string, which sets the value to {@code unassigned}.
* #### Connect rules ####
* Connect rules are conditions, validators, and post functions of a transition that are registered by Connect apps. To create a rule registered by the app, the app must be enabled and the rule's module must exist.
*
*
* {
*
*
*
* "type": "appKey__moduleKey",
*
*
*
* "configuration": {
*
*
*
*
* "value":"{\\"isValid\\":\\"true\\"}"
*
*
*
* }
*
*
* }
* *
* {@code type} A Connect rule key in a form of {@code appKey__moduleKey}.
* *
* {@code value} The stringified JSON configuration of a Connect rule.
* #### Forge rules ####
* Forge transition rules are not yet supported.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param createWorkflowDetails The workflow details. (required)
* @deprecated
*/
@Deprecated
@RequestLine("POST /rest/api/3/workflow")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
WorkflowIDs createWorkflow(@NotNull CreateWorkflowDetails createWorkflowDetails);
/**
* Create workflow scheme
*
* Creates a workflow scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param workflowScheme (required)
*/
@RequestLine("POST /rest/api/3/workflowscheme")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
WorkflowScheme createWorkflowScheme(@NotNull WorkflowScheme workflowScheme);
/**
* Create draft workflow scheme
*
* Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the active workflow scheme that the draft is created from. (required)
*/
@RequestLine("POST /rest/api/3/workflowscheme/{id}/createdraft")
@Headers({
"Accept: application/json"
})
WorkflowScheme createWorkflowSchemeDraftFromParent(@Param("id") @NotNull Long id);
/**
* Create workflow transition property
*
* Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param transitionId The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. (required)
* @param key The key of the property being added, also known as the name of the property. Set this to the same value as the {@code key} defined in the request body. (required)
* @param workflowName The name of the workflow that the transition belongs to. (required)
* @param workflowTransitionProperty (required)
* @param workflowMode The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited. (optional, defaults to live)
*/
@RequestLine("POST /rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}&workflowMode={workflowMode}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
WorkflowTransitionProperty createWorkflowTransitionProperty(@Param("transitionId") @NotNull Long transitionId, @Param("key") @NotNull String key, @Param("workflowName") @NotNull String workflowName, @NotNull WorkflowTransitionProperty workflowTransitionProperty, @Param("workflowMode") @Nullable String workflowMode);
/**
* Bulk create workflows
*
* Create workflows and related statuses.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* project permission to create all, including global-scoped, workflows
* *
* *Administer projects* project permissions to create project-scoped workflows
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param workflowCreateRequest (required)
*/
@RequestLine("POST /rest/api/3/workflows/create")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
WorkflowCreateResponse createWorkflows(@NotNull WorkflowCreateRequest workflowCreateRequest);
/**
* Delete actors from project role
*
* Deletes actors from a project role for the project.
* To remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-3-role-id-actors-delete).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param user The user account ID of the user to remove from the project role. (optional)
* @param group The name of the group to remove from the project role. This parameter cannot be used with the {@code groupId} parameter. As a group's name can change, use of {@code groupId} is recommended. (optional)
* @param groupId The ID of the group to remove from the project role. This parameter cannot be used with the {@code group} parameter. (optional)
*/
@RequestLine("DELETE /rest/api/3/project/{projectIdOrKey}/role/{id}?user={user}&group={group}&groupId={groupId}")
@Headers({
"Accept: application/json"
})
void deleteActor(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("id") @NotNull Long id, @Param("user") @Nullable String user, @Param("group") @Nullable String group, @Param("groupId") @Nullable String groupId);
/**
* Delete and replace version
*
* Deletes a project version.
* Alternative versions can be provided to update issues that use the deleted version in {@code fixVersion}, {@code affectedVersion}, or any version picker custom fields. If alternatives are not provided, occurrences of {@code fixVersion}, {@code affectedVersion}, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param id The ID of the version. (required)
* @param deleteAndReplaceVersionBean (required)
*/
@RequestLine("POST /rest/api/3/version/{id}/removeAndSwap")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object deleteAndReplaceVersion(@Param("id") @NotNull String id, @NotNull DeleteAndReplaceVersionBean deleteAndReplaceVersionBean);
/**
* Delete avatar
*
* Deletes an avatar from a project or issue type.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param type The avatar type. (required)
* @param owningObjectId The ID of the item the avatar is associated with. (required)
* @param id The ID of the avatar. (required)
*/
@RequestLine("DELETE /rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}")
@Headers({
"Accept: application/json"
})
void deleteAvatar(@Param("type") @NotNull String type, @Param("owningObjectId") @NotNull String owningObjectId, @Param("id") @NotNull Long id);
/**
* Delete comment
*
* Deletes a comment.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* *Delete all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any comment or *Delete own comments* to delete comment created by the user,
* *
* If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param id The ID of the comment. (required)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}/comment/{id}")
@Headers({
"Accept: application/json"
})
void deleteComment(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("id") @NotNull String id);
/**
* Delete comment property
*
* Deletes a comment property.
* **[Permissions](#permissions) required:** either of:
* *
* *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from any comment.
* *
* *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from a comment created by the user.
* Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
*
* Authentication - Required Scopes: [write:jira-work]
* @param commentId The ID of the comment. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("DELETE /rest/api/3/comment/{commentId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void deleteCommentProperty(@Param("commentId") @NotNull String commentId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Delete component
*
* Deletes a component.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param id The ID of the component. (required)
* @param moveIssuesTo The ID of the component to replace the deleted component. If this value is null no replacement is made. (optional)
*/
@RequestLine("DELETE /rest/api/3/component/{id}?moveIssuesTo={moveIssuesTo}")
@Headers({
"Accept: application/json"
})
void deleteComponent(@Param("id") @NotNull String id, @Param("moveIssuesTo") @Nullable String moveIssuesTo);
/**
* Delete custom field
*
* Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
* This operation is [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of a custom field. (required)
*/
@RequestLine("DELETE /rest/api/3/field/{id}")
@Headers({
"Accept: application/json"
})
void deleteCustomField(@Param("id") @NotNull String id);
/**
* Delete custom field context
*
* Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context. (required)
*/
@RequestLine("DELETE /rest/api/3/field/{fieldId}/context/{contextId}")
@Headers({
"Accept: application/json"
})
Object deleteCustomFieldContext(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @NotNull Long contextId);
/**
* Delete custom field options (context)
*
* Deletes a custom field option.
* Options with cascading options cannot be deleted without deleting the cascading options first.
* This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context from which an option should be deleted. (required)
* @param optionId The ID of the option to delete. (required)
*/
@RequestLine("DELETE /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}")
@Headers({
"Accept: application/json"
})
void deleteCustomFieldOption(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @NotNull Long contextId, @Param("optionId") @NotNull Long optionId);
/**
* Delete dashboard
*
* Deletes a dashboard.
* **[Permissions](#permissions) required:** None
* The dashboard to be deleted must be owned by the user.
*
* Authentication - Required Scopes: [write:jira-work]
* @param id The ID of the dashboard. (required)
*/
@RequestLine("DELETE /rest/api/3/dashboard/{id}")
@Headers({
"Accept: application/json"
})
void deleteDashboard(@Param("id") @NotNull String id);
/**
* Delete dashboard item property
*
* Deletes a dashboard item property.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard.
*
* Authentication - Required Scopes: [write:jira-work]
* @param dashboardId The ID of the dashboard. (required)
* @param itemId The ID of the dashboard item. (required)
* @param propertyKey The key of the dashboard item property. (required)
*/
@RequestLine("DELETE /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
Object deleteDashboardItemProperty(@Param("dashboardId") @NotNull String dashboardId, @Param("itemId") @NotNull String itemId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Delete default workflow
*
* Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).
* Note that active workflow schemes cannot be edited. If the workflow scheme is active, set {@code updateDraftIfNeeded} to {@code true} and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme. (required)
* @param updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to {@code false}. (optional)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/default?updateDraftIfNeeded={updateDraftIfNeeded}")
@Headers({
"Accept: application/json"
})
WorkflowScheme deleteDefaultWorkflow(@Param("id") @NotNull Long id, @Param("updateDraftIfNeeded") @Nullable Boolean updateDraftIfNeeded);
/**
* Delete draft default workflow
*
* Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme that the draft belongs to. (required)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/draft/default")
@Headers({
"Accept: application/json"
})
WorkflowScheme deleteDraftDefaultWorkflow(@Param("id") @NotNull Long id);
/**
* Delete issue types for workflow in draft workflow scheme
*
* Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme that the draft belongs to. (required)
* @param workflowName The name of the workflow. (required)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/draft/workflow?workflowName={workflowName}")
@Headers({
"Accept: application/json"
})
void deleteDraftWorkflowMapping(@Param("id") @NotNull Long id, @Param("workflowName") @NotNull String workflowName);
/**
* Remove filter as favorite
*
* Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [write:jira-work]
* @param id The ID of the filter. (required)
* @param expand Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * {@code sharedUsers} Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify {@code sharedUsers}, then the {@code sharedUsers} object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 users, use {@code ?expand=sharedUsers[1001:2000]}. * {@code subscriptions} Returns the users that are subscribed to the filter. If you don't specify {@code subscriptions}, the {@code subscriptions} object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 subscriptions, use {@code ?expand=subscriptions[1001:2000]}. (optional)
*/
@RequestLine("DELETE /rest/api/3/filter/{id}/favourite?expand={expand}")
@Headers({
"Accept: application/json"
})
Filter deleteFavouriteForFilter(@Param("id") @NotNull Long id, @Param("expand") @Nullable String expand);
/**
* Delete field configuration
*
* Deletes a field configuration.
* This operation can only delete configurations used in company-managed (classic) projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the field configuration. (required)
*/
@RequestLine("DELETE /rest/api/3/fieldconfiguration/{id}")
@Headers({
"Accept: application/json"
})
Object deleteFieldConfiguration(@Param("id") @NotNull Long id);
/**
* Delete field configuration scheme
*
* Deletes a field configuration scheme.
* This operation can only delete field configuration schemes used in company-managed (classic) projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the field configuration scheme. (required)
*/
@RequestLine("DELETE /rest/api/3/fieldconfigurationscheme/{id}")
@Headers({
"Accept: application/json"
})
Object deleteFieldConfigurationScheme(@Param("id") @NotNull Long id);
/**
* Delete filter
*
* Delete a filter.
* **[Permissions](#permissions) required:** Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [write:jira-work]
* @param id The ID of the filter to delete. (required)
*/
@RequestLine("DELETE /rest/api/3/filter/{id}")
@Headers({
"Accept: application/json"
})
void deleteFilter(@Param("id") @NotNull Long id);
/**
* Delete inactive workflow
*
* Deletes a workflow.
* The workflow cannot be deleted if it is:
* *
* an active workflow.
* *
* a system workflow.
* *
* associated with any workflow scheme.
* *
* associated with any draft workflow scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param entityId The entity ID of the workflow. (required)
*/
@RequestLine("DELETE /rest/api/3/workflow/{entityId}")
@Headers({
"Accept: application/json"
})
void deleteInactiveWorkflow(@Param("entityId") @NotNull String entityId);
/**
* Delete issue
*
* Deletes an issue.
* An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set {@code deleteSubtasks}. This causes the issue's subtasks to be deleted with the issue.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param deleteSubtasks Whether the issue's subtasks are deleted when the issue is deleted. (optional, defaults to false)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}?deleteSubtasks={deleteSubtasks}")
@Headers({
"Accept: application/json"
})
void deleteIssue(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("deleteSubtasks") @Nullable String deleteSubtasks);
/**
* Delete issue field option
*
* Deletes an option from a select list issue field.
* Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldKey The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the {@code fieldKey} value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the {@code jiraIssueFields} module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in {@code key}. For example, {@code "key": "teams-add-on__team-issue-field"} (required)
* @param optionId The ID of the option to be deleted. (required)
*/
@RequestLine("DELETE /rest/api/3/field/{fieldKey}/option/{optionId}")
@Headers({
"Accept: application/json"
})
Object deleteIssueFieldOption(@Param("fieldKey") @NotNull String fieldKey, @Param("optionId") @NotNull Long optionId);
/**
* Delete issue link
*
* Deletes an issue link.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* Browse project [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues in the link.
* *
* *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one of the projects containing issues in the link.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.
*
* Authentication - Required Scopes: [write:jira-work]
* @param linkId The ID of the issue link. (required)
*/
@RequestLine("DELETE /rest/api/3/issueLink/{linkId}")
@Headers({
"Accept: application/json"
})
void deleteIssueLink(@Param("linkId") @NotNull String linkId);
/**
* Delete issue link type
*
* Deletes an issue link type.
* To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueLinkTypeId The ID of the issue link type. (required)
*/
@RequestLine("DELETE /rest/api/3/issueLinkType/{issueLinkTypeId}")
@Headers({
"Accept: application/json"
})
void deleteIssueLinkType(@Param("issueLinkTypeId") @NotNull String issueLinkTypeId);
/**
* Delete issue property
*
* Deletes an issue's property.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The key or ID of the issue. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void deleteIssueProperty(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("propertyKey") @NotNull String propertyKey);
/**
* Delete issue type
*
* Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type ({@code alternativeIssueTypeId}). A list of alternative issue types are obtained from the [Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) resource.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the issue type. (required)
* @param alternativeIssueTypeId The ID of the replacement issue type. (optional)
*/
@RequestLine("DELETE /rest/api/3/issuetype/{id}?alternativeIssueTypeId={alternativeIssueTypeId}")
@Headers({
"Accept: application/json"
})
void deleteIssueType(@Param("id") @NotNull String id, @Param("alternativeIssueTypeId") @Nullable String alternativeIssueTypeId);
/**
* Delete issue type property
*
* Deletes the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeId The ID of the issue type. (required)
* @param propertyKey The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys. (required)
*/
@RequestLine("DELETE /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void deleteIssueTypeProperty(@Param("issueTypeId") @NotNull String issueTypeId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Delete issue type scheme
*
* Deletes an issue type scheme.
* Only issue type schemes used in classic projects can be deleted.
* Any projects assigned to the scheme are reassigned to the default issue type scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeSchemeId The ID of the issue type scheme. (required)
*/
@RequestLine("DELETE /rest/api/3/issuetypescheme/{issueTypeSchemeId}")
@Headers({
"Accept: application/json"
})
Object deleteIssueTypeScheme(@Param("issueTypeSchemeId") @NotNull Long issueTypeSchemeId);
/**
* Delete issue type screen scheme
*
* Deletes an issue type screen scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeScreenSchemeId The ID of the issue type screen scheme. (required)
*/
@RequestLine("DELETE /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}")
@Headers({
"Accept: application/json"
})
Object deleteIssueTypeScreenScheme(@Param("issueTypeScreenSchemeId") @NotNull String issueTypeScreenSchemeId);
/**
* Delete locale
*
* Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API instead.
* Deletes the locale of the user, which restores the default setting.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* @deprecated
*/
@Deprecated
@RequestLine("DELETE /rest/api/3/mypreferences/locale")
@Headers({
"Accept: application/json"
})
Object deleteLocale();
/**
* Delete notification scheme
*
* Deletes a notification scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param notificationSchemeId The ID of the notification scheme. (required)
*/
@RequestLine("DELETE /rest/api/3/notificationscheme/{notificationSchemeId}")
@Headers({
"Accept: application/json"
})
Object deleteNotificationScheme(@Param("notificationSchemeId") @NotNull String notificationSchemeId);
/**
* Delete permission scheme
*
* Deletes a permission scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param schemeId The ID of the permission scheme being deleted. (required)
*/
@RequestLine("DELETE /rest/api/3/permissionscheme/{schemeId}")
@Headers({
"Accept: application/json"
})
void deletePermissionScheme(@Param("schemeId") @NotNull Long schemeId);
/**
* Delete permission scheme grant
*
* Deletes a permission grant from a permission scheme. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more details.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param schemeId The ID of the permission scheme to delete the permission grant from. (required)
* @param permissionId The ID of the permission grant to delete. (required)
*/
@RequestLine("DELETE /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}")
@Headers({
"Accept: application/json"
})
void deletePermissionSchemeEntity(@Param("schemeId") @NotNull Long schemeId, @Param("permissionId") @NotNull Long permissionId);
/**
* Delete priority
*
* *Deprecated: please refer to the* [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) *for more details.*
* Deletes an issue priority.
* This operation is [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the issue priority. (required)
* @param replaceWith The ID of the issue priority that will replace the currently selected resolution. (required)
* @deprecated
*/
@Deprecated
@RequestLine("DELETE /rest/api/3/priority/{id}?replaceWith={replaceWith}")
@Headers({
"Accept: application/json"
})
void deletePriority(@Param("id") @NotNull String id, @Param("replaceWith") @NotNull String replaceWith);
/**
* Delete project
*
* Deletes 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.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param enableUndo Whether this project is placed in the Jira recycle bin where it will be available for restoration. (optional, defaults to true)
*/
@RequestLine("DELETE /rest/api/3/project/{projectIdOrKey}?enableUndo={enableUndo}")
@Headers({
"Accept: application/json"
})
void deleteProject(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("enableUndo") @Nullable Boolean enableUndo);
/**
* Delete project asynchronously
*
* Deletes a project asynchronously.
* This operation is:
* *
* transactional, that is, if part of the delete fails the project is not deleted.
* *
* [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
*/
@RequestLine("POST /rest/api/3/project/{projectIdOrKey}/delete")
@Headers({
"Accept: application/json"
})
void deleteProjectAsynchronously(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Delete project avatar
*
* Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
* **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectIdOrKey The project ID or (case-sensitive) key. (required)
* @param id The ID of the avatar. (required)
*/
@RequestLine("DELETE /rest/api/3/project/{projectIdOrKey}/avatar/{id}")
@Headers({
"Accept: application/json"
})
void deleteProjectAvatar(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("id") @NotNull Long id);
/**
* Delete project property
*
* Deletes the [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) from a project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param propertyKey The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. (required)
*/
@RequestLine("DELETE /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void deleteProjectProperty(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("propertyKey") @NotNull String propertyKey);
/**
* Delete project role
*
* Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the project role to delete. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param swap The ID of the project role that will replace the one being deleted. (optional)
*/
@RequestLine("DELETE /rest/api/3/role/{id}?swap={swap}")
@Headers({
"Accept: application/json"
})
void deleteProjectRole(@Param("id") @NotNull Long id, @Param("swap") @Nullable Long swap);
/**
* Delete default actors from project role
*
* Deletes the [default actors](#api-rest-api-3-resolution-get) from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.
* Changing a project role's default actors does not affect project role members for projects already created.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param user The user account ID of the user to remove as a default actor. (optional)
* @param groupId The group ID of the group to be removed as a default actor. This parameter cannot be used with the {@code group} parameter. (optional)
* @param group The group name of the group to be removed as a default actor.This parameter cannot be used with the {@code groupId} parameter. As a group's name can change, use of {@code groupId} is recommended. (optional)
*/
@RequestLine("DELETE /rest/api/3/role/{id}/actors?user={user}&groupId={groupId}&group={group}")
@Headers({
"Accept: application/json"
})
ProjectRole deleteProjectRoleActorsFromRole(@Param("id") @NotNull Long id, @Param("user") @Nullable String user, @Param("groupId") @Nullable String groupId, @Param("group") @Nullable String group);
/**
* Delete related work
*
* Deletes the given related work for the given version.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues* [Managing project permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html) for the project that contains the version.
*
* Authentication - Required Scopes: [write:jira-work]
* @param versionId The ID of the version that the target related work belongs to. (required)
* @param relatedWorkId The ID of the related work to delete. (required)
*/
@RequestLine("DELETE /rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}")
@Headers({
"Accept: application/json"
})
void deleteRelatedWork(@Param("versionId") @NotNull String versionId, @Param("relatedWorkId") @NotNull String relatedWorkId);
/**
* Delete remote issue link by global ID
*
* Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass {@code system=http://www.mycompany.com/support&id=1} as {@code system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1}.
* This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is implemented, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param globalId The global ID of a remote issue link. (required)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}/remotelink?globalId={globalId}")
@Headers({
"Accept: application/json"
})
void deleteRemoteIssueLinkByGlobalId(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("globalId") @NotNull String globalId);
/**
* Delete remote issue link by ID
*
* Deletes a remote issue link from an issue.
* This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects*, *Edit issues*, and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param linkId The ID of a remote issue link. (required)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}")
@Headers({
"Accept: application/json"
})
void deleteRemoteIssueLinkById(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("linkId") @NotNull String linkId);
/**
* Delete resolution
*
* Deletes an issue resolution.
* This operation is [asynchronous](#async). Follow the {@code location} link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the issue resolution. (required)
* @param replaceWith The ID of the issue resolution that will replace the currently selected resolution. (required)
*/
@RequestLine("DELETE /rest/api/3/resolution/{id}?replaceWith={replaceWith}")
@Headers({
"Accept: application/json"
})
void deleteResolution(@Param("id") @NotNull String id, @Param("replaceWith") @NotNull String replaceWith);
/**
* Delete screen
*
* Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.
* Only screens used in classic projects can be deleted.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
*/
@RequestLine("DELETE /rest/api/3/screens/{screenId}")
@Headers({
"Accept: application/json"
})
void deleteScreen(@Param("screenId") @NotNull Long screenId);
/**
* Delete screen scheme
*
* Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.
* Only screens schemes used in classic projects can be deleted.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenSchemeId The ID of the screen scheme. (required)
*/
@RequestLine("DELETE /rest/api/3/screenscheme/{screenSchemeId}")
@Headers({
"Accept: application/json"
})
void deleteScreenScheme(@Param("screenSchemeId") @NotNull String screenSchemeId);
/**
* Delete screen tab
*
* Deletes a screen tab.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
*/
@RequestLine("DELETE /rest/api/3/screens/{screenId}/tabs/{tabId}")
@Headers({
"Accept: application/json"
})
void deleteScreenTab(@Param("screenId") @NotNull Long screenId, @Param("tabId") @NotNull Long tabId);
/**
* Delete issue security scheme
*
* Deletes an issue security scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param schemeId The ID of the issue security scheme. (required)
*/
@RequestLine("DELETE /rest/api/3/issuesecurityschemes/{schemeId}")
@Headers({
"Accept: application/json"
})
Object deleteSecurityScheme(@Param("schemeId") @NotNull String schemeId);
/**
* Delete share permission
*
* Deletes a share permission from a filter.
* **[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter.
*
* Authentication - Required Scopes: [write:jira-work]
* @param id The ID of the filter. (required)
* @param permissionId The ID of the share permission. (required)
*/
@RequestLine("DELETE /rest/api/3/filter/{id}/permission/{permissionId}")
@Headers({
"Accept: application/json"
})
void deleteSharePermission(@Param("id") @NotNull Long id, @Param("permissionId") @NotNull Long permissionId);
/**
* Bulk delete Statuses
*
* Deletes statuses by ID.
* **[Permissions](#permissions) required:**
* *
* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items {@code 1}, Max items {@code 50} (required)
*/
@RequestLine("DELETE /rest/api/3/statuses?id={id}")
@Headers({
"Accept: application/json"
})
Object deleteStatusesById(@Param("id") @NotNull List id);
/**
* Delete UI modification
*
* Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.
* **[Permissions](#permissions) required:** None.
*
* @param uiModificationId The ID of the UI modification. (required)
*/
@RequestLine("DELETE /rest/api/3/uiModifications/{uiModificationId}")
@Headers({
"Accept: application/json"
})
Object deleteUiModification(@Param("uiModificationId") @NotNull String uiModificationId);
/**
* Delete user property
*
* Deletes a property from a user.
* Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user.
* *
* Access to Jira, to delete a property from the calling user's record.
*
* Authentication - Required Scopes: [write:jira-work]
* @param propertyKey The key of the user's property. (required)
* @param accountId The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
* @param userKey This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param username This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
*/
@RequestLine("DELETE /rest/api/3/user/properties/{propertyKey}?accountId={accountId}&userKey={userKey}&username={username}")
@Headers({
"Accept: application/json"
})
void deleteUserProperty(@Param("propertyKey") @NotNull String propertyKey, @Param("accountId") @Nullable String accountId, @Param("userKey") @Nullable String userKey, @Param("username") @Nullable String username);
/**
* Delete version
*
* Deletes a project version.
* Deprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) that supports swapping version values in custom fields, in addition to the swapping for {@code fixVersion} and {@code affectedVersion} provided in this resource.
* Alternative versions can be provided to update issues that use the deleted version in {@code fixVersion} or {@code affectedVersion}. If alternatives are not provided, occurrences of {@code fixVersion} and {@code affectedVersion} that contain the deleted version are cleared.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param id The ID of the version. (required)
* @param moveFixIssuesTo The ID of the version to update {@code fixVersion} to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted. (optional)
* @param moveAffectedIssuesTo The ID of the version to update {@code affectedVersion} to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted. (optional)
* @deprecated
*/
@Deprecated
@RequestLine("DELETE /rest/api/3/version/{id}?moveFixIssuesTo={moveFixIssuesTo}&moveAffectedIssuesTo={moveAffectedIssuesTo}")
@Headers({
"Accept: application/json"
})
void deleteVersion(@Param("id") @NotNull String id, @Param("moveFixIssuesTo") @Nullable String moveFixIssuesTo, @Param("moveAffectedIssuesTo") @Nullable String moveAffectedIssuesTo);
/**
* Delete webhooks by ID
*
* Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored.
* **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps) and [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps can use this operation.
*
* Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]
* @param containerForWebhookIDs (required)
*/
@RequestLine("DELETE /rest/api/3/webhook")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void deleteWebhookById(@NotNull ContainerForWebhookIDs containerForWebhookIDs);
/**
* Delete issue types for workflow in workflow scheme
*
* Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
* Note that active workflow schemes cannot be edited. If the workflow scheme is active, set {@code updateDraftIfNeeded} to {@code true} and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme. (required)
* @param workflowName The name of the workflow. (required)
* @param updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to {@code false}. (optional)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/workflow?workflowName={workflowName}&updateDraftIfNeeded={updateDraftIfNeeded}")
@Headers({
"Accept: application/json"
})
void deleteWorkflowMapping(@Param("id") @NotNull Long id, @Param("workflowName") @NotNull String workflowName, @Param("updateDraftIfNeeded") @Nullable Boolean updateDraftIfNeeded);
/**
* Delete workflow scheme
*
* Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as {@code schemeId}. For example, *schemeId=10301*. (required)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}")
@Headers({
"Accept: application/json"
})
Object deleteWorkflowScheme(@Param("id") @NotNull Long id);
/**
* Delete draft workflow scheme
*
* Deletes a draft workflow scheme.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the active workflow scheme that the draft was created from. (required)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/draft")
@Headers({
"Accept: application/json"
})
void deleteWorkflowSchemeDraft(@Param("id") @NotNull Long id);
/**
* Delete workflow for issue type in draft workflow scheme
*
* Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme that the draft belongs to. (required)
* @param issueType The ID of the issue type. (required)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}")
@Headers({
"Accept: application/json"
})
WorkflowScheme deleteWorkflowSchemeDraftIssueType(@Param("id") @NotNull Long id, @Param("issueType") @NotNull String issueType);
/**
* Delete workflow for issue type in workflow scheme
*
* Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
* Note that active workflow schemes cannot be edited. If the workflow scheme is active, set {@code updateDraftIfNeeded} to {@code true} and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme. (required)
* @param issueType The ID of the issue type. (required)
* @param updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to {@code false}. (optional)
*/
@RequestLine("DELETE /rest/api/3/workflowscheme/{id}/issuetype/{issueType}?updateDraftIfNeeded={updateDraftIfNeeded}")
@Headers({
"Accept: application/json"
})
WorkflowScheme deleteWorkflowSchemeIssueType(@Param("id") @NotNull Long id, @Param("issueType") @NotNull String issueType, @Param("updateDraftIfNeeded") @Nullable Boolean updateDraftIfNeeded);
/**
* Delete workflow transition property
*
* Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param transitionId The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. (required)
* @param key The name of the transition property to delete, also known as the name of the property. (required)
* @param workflowName The name of the workflow that the transition belongs to. (required)
* @param workflowMode The workflow status. Set to {@code live} for inactive workflows or {@code draft} for draft workflows. Active workflows cannot be edited. (optional)
*/
@RequestLine("DELETE /rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}&workflowMode={workflowMode}")
@Headers({
"Accept: application/json"
})
void deleteWorkflowTransitionProperty(@Param("transitionId") @NotNull Long transitionId, @Param("key") @NotNull String key, @Param("workflowName") @NotNull String workflowName, @Param("workflowMode") @Nullable String workflowMode);
/**
* Delete workflow transition rule configurations
*
* Deletes workflow transition rules from one or more workflows. These rule types are supported:
* *
* [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
* *
* [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/)
* *
* [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/)
* Only rules created by the calling Connect app can be deleted.
* **[Permissions](#permissions) required:** Only Connect apps can use this operation.
*
* @param workflowsWithTransitionRulesDetails (required)
*/
@RequestLine("PUT /rest/api/3/workflow/rule/config/delete")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
WorkflowTransitionRulesUpdateErrors deleteWorkflowTransitionRuleConfigurations(@NotNull WorkflowsWithTransitionRulesDetails workflowsWithTransitionRulesDetails);
/**
* Delete worklog
*
* Deletes a worklog from an issue.
* Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* *Delete all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any worklog or *Delete own worklogs* to delete worklogs created by the user,
* *
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param id The ID of the worklog. (required)
* @param notifyUsers Whether users watching the issue are notified by email. (optional, defaults to true)
* @param adjustEstimate Defines how to update the issue's time estimate, the options are: * {@code new} Sets the estimate to a specific value, defined in {@code newEstimate}. * {@code leave} Leaves the estimate unchanged. * {@code manual} Increases the estimate by amount specified in {@code increaseBy}. * {@code auto} Reduces the estimate by the value of {@code timeSpent} in the worklog. (optional, defaults to auto)
* @param newEstimate The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when {@code adjustEstimate} is {@code new}. (optional)
* @param increaseBy The amount to increase the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when {@code adjustEstimate} is {@code manual}. (optional)
* @param overrideEditableFlag Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. (optional, defaults to false)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{id}?notifyUsers={notifyUsers}&adjustEstimate={adjustEstimate}&newEstimate={newEstimate}&increaseBy={increaseBy}&overrideEditableFlag={overrideEditableFlag}")
@Headers({
"Accept: application/json"
})
void deleteWorklog(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("id") @NotNull String id, @Param("notifyUsers") @Nullable Boolean notifyUsers, @Param("adjustEstimate") @Nullable String adjustEstimate, @Param("newEstimate") @Nullable String newEstimate, @Param("increaseBy") @Nullable String increaseBy, @Param("overrideEditableFlag") @Nullable Boolean overrideEditableFlag);
/**
* Delete worklog property
*
* Deletes a worklog property.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param worklogId The ID of the worklog. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
void deleteWorklogProperty(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("worklogId") @NotNull String worklogId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Transition issue
*
* Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
* sortByCategory To update the fields on the transition screen, specify the fields in the {@code fields} or {@code update} parameters in the request body. Get details about the fields using [ Get transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the {@code transitions.fields} expand.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Transition issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param issueUpdateDetails (required)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/transitions")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object doTransition(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull IssueUpdateDetails issueUpdateDetails);
/**
* Get modules
*
* Returns all modules registered dynamically by the calling app.
* **[Permissions](#permissions) required:** Only Connect apps can make this request.
*
*/
@RequestLine("GET /rest/atlassian-connect/1/app/module/dynamic")
@Headers({
"Accept: application/json"
})
ConnectModules dynamicModulesResourceGetModulesGet();
/**
* Register modules
*
* Registers a list of modules.
* **[Permissions](#permissions) required:** Only Connect apps can make this request.
*
* @param connectModules (required)
*/
@RequestLine("POST /rest/atlassian-connect/1/app/module/dynamic")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
void dynamicModulesResourceRegisterModulesPost(@NotNull ConnectModules connectModules);
/**
* Remove modules
*
* Remove all or a list of modules registered by the calling app.
* **[Permissions](#permissions) required:** Only Connect apps can make this request.
*
* @param moduleKey The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, {@code moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field}. Nonexistent keys are ignored. (optional)
*/
@RequestLine("DELETE /rest/atlassian-connect/1/app/module/dynamic?moduleKey={moduleKey}")
@Headers({
"Accept: application/json"
})
void dynamicModulesResourceRemoveModulesDelete(@Param("moduleKey") @Nullable List moduleKey);
/**
* Edit issue
*
* Edits an issue. A transition may be applied and issue properties updated as part of the edit.
* The edits to the issue's fields are defined using {@code update} and {@code fields}. The fields that can be edited are determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
* The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting {@code update.parent.set.none} to *true*. Note that the {@code description}, {@code environment}, and any {@code textarea} type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields ({@code textfield}) accept a string and don't handle Atlassian Document Format content.
* Connect apps having an app user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen security configuration using {@code overrideScreenSecurity} and {@code overrideEditableFlag}.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* and *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [write:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param issueUpdateDetails (required)
* @param notifyUsers Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored. (optional, defaults to true)
* @param overrideScreenSecurity Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
* @param overrideEditableFlag Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
* @param returnIssue Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get). (optional, defaults to false)
* @param expand The Get issue API expand parameter to use in the response if the {@code returnIssue} parameter is {@code true}. (optional)
*/
@RequestLine("PUT /rest/api/3/issue/{issueIdOrKey}?notifyUsers={notifyUsers}&overrideScreenSecurity={overrideScreenSecurity}&overrideEditableFlag={overrideEditableFlag}&returnIssue={returnIssue}&expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
Object editIssue(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull IssueUpdateDetails issueUpdateDetails, @Param("notifyUsers") @Nullable Boolean notifyUsers, @Param("overrideScreenSecurity") @Nullable Boolean overrideScreenSecurity, @Param("overrideEditableFlag") @Nullable Boolean overrideEditableFlag, @Param("returnIssue") @Nullable Boolean returnIssue, @Param("expand") @Nullable String expand);
/**
* Evaluate Jira expression
*
* Evaluates a Jira expression and returns its value.
* This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the [Jira expressions documentation](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/) for more details.
* #### Context variables ####
* The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.
* *
* {@code user} ([User](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)): The current user. Always available and equal to {@code null} if the request is anonymous.
* *
* {@code app} ([App](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#app)): The [Connect app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) that made the request. Available only for authenticated requests made by Connect Apps (read more here: [Authentication for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/)).
* *
* {@code issue} ([Issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)): The current issue. Available only when the issue is provided in the request context object.
* *
* {@code issues} ([List](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#list) of [Issues](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object.
* *
* {@code project} ([Project](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#project)): The current project. Available only when the project is provided in the request context object.
* *
* {@code sprint} ([Sprint](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#sprint)): The current sprint. Available only when the sprint is provided in the request context object.
* *
* {@code board} ([Board](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#board)): The current board. Available only when the board is provided in the request context object.
* *
* {@code serviceDesk} ([ServiceDesk](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#servicedesk)): The current service desk. Available only when the service desk is provided in the request context object.
* *
* {@code customerRequest} ([CustomerRequest](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#customerrequest)): The current customer request. Available only when the customer request is provided in the request context object.
* Also, custom context variables can be passed in the request with their types. Those variables can be accessed by key in the Jira expression. These variable types are available for use in a custom context:
* *
* {@code user}: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID.
* *
* {@code issue}: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression.
* *
* {@code json}: A JSON object containing custom content.
* *
* {@code list}: A JSON list of {@code user}, {@code issue}, or {@code json} variable types.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required**: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
* Permission to access Jira Software is required to access Jira Software context variables ({@code board} and {@code sprint}) or fields (for example, {@code issue.sprint}).
*
* Authentication - Required Scopes: [read:jira-work, read:jira-user]
* @param jiraExpressionEvalRequestBean The Jira expression and the evaluation context. (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts {@code meta.complexity} that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the [complexity limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing and debugging your expressions. (optional)
*/
@RequestLine("POST /rest/api/3/expression/eval?expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
JiraExpressionResult evaluateJiraExpression(@NotNull JiraExpressionEvalRequestBean jiraExpressionEvalRequestBean, @Param("expand") @Nullable String expand);
/**
* Get all metadata for an expanded attachment
*
* Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.
* Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use [ Get contents metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-raw-get), which only returns the metadata for the attachment's contents.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** For the issue containing the attachment:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the attachment. (required)
*/
@RequestLine("GET /rest/api/3/attachment/{id}/expand/human")
@Headers({
"Accept: application/json"
})
AttachmentArchiveMetadataReadable expandAttachmentForHumans(@Param("id") @NotNull String id);
/**
* Get contents metadata for an expanded attachment
*
* Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.
* Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use [ Get all metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-human-get) which also returns the metadata for the attachment itself, such as the attachment's ID and name.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** For the issue containing the attachment:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the attachment. (required)
*/
@RequestLine("GET /rest/api/3/attachment/{id}/expand/raw")
@Headers({
"Accept: application/json"
})
AttachmentArchiveImpl expandAttachmentForMachines(@Param("id") @NotNull String id);
/**
* Export archived issue(s)
*
* 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.
* Note that this API only exports the values of system fields and archival-specific fields ({@code ArchivedBy} and {@code ArchivedDate}). Custom fields aren't supported.
* **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
* **License required:** Premium or Enterprise
* **Signed-in users only:** This API can't be accessed anonymously.
* **Rate limiting:** Only a single request can be active at any given time.
*
*
*
* Authentication - Required Scopes: [read:jira-work]
* @param archivedIssuesFilterRequest You can filter the issues in your request by the {@code projects}, {@code archivedBy}, {@code archivedDate}, {@code issueTypes}, and {@code reporters} fields. All filters are optional. If you don't provide any filters, you'll get a list of up to one million archived issues. (required)
*/
@RequestLine("PUT /rest/api/3/issues/archive/export")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ExportArchivedIssuesTaskProgressResponse exportArchivedIssues(@NotNull ArchivedIssuesFilterRequest archivedIssuesFilterRequest);
/**
* Find users assignable to issues
*
* Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:
* *
* a new issue, by providing the {@code projectKeyOrId}.
* *
* an updated issue, by providing the {@code issueKey}.
* *
* to an issue during a transition (workflow action), by providing the {@code issueKey} and the transition id in {@code actionDescriptorId}. You can obtain the IDs of an issue's valid transitions using the {@code transitions} option in the {@code expand} parameter of [ Get issue](#api-rest-api-3-issue-issueIdOrKey-get).
* In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.
* This operation takes the users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who can be assigned the issue, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Assign issues* [project permission](https://confluence.atlassian.com/x/yodKLg)
*
* Authentication - Required Scopes: [read:jira-user]
* @param query A query string that is matched against user attributes, such as {@code displayName}, and {@code emailAddress}, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a {@code displayName} of *John Smith* and a user with an {@code emailAddress} of *[email protected]*. Required, unless {@code username} or {@code accountId} is specified. (optional)
* @param sessionId The sessionId of this request. SessionId is the same until the assignee is set. (optional)
* @param username This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param accountId A query string that is matched exactly against user {@code accountId}. Required, unless {@code query} is specified. (optional)
* @param project The project ID or project key (case sensitive). Required, unless {@code issueKey} is specified. (optional)
* @param issueKey The key of the issue. Required, unless {@code project} is specified. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue. (optional, defaults to 50)
* @param actionDescriptorId The ID of the transition. (optional)
* @param recommend (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/user/assignable/search?query={query}&sessionId={sessionId}&username={username}&accountId={accountId}&project={project}&issueKey={issueKey}&startAt={startAt}&maxResults={maxResults}&actionDescriptorId={actionDescriptorId}&recommend={recommend}")
@Headers({
"Accept: application/json"
})
List findAssignableUsers(@Param("query") @Nullable String query, @Param("sessionId") @Nullable String sessionId, @Param("username") @Nullable String username, @Param("accountId") @Nullable String accountId, @Param("project") @Nullable String project, @Param("issueKey") @Nullable String issueKey, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("actionDescriptorId") @Nullable Integer actionDescriptorId, @Param("recommend") @Nullable Boolean recommend);
/**
* Find users assignable to projects
*
* Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.
* This operation takes the users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who can be assigned issues in the projects, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-user]
* @param projectKeys A list of project keys (case sensitive). This parameter accepts a comma-separated list. (required)
* @param query A query string that is matched against user attributes, such as {@code displayName} and {@code emailAddress}, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a {@code displayName} of *John Smith* and a user with an {@code emailAddress} of *[email protected]*. Required, unless {@code accountId} is specified. (optional)
* @param username This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param accountId A query string that is matched exactly against user {@code accountId}. Required, unless {@code query} is specified. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/user/assignable/multiProjectSearch?query={query}&username={username}&accountId={accountId}&projectKeys={projectKeys}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
List findBulkAssignableUsers(@Param("projectKeys") @NotNull String projectKeys, @Param("query") @Nullable String query, @Param("username") @Nullable String username, @Param("accountId") @Nullable String accountId, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Find groups
*
* Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results.
* The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the {@code html} field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically *Showing X of Y matching groups*.
* The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Anonymous calls and calls by users without the required permission return an empty list.
* *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Without this permission, calls where query is not an exact match to an existing group will return an empty list.
*
* Authentication - Required Scopes: [read:jira-user]
* @param accountId This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get). (optional)
* @param query The string to find in group names. (optional)
* @param exclude As a group's name can change, use of {@code excludeGroupIds} is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, {@code exclude=group1&exclude=group2}. This parameter cannot be used with the {@code excludeGroupIds} parameter. (optional)
* @param excludeId A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, {@code excludeId=group1-id&excludeId=group2-id}. This parameter cannot be used with the {@code excludeGroups} parameter. (optional)
* @param maxResults The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property {@code jira.ajax.autocomplete.limit}. (optional)
* @param caseInsensitive Whether the search for groups should be case insensitive. (optional, defaults to false)
* @param userName This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
*/
@RequestLine("GET /rest/api/3/groups/picker?accountId={accountId}&query={query}&exclude={exclude}&excludeId={excludeId}&maxResults={maxResults}&caseInsensitive={caseInsensitive}&userName={userName}")
@Headers({
"Accept: application/json"
})
FoundGroups findGroups(@Param("accountId") @Nullable String accountId, @Param("query") @Nullable String query, @Param("exclude") @Nullable List exclude, @Param("excludeId") @Nullable List excludeId, @Param("maxResults") @Nullable Integer maxResults, @Param("caseInsensitive") @Nullable Boolean caseInsensitive, @Param("userName") @Nullable String userName);
/**
* Find user keys by query
*
* Finds users with a structured query and returns a [paginated](#pagination) list of user keys.
* This operation takes the users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who match the structured query, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* The query statements are:
* *
* {@code is assignee of PROJ} Returns the users that are assignees of at least one issue in project *PROJ*.
* *
* {@code is assignee of (PROJ-1, PROJ-2)} Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is reporter of (PROJ-1, PROJ-2)} Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is watcher of (PROJ-1, PROJ-2)} Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is voter of (PROJ-1, PROJ-2)} Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is commenter of (PROJ-1, PROJ-2)} Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is transitioner of (PROJ-1, PROJ-2)} Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.
* *
* {@code [propertyKey].entity.property.path is "property value"} Returns users with the entity property value.
* The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the {@code AND} and {@code OR} operators to form more complex queries. For example:
* {@code is assignee of PROJ AND [propertyKey].entity.property.path is "property value"}
*
* Authentication - Required Scopes: [read:jira-user]
* @param query The search query. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResult The maximum number of items to return per page. (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/user/search/query/key?query={query}&startAt={startAt}&maxResult={maxResult}")
@Headers({
"Accept: application/json"
})
PageBeanUserKey findUserKeysByQuery(@Param("query") @NotNull String query, @Param("startAt") @Nullable Long startAt, @Param("maxResult") @Nullable Integer maxResult);
/**
* Find users
*
* Returns a list of active users that match the search string and property.
* This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user. To get all the users who match the search string and property, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* This operation can be accessed anonymously.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results.
*
* Authentication - Required Scopes: [read:jira-user]
* @param query A query string that is matched against user attributes ( {@code displayName}, and {@code emailAddress}) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a {@code displayName} of *John Smith* and a user with an {@code emailAddress} of *[email protected]*. Required, unless {@code accountId} or {@code property} is specified. (optional)
* @param username (optional)
* @param accountId A query string that is matched exactly against a user {@code accountId}. Required, unless {@code query} or {@code property} is specified. (optional)
* @param startAt The index of the first item to return in a page of filtered results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param property A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of {@code nested} from {@code {"something":{"nested":1,"other":2}}} use {@code thepropertykey.something.nested=1}. Required, unless {@code accountId} or {@code query} is specified. (optional)
*/
@RequestLine("GET /rest/api/3/user/search?query={query}&username={username}&accountId={accountId}&startAt={startAt}&maxResults={maxResults}&property={property}")
@Headers({
"Accept: application/json"
})
List findUsers(@Param("query") @Nullable String query, @Param("username") @Nullable String username, @Param("accountId") @Nullable String accountId, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("property") @Nullable String property);
/**
* Find users and groups
*
* Returns a list of users and groups matching a string. The string is used:
* *
* for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
* *
* for groups, to find a case-sensitive match with group name.
* For example, if the string *tin* is used, records with the display name *Tina*, email address *[email protected]*, and the group *accounting* would be returned.
* Optionally, the search can be refined to:
* *
* the projects and issue types associated with a custom field, such as a user picker. The search can then be further refined to return only users and groups that have permission to view specific:
*
*
*
*
* *
* projects.
*
*
* *
* issue types.
*
*
*
*
* If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.
* *
* not return Connect app users and groups.
* *
* return groups that have a case-insensitive match with the query.
* The primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an {@code html} field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically *Showing X of Y matching groups*.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/yodKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param query The search string. (required)
* @param maxResults The maximum number of items to return in each list. (optional, defaults to 50)
* @param showAvatar Whether the user avatar should be returned. If an invalid value is provided, the default value is used. (optional, defaults to false)
* @param fieldId The custom field ID of the field this request is for. (optional)
* @param projectId The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, {@code projectId=10000&projectId=10001}. This parameter is only used when {@code fieldId} is present. (optional)
* @param issueTypeId The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, {@code issueTypeId=10000&issueTypeId=10001}. Special values, such as {@code -1} (all standard issue types) and {@code -2} (all subtask issue types), are supported. This parameter is only used when {@code fieldId} is present. (optional)
* @param avatarSize The size of the avatar to return. If an invalid value is provided, the default value is used. (optional, defaults to xsmall)
* @param caseInsensitive Whether the search for groups should be case insensitive. (optional, defaults to false)
* @param excludeConnectAddons Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used. (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/groupuserpicker?query={query}&maxResults={maxResults}&showAvatar={showAvatar}&fieldId={fieldId}&projectId={projectId}&issueTypeId={issueTypeId}&avatarSize={avatarSize}&caseInsensitive={caseInsensitive}&excludeConnectAddons={excludeConnectAddons}")
@Headers({
"Accept: application/json"
})
FoundUsersAndGroups findUsersAndGroups(@Param("query") @NotNull String query, @Param("maxResults") @Nullable Integer maxResults, @Param("showAvatar") @Nullable Boolean showAvatar, @Param("fieldId") @Nullable String fieldId, @Param("projectId") @Nullable List projectId, @Param("issueTypeId") @Nullable List issueTypeId, @Param("avatarSize") @Nullable String avatarSize, @Param("caseInsensitive") @Nullable Boolean caseInsensitive, @Param("excludeConnectAddons") @Nullable Boolean excludeConnectAddons);
/**
* Find users by query
*
* Finds users with a structured query and returns a [paginated](#pagination) list of user details.
* This operation takes the users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who match the structured query, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* The query statements are:
* *
* {@code is assignee of PROJ} Returns the users that are assignees of at least one issue in project *PROJ*.
* *
* {@code is assignee of (PROJ-1, PROJ-2)} Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is reporter of (PROJ-1, PROJ-2)} Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is watcher of (PROJ-1, PROJ-2)} Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is voter of (PROJ-1, PROJ-2)} Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is commenter of (PROJ-1, PROJ-2)} Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.
* *
* {@code is transitioner of (PROJ-1, PROJ-2)} Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.
* *
* {@code [propertyKey].entity.property.path is "property value"} Returns users with the entity property value.
* The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the {@code AND} and {@code OR} operators to form more complex queries. For example:
* {@code is assignee of PROJ AND [propertyKey].entity.property.path is "property value"}
*
* Authentication - Required Scopes: [read:jira-user]
* @param query The search query. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/user/search/query?query={query}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanUser findUsersByQuery(@Param("query") @NotNull String query, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Find users for picker
*
* Returns a list of users whose attributes match the query term. The returned object includes the {@code html} field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.
* This operation takes the users in the range defined by {@code maxResults}, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who match the query term, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only.
*
* Authentication - Required Scopes: [read:jira-user]
* @param query A query string that is matched against user attributes, such as {@code displayName}, and {@code emailAddress}, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a {@code displayName} of *John Smith* and a user with an {@code emailAddress} of *[email protected]*. (required)
* @param maxResults The maximum number of items to return. The total number of matched users is returned in {@code total}. (optional, defaults to 50)
* @param showAvatar Include the URI to the user's avatar. (optional, defaults to false)
* @param exclude This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param excludeAccountIds A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, {@code excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5}. Cannot be provided with {@code exclude}. (optional)
* @param avatarSize (optional)
* @param excludeConnectUsers (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/user/picker?query={query}&maxResults={maxResults}&showAvatar={showAvatar}&exclude={exclude}&excludeAccountIds={excludeAccountIds}&avatarSize={avatarSize}&excludeConnectUsers={excludeConnectUsers}")
@Headers({
"Accept: application/json"
})
FoundUsers findUsersForPicker(@Param("query") @NotNull String query, @Param("maxResults") @Nullable Integer maxResults, @Param("showAvatar") @Nullable Boolean showAvatar, @Param("exclude") @Nullable List exclude, @Param("excludeAccountIds") @Nullable List excludeAccountIds, @Param("avatarSize") @Nullable String avatarSize, @Param("excludeConnectUsers") @Nullable Boolean excludeConnectUsers);
/**
* Find users with permissions
*
* Returns a list of users who fulfill these criteria:
* *
* their user attributes match a search string.
* *
* they have a set of permissions for a project or issue.
* If no search string is provided, a list of all users with the permissions is returned.
* This operation takes the users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who match the search string and have permission for the project or issue, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project.
* *
* *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project.
*
* Authentication - Required Scopes: [read:jira-user]
* @param permissions A comma separated list of permissions. Permissions can be specified as any: * permission returned by [Get all permissions](#api-rest-api-3-permissions-get). * custom project permission added by Connect apps. * (deprecated) one of the following: * ASSIGNABLE\\_USER * ASSIGN\\_ISSUE * ATTACHMENT\\_DELETE\\_ALL * ATTACHMENT\\_DELETE\\_OWN * BROWSE * CLOSE\\_ISSUE * COMMENT\\_DELETE\\_ALL * COMMENT\\_DELETE\\_OWN * COMMENT\\_EDIT\\_ALL * COMMENT\\_EDIT\\_OWN * COMMENT\\_ISSUE * CREATE\\_ATTACHMENT * CREATE\\_ISSUE * DELETE\\_ISSUE * EDIT\\_ISSUE * LINK\\_ISSUE * MANAGE\\_WATCHER\\_LIST * MODIFY\\_REPORTER * MOVE\\_ISSUE * PROJECT\\_ADMIN * RESOLVE\\_ISSUE * SCHEDULE\\_ISSUE * SET\\_ISSUE\\_SECURITY * TRANSITION\\_ISSUE * VIEW\\_VERSION\\_CONTROL * VIEW\\_VOTERS\\_AND\\_WATCHERS * VIEW\\_WORKFLOW\\_READONLY * WORKLOG\\_DELETE\\_ALL * WORKLOG\\_DELETE\\_OWN * WORKLOG\\_EDIT\\_ALL * WORKLOG\\_EDIT\\_OWN * WORK\\_ISSUE (required)
* @param query A query string that is matched against user attributes, such as {@code displayName} and {@code emailAddress}, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a {@code displayName} of *John Smith* and a user with an {@code emailAddress} of *[email protected]*. Required, unless {@code accountId} is specified. (optional)
* @param username This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param accountId A query string that is matched exactly against user {@code accountId}. Required, unless {@code query} is specified. (optional)
* @param issueKey The issue key for the issue. (optional)
* @param projectKey The project key for the project (case sensitive). (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/user/permission/search?query={query}&username={username}&accountId={accountId}&permissions={permissions}&issueKey={issueKey}&projectKey={projectKey}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
List findUsersWithAllPermissions(@Param("permissions") @NotNull String permissions, @Param("query") @Nullable String query, @Param("username") @Nullable String username, @Param("accountId") @Nullable String accountId, @Param("issueKey") @Nullable String issueKey, @Param("projectKey") @Nullable String projectKey, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Find users with browse permission
*
* Returns a list of users who fulfill these criteria:
* *
* their user attributes match a search string.
* *
* they have permission to browse issues.
* Use this resource to find users who can browse:
* *
* an issue, by providing the {@code issueKey}.
* *
* any issue in a project, by providing the {@code projectKey}.
* This operation takes the users in the range defined by {@code startAt} and {@code maxResults}, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified in {@code maxResults}. To get all the users who match the search string and have permission to browse issues, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results.
*
* Authentication - Required Scopes: [read:jira-user]
* @param query A query string that is matched against user attributes, such as {@code displayName} and {@code emailAddress}, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a {@code displayName} of *John Smith* and a user with an {@code emailAddress} of *[email protected]*. Required, unless {@code accountId} is specified. (optional)
* @param username This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
* @param accountId A query string that is matched exactly against user {@code accountId}. Required, unless {@code query} is specified. (optional)
* @param issueKey The issue key for the issue. Required, unless {@code projectKey} is specified. (optional)
* @param projectKey The project key for the project (case sensitive). Required, unless {@code issueKey} is specified. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/user/viewissue/search?query={query}&username={username}&accountId={accountId}&issueKey={issueKey}&projectKey={projectKey}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
List findUsersWithBrowsePermission(@Param("query") @Nullable String query, @Param("username") @Nullable String username, @Param("accountId") @Nullable String accountId, @Param("issueKey") @Nullable String issueKey, @Param("projectKey") @Nullable String projectKey, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Fully update project role
*
* Updates the project role's name and description. You must include both a name and a description in the request.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param createUpdateRoleRequestBean (required)
*/
@RequestLine("PUT /rest/api/3/role/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
ProjectRole fullyUpdateProjectRole(@Param("id") @NotNull Long id, @NotNull CreateUpdateRoleRequestBean createUpdateRoleRequestBean);
/**
* Get accessible project type by key
*
* Returns a [project type](https://confluence.atlassian.com/x/Var1Nw) if it is accessible to the user.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectTypeKey The key of the project type. (required)
*/
@RequestLine("GET /rest/api/3/project/type/{projectTypeKey}/accessible")
@Headers({
"Accept: application/json"
})
ProjectType getAccessibleProjectTypeByKey(@Param("projectTypeKey") @NotNull String projectTypeKey);
/**
* Get advanced settings
*
* Returns the application properties that are accessible on the *Advanced Settings* page. To navigate to the *Advanced Settings* page in Jira, choose the Jira icon > **Jira settings** > **System**, **General Configuration** and then click **Advanced Settings** (in the upper right).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/application-properties/advanced-settings")
@Headers({
"Accept: application/json"
})
List getAdvancedSettings();
/**
* Get licensed project types
*
* Returns all [project types](https://confluence.atlassian.com/x/Var1Nw) with a valid license.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/project/type/accessible")
@Headers({
"Accept: application/json"
})
List getAllAccessibleProjectTypes();
/**
* Get all application roles
*
* Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
*/
@RequestLine("GET /rest/api/3/applicationrole")
@Headers({
"Accept: application/json"
})
List getAllApplicationRoles();
/**
* Get available gadgets
*
* Gets a list of all available gadgets that can be added to all dashboards.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/dashboard/gadgets")
@Headers({
"Accept: application/json"
})
AvailableDashboardGadgetsResponse getAllAvailableDashboardGadgets();
/**
* Get all dashboards
*
* Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param filter The filter applied to the list of dashboards. Valid values are: * {@code favourite} Returns dashboards the user has marked as favorite. * {@code my} Returns dashboards owned by the user. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 20)
*/
@RequestLine("GET /rest/api/3/dashboard?filter={filter}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageOfDashboards getAllDashboards(@Param("filter") @Nullable String filter, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get all field configurations
*
* Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
* *
* a list of field configuration item IDs.
* *
* whether the field configuration is a default.
* *
* whether the field configuration name or description contains a query string.
* Only field configurations used in company-managed (classic) projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param id The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, {@code id=10000&id=10001}. (optional)
* @param isDefault If *true* returns default field configurations only. (optional, defaults to false)
* @param query The query string used to match against field configuration names and descriptions. (optional)
*/
@RequestLine("GET /rest/api/3/fieldconfiguration?startAt={startAt}&maxResults={maxResults}&id={id}&isDefault={isDefault}&query={query}")
@Headers({
"Accept: application/json"
})
PageBeanFieldConfigurationDetails getAllFieldConfigurations(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("id") @Nullable Set id, @Param("isDefault") @Nullable Boolean isDefault, @Param("query") @Nullable String query);
/**
* Get all fieldg rnfiguration schemes
*
* Returns a [paginated](#pagination) list of field configuration schemes.
* Only field configuration schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param id The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, {@code id=10000&id=10001}. (optional)
*/
@RequestLine("GET /rest/api/3/fieldconfigurationscheme?startAt={startAt}&maxResults={maxResults}&id={id}")
@Headers({
"Accept: application/json"
})
PageBeanFieldConfigurationScheme getAllFieldgRnfigurationSchemes(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("id") @Nullable Set id);
/**
* Get gadgets
*
* Returns a list of dashboard gadgets on a dashboard.
* This operation returns:
* *
* Gadgets from a list of IDs, when {@code id} is set.
* *
* Gadgets with a module key, when {@code moduleKey} is set.
* *
* Gadgets from a list of URIs, when {@code uri} is set.
* *
* All gadgets, when no other parameters are set.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param dashboardId The ID of the dashboard. (required)
* @param moduleKey The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: {@code moduleKey=key:one&moduleKey=key:two}. (optional)
* @param uri The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: {@code uri=/rest/example/uri/1&uri=/rest/example/uri/2}. (optional)
* @param gadgetId The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: {@code gadgetId=10000&gadgetId=10001}. (optional)
*/
@RequestLine("GET /rest/api/3/dashboard/{dashboardId}/gadget?moduleKey={moduleKey}&uri={uri}&gadgetId={gadgetId}")
@Headers({
"Accept: application/json"
})
DashboardGadgetResponse getAllGadgets(@Param("dashboardId") @NotNull Long dashboardId, @Param("moduleKey") @Nullable List moduleKey, @Param("uri") @Nullable List uri, @Param("gadgetId") @Nullable List gadgetId);
/**
* Get all issue field options
*
* Returns a [paginated](#pagination) list of all the options of a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select a value from a list of options.
* Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldKey The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the {@code fieldKey} value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the {@code jiraIssueFields} module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in {@code key}. For example, {@code "key": "teams-add-on__team-issue-field"} (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/field/{fieldKey}/option?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanIssueFieldOption getAllIssueFieldOptions(@Param("fieldKey") @NotNull String fieldKey, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get all issue type schemes
*
* Returns a [paginated](#pagination) list of issue type schemes.
* Only issue type schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param id The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, {@code id=10000&id=10001}. (optional)
* @param orderBy [Order](#ordering) the results by a field: * {@code name} Sorts by issue type scheme name. * {@code id} Sorts by issue type scheme ID. (optional, defaults to id)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code projects} For each issue type schemes, returns information about the projects the issue type scheme is assigned to. * {@code issueTypes} For each issue type schemes, returns information about the issueTypes the issue type scheme have. (optional)
* @param queryString String used to perform a case-insensitive partial match with issue type scheme name. (optional)
*/
@RequestLine("GET /rest/api/3/issuetypescheme?startAt={startAt}&maxResults={maxResults}&id={id}&orderBy={orderBy}&expand={expand}&queryString={queryString}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeScheme getAllIssueTypeSchemes(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("id") @Nullable Set id, @Param("orderBy") @Nullable String orderBy, @Param("expand") @Nullable String expand, @Param("queryString") @Nullable String queryString);
/**
* Get all labels
*
* Returns a [paginated](#pagination) list of labels.
*
* Authentication - Required Scopes: [read:jira-work]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 1000)
*/
@RequestLine("GET /rest/api/3/label?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanString getAllLabels(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get all permission schemes
*
* Returns all permission schemes.
* ### About permission schemes and grants ###
* A permission scheme is a collection of permission grants. A permission grant consists of a {@code holder} and a {@code permission}.
* #### Holder object ####
* The {@code holder} object contains information about the user or group being granted the permission. For example, the *Administer projects* permission is granted to a group named *Teams in space administrators*. In this case, the type is {@code "type": "group"}, and the parameter is the group name, {@code "parameter": "Teams in space administrators"} and the value is group ID, {@code "value": "ca85fac0-d974-40ca-a615-7af99c48d24f"}.
* The {@code holder} object is defined by the following properties:
* *
* {@code type} Identifies the user or group (see the list of types below).
* *
* {@code parameter} As a group's name can change, use of {@code value} is recommended. The value of this property depends on the {@code type}. For example, if the {@code type} is a group, then you need to specify the group name.
* *
* {@code value} The value of this property depends on the {@code type}. If the {@code type} is a group, then you need to specify the group ID. For other {@code type} it has the same value as {@code parameter}
* The following {@code types} are available. The expected values for {@code parameter} and {@code value} are given in parentheses (some types may not have a {@code parameter} or {@code value}):
* *
* {@code anyone} Grant for anonymous users.
* *
* {@code applicationRole} Grant for users with access to the specified application (application name, application name). See [Update product access settings](https://confluence.atlassian.com/x/3YxjL) for more information.
* *
* {@code assignee} Grant for the user currently assigned to an issue.
* *
* {@code group} Grant for the specified group ({@code parameter} : group name, {@code value} : group ID).
* *
* {@code groupCustomField} Grant for a user in the group selected in the specified custom field ({@code parameter} : custom field ID, {@code value} : custom field ID).
* *
* {@code projectLead} Grant for a project lead.
* *
* {@code projectRole} Grant for the specified project role ({@code parameter} :project role ID, {@code value} : project role ID).
* *
* {@code reporter} Grant for the user who reported the issue.
* *
* {@code sd.customer.portal.only} Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See [Customizing Jira Service Desk permissions](https://confluence.atlassian.com/x/24dKLg) for more information.
* *
* {@code user} Grant for the specified user ({@code parameter} : user ID - historically this was the userkey but that is deprecated and the account ID should be used, {@code value} : user ID).
* *
* {@code userCustomField} Grant for a user selected in the specified custom field ({@code parameter} : custom field ID, {@code value} : custom field ID).
* #### Built-in permissions ####
* The [built-in Jira permissions](https://confluence.atlassian.com/x/yodKLg) are listed below. Apps can also define custom permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information.
* **Project permissions**
* *
* {@code ADMINISTER_PROJECTS}
* *
* {@code BROWSE_PROJECTS}
* *
* {@code MANAGE_SPRINTS_PERMISSION} (Jira Software only)
* *
* {@code SERVICEDESK_AGENT} (Jira Service Desk only)
* *
* {@code VIEW_DEV_TOOLS} (Jira Software only)
* *
* {@code VIEW_READONLY_WORKFLOW}
* **Issue permissions**
* *
* {@code ASSIGNABLE_USER}
* *
* {@code ASSIGN_ISSUES}
* *
* {@code CLOSE_ISSUES}
* *
* {@code CREATE_ISSUES}
* *
* {@code DELETE_ISSUES}
* *
* {@code EDIT_ISSUES}
* *
* {@code LINK_ISSUES}
* *
* {@code MODIFY_REPORTER}
* *
* {@code MOVE_ISSUES}
* *
* {@code RESOLVE_ISSUES}
* *
* {@code SCHEDULE_ISSUES}
* *
* {@code SET_ISSUE_SECURITY}
* *
* {@code TRANSITION_ISSUES}
* **Voters and watchers permissions**
* *
* {@code MANAGE_WATCHERS}
* *
* {@code VIEW_VOTERS_AND_WATCHERS}
* **Comments permissions**
* *
* {@code ADD_COMMENTS}
* *
* {@code DELETE_ALL_COMMENTS}
* *
* {@code DELETE_OWN_COMMENTS}
* *
* {@code EDIT_ALL_COMMENTS}
* *
* {@code EDIT_OWN_COMMENTS}
* **Attachments permissions**
* *
* {@code CREATE_ATTACHMENTS}
* *
* {@code DELETE_ALL_ATTACHMENTS}
* *
* {@code DELETE_OWN_ATTACHMENTS}
* **Time tracking permissions**
* *
* {@code DELETE_ALL_WORKLOGS}
* *
* {@code DELETE_OWN_WORKLOGS}
* *
* {@code EDIT_ALL_WORKLOGS}
* *
* {@code EDIT_OWN_WORKLOGS}
* *
* {@code WORK_ON_ISSUES}
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code permissions} Returns all permission grants for each permission scheme. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("GET /rest/api/3/permissionscheme?expand={expand}")
@Headers({
"Accept: application/json"
})
PermissionSchemes getAllPermissionSchemes(@Param("expand") @Nullable String expand);
/**
* Get all permissions
*
* Returns all permissions, including:
* *
* global permissions.
* *
* project permissions.
* *
* global permissions added by plugins.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/permissions")
@Headers({
"Accept: application/json"
})
Permissions getAllPermissions();
/**
* Get all project avatars
*
* Returns all project avatars, grouped by system and custom avatars.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The ID or (case-sensitive) key of the project. (required)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/avatars")
@Headers({
"Accept: application/json"
})
ProjectAvatars getAllProjectAvatars(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Get all project categories
*
* Returns all project categories.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/projectCategory")
@Headers({
"Accept: application/json"
})
List getAllProjectCategories();
/**
* Get all project roles
*
* Gets a list of all project roles, complete with project role details and default actors.
* ### About project roles ###
* [Project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).
* Project roles are used in [permission schemes](#api-rest-api-3-permissionscheme-get), [email notification schemes](#api-rest-api-3-notificationscheme-get), [issue security levels](#api-rest-api-3-issuesecurityschemes-get), [comment visibility](#api-rest-api-3-comment-list-post), and workflow conditions.
* #### Members and actors ####
* In the Jira REST API, a member of a project role is called an *actor*. An *actor* is a group or user associated with a project role.
* Actors may be set as [default members](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/#Specifying-'default-members'-for-a-project-role) of the project role or set at the project level:
* *
* Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.
* *
* Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/role")
@Headers({
"Accept: application/json"
})
List getAllProjectRoles();
/**
* Get all project types
*
* Returns all [project types](https://confluence.atlassian.com/x/Var1Nw), whether or not the instance has a valid license for each type.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/project/type")
@Headers({
"Accept: application/json"
})
List getAllProjectTypes();
/**
* Get all projects
*
* Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-rest-api-3-project-search-get) that supports search and pagination.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * {@code description} Returns the project description. * {@code issueTypes} Returns all issue types associated with the project. * {@code lead} Returns information about the project lead. * {@code projectKeys} Returns all project keys associated with the project. (optional)
* @param recent Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session. (optional)
* @param properties A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional)
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/project?expand={expand}&recent={recent}&properties={properties}")
@Headers({
"Accept: application/json"
})
List getAllProjects(@Param("expand") @Nullable String expand, @Param("recent") @Nullable Integer recent, @Param("properties") @Nullable List properties);
/**
* Get all screen tab fields
*
* Returns all fields for a screen tab.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* *
* *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
* @param tabId The ID of the screen tab. (required)
* @param projectKey The key of the project. (optional)
*/
@RequestLine("GET /rest/api/3/screens/{screenId}/tabs/{tabId}/fields?projectKey={projectKey}")
@Headers({
"Accept: application/json"
})
List getAllScreenTabFields(@Param("screenId") @NotNull Long screenId, @Param("tabId") @NotNull Long tabId, @Param("projectKey") @Nullable String projectKey);
/**
* Get all screen tabs
*
* Returns the list of tabs for a screen.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* *
* *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
* @param projectKey The key of the project. (optional)
*/
@RequestLine("GET /rest/api/3/screens/{screenId}/tabs?projectKey={projectKey}")
@Headers({
"Accept: application/json"
})
List getAllScreenTabs(@Param("screenId") @NotNull Long screenId, @Param("projectKey") @Nullable String projectKey);
/**
* Get all statuses for project
*
* 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.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/statuses")
@Headers({
"Accept: application/json"
})
List getAllStatuses(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Get system avatars by type
*
* Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param type The avatar type. (required)
*/
@RequestLine("GET /rest/api/3/avatar/{type}/system")
@Headers({
"Accept: application/json"
})
SystemAvatars getAllSystemAvatars(@Param("type") @NotNull String type);
/**
* Get all users
*
* Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-user]
* @param startAt The index of the first item to return. (optional, defaults to 0)
* @param maxResults The maximum number of items to return. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/users/search?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
List getAllUsers(@Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get all users default
*
* Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.
* Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.
* **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-user]
* @param startAt The index of the first item to return. (optional, defaults to 0)
* @param maxResults The maximum number of items to return. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/users?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
List getAllUsersDefault(@Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get all workflow schemes
*
* Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/workflowscheme?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanWorkflowScheme getAllWorkflowSchemes(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get all workflows
*
* Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows paginated](#api-rest-api-3-workflow-search-get).
* If the {@code workflowName} parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param workflowName The name of the workflow to be returned. Only one workflow can be specified. (optional)
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/workflow?workflowName={workflowName}")
@Headers({
"Accept: application/json"
})
List getAllWorkflows(@Param("workflowName") @Nullable String workflowName);
/**
* Get alternative issue types
*
* Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the issue type. (required)
*/
@RequestLine("GET /rest/api/3/issuetype/{id}/alternatives")
@Headers({
"Accept: application/json"
})
List getAlternativeIssueTypes(@Param("id") @NotNull String id);
/**
* Get application property
*
* Returns all application properties or an application property.
* If you specify a value for the {@code key} parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See [Set application property](#api-rest-api-3-application-properties-id-put) for descriptions of editable properties.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param key The key of the application property. (optional)
* @param permissionLevel The permission level of all items being returned in the list. (optional)
* @param keyFilter When a {@code key} isn't provided, this filters the list of results by the application property {@code key} using a regular expression. For example, using {@code jira.lf.*} will return all application properties with keys that start with *jira.lf.*. (optional)
*/
@RequestLine("GET /rest/api/3/application-properties?key={key}&permissionLevel={permissionLevel}&keyFilter={keyFilter}")
@Headers({
"Accept: application/json"
})
List getApplicationProperty(@Param("key") @Nullable String key, @Param("permissionLevel") @Nullable String permissionLevel, @Param("keyFilter") @Nullable String keyFilter);
/**
* Get application role
*
* Returns an application role.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* @param key The key of the application role. Use the [Get all application roles](#api-rest-api-3-applicationrole-get) operation to get the key for each application role. (required)
*/
@RequestLine("GET /rest/api/3/applicationrole/{key}")
@Headers({
"Accept: application/json"
})
ApplicationRole getApplicationRole(@Param("key") @NotNull String key);
/**
* Get approximate application license count
*
* Returns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param applicationKey The ID of the application, represents a specific version of Jira. (required)
*/
@RequestLine("GET /rest/api/3/license/approximateLicenseCount/product/{applicationKey}")
@Headers({
"Accept: application/json"
})
LicenseMetric getApproximateApplicationLicenseCount(@Param("applicationKey") @NotNull String applicationKey);
/**
* Get approximate license count
*
* Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/license/approximateLicenseCount")
@Headers({
"Accept: application/json"
})
LicenseMetric getApproximateLicenseCount();
/**
* Get assigned permission scheme
*
* Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg) associated with the project.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectKeyOrId The project ID or project key (case sensitive). (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code permissions} Returns all permission grants for each permission scheme. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("GET /rest/api/3/project/{projectKeyOrId}/permissionscheme?expand={expand}")
@Headers({
"Accept: application/json"
})
PermissionScheme getAssignedPermissionScheme(@Param("projectKeyOrId") @NotNull String projectKeyOrId, @Param("expand") @Nullable String expand);
/**
* Get attachment metadata
*
* Returns the metadata for an attachment. Note that the attachment itself is not returned.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the attachment. (required)
*/
@RequestLine("GET /rest/api/3/attachment/{id}")
@Headers({
"Accept: application/json"
})
AttachmentMetadata getAttachment(@Param("id") @NotNull String id);
/**
* Get attachment content
*
* Returns the contents of an attachment. A {@code Range} header can be set to define a range of bytes within the attachment to download. See the [HTTP Range header standard](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range) for details.
* To return a thumbnail of the attachment, use [Get attachment thumbnail](#api-rest-api-3-attachment-thumbnail-id-get).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** For the issue containing the attachment:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the attachment. (required)
* @param redirect Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to {@code false} to avoid making multiple requests to download the attachment. (optional, defaults to true)
*/
@RequestLine("GET /rest/api/3/attachment/content/{id}?redirect={redirect}")
@Headers({
"Accept: application/json"
})
Object getAttachmentContent(@Param("id") @NotNull String id, @Param("redirect") @Nullable Boolean redirect);
/**
* Get Jira attachment settings
*
* Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.
* Note that there are also [project permissions](https://confluence.atlassian.com/x/yodKLg) that restrict whether users can create and delete attachments.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/attachment/meta")
@Headers({
"Accept: application/json"
})
AttachmentSettings getAttachmentMeta();
/**
* Get attachment thumbnail
*
* Returns the thumbnail of an attachment.
* To return the attachment contents, use [Get attachment content](#api-rest-api-3-attachment-content-id-get).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** For the issue containing the attachment:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the attachment. (required)
* @param redirect Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to {@code false} to avoid making multiple requests to download the attachment. (optional, defaults to true)
* @param fallbackToDefault Whether a default thumbnail is returned when the requested thumbnail is not found. (optional, defaults to true)
* @param width The maximum width to scale the thumbnail to. (optional)
* @param height The maximum height to scale the thumbnail to. (optional)
*/
@RequestLine("GET /rest/api/3/attachment/thumbnail/{id}?redirect={redirect}&fallbackToDefault={fallbackToDefault}&width={width}&height={height}")
@Headers({
"Accept: application/json"
})
Object getAttachmentThumbnail(@Param("id") @NotNull String id, @Param("redirect") @Nullable Boolean redirect, @Param("fallbackToDefault") @Nullable Boolean fallbackToDefault, @Param("width") @Nullable Integer width, @Param("height") @Nullable Integer height);
/**
* Get audit records
*
* Returns a list of audit records. The list can be filtered to include items:
* *
* where each item in {@code filter} has at least one match in any of these fields:
*
*
*
*
* *
* {@code summary}
*
*
* *
* {@code category}
*
*
* *
* {@code eventSource}
*
*
* *
* {@code objectItem.name} If the object is a user, account ID is available to filter.
*
*
* *
* {@code objectItem.parentName}
*
*
* *
* {@code objectItem.typeName}
*
*
* *
* {@code changedValues.changedFrom}
*
*
* *
* {@code changedValues.changedTo}
*
*
* *
* {@code remoteAddress}
*
*
*
*
* For example, if {@code filter} contains *man ed*, an audit record containing {@code summary": "User added to group"} and {@code "category": "group management"} is returned.
* *
* created on or after a date and time.
* *
* created or or before a date and time.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param offset The number of records to skip before returning the first result. (optional, defaults to 0)
* @param limit The maximum number of results to return. (optional, defaults to 1000)
* @param filter The strings to match with audit field content, space separated. (optional)
* @param from The date and time on or after which returned audit records must have been created. If {@code to} is provided {@code from} must be before {@code to} or no audit records are returned. (optional)
* @param to The date and time on or before which returned audit results must have been created. If {@code from} is provided {@code to} must be after {@code from} or no audit records are returned. (optional)
*/
@RequestLine("GET /rest/api/3/auditing/record?offset={offset}&limit={limit}&filter={filter}&from={from}&to={to}")
@Headers({
"Accept: application/json"
})
AuditRecords getAuditRecords(@Param("offset") @Nullable Integer offset, @Param("limit") @Nullable Integer limit, @Param("filter") @Nullable String filter, @Param("from") @Nullable String from, @Param("to") @Nullable String to);
/**
* Get field reference data (GET)
*
* Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.
* To filter visible field details by project or collapse non-unique fields by field type then [Get field reference data (POST)](#api-rest-api-3-jql-autocompletedata-post) can be used.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/jql/autocompletedata")
@Headers({
"Accept: application/json"
})
JQLReferenceData getAutoComplete();
/**
* Get field reference data (POST)
*
* Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.
* This operation can filter the custom fields returned by project. Invalid project IDs in {@code projectIds} are ignored. System fields are always returned.
* It can also return the collapsed field for custom fields. Collapsed fields enable searches to be performed across all fields with the same name and of the same field type. For example, the collapsed field {@code Component - Component[Dropdown]} enables dropdown fields {@code Component - cf[10061]} and {@code Component - cf[10062]} to be searched simultaneously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param searchAutoCompleteFilter (required)
*/
@RequestLine("POST /rest/api/3/jql/autocompletedata")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
JQLReferenceData getAutoCompletePost(@NotNull SearchAutoCompleteFilter searchAutoCompleteFilter);
/**
* Get available screen fields
*
* Returns the fields that can be added to a tab on a screen.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The ID of the screen. (required)
*/
@RequestLine("GET /rest/api/3/screens/{screenId}/availableFields")
@Headers({
"Accept: application/json"
})
List getAvailableScreenFields(@Param("screenId") @NotNull Long screenId);
/**
* Get all time tracking providers
*
* Returns all time tracking providers. By default, Jira only has one time tracking provider: *JIRA provided time tracking*. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the [ Time Tracking Provider](https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/) module.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/configuration/timetracking/list")
@Headers({
"Accept: application/json"
})
List getAvailableTimeTrackingImplementations();
/**
* Get avatar image by ID
*
* Returns a project or issue type avatar image by ID.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* For system avatars, none.
* *
* For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to.
* *
* For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in.
*
* Authentication - Required Scopes: [read:jira-work]
* @param type The icon type of the avatar. (required)
* @param id The ID of the avatar. (required)
* @param size The size of the avatar image. If not provided the default size is returned. (optional)
* @param format The format to return the avatar image in. If not provided the original content format is returned. (optional)
*/
@RequestLine("GET /rest/api/3/universal_avatar/view/type/{type}/avatar/{id}?size={size}&format={format}")
@Headers({
"Accept: */*"
})
void getAvatarImageByID(@Param("type") @NotNull String type, @Param("id") @NotNull Long id, @Param("size") @Nullable String size, @Param("format") @Nullable String format);
/**
* Get avatar image by owner
*
* Returns the avatar image for a project or issue type.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* For system avatars, none.
* *
* For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to.
* *
* For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in.
*
* Authentication - Required Scopes: [read:jira-work]
* @param type The icon type of the avatar. (required)
* @param entityId The ID of the project or issue type the avatar belongs to. (required)
* @param size The size of the avatar image. If not provided the default size is returned. (optional)
* @param format The format to return the avatar image in. If not provided the original content format is returned. (optional)
*/
@RequestLine("GET /rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}?size={size}&format={format}")
@Headers({
"Accept: */*"
})
void getAvatarImageByOwner(@Param("type") @NotNull String type, @Param("entityId") @NotNull String entityId, @Param("size") @Nullable String size, @Param("format") @Nullable String format);
/**
* Get avatar image by type
*
* Returns the default project or issue type avatar image.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param type The icon type of the avatar. (required)
* @param size The size of the avatar image. If not provided the default size is returned. (optional)
* @param format The format to return the avatar image in. If not provided the original content format is returned. (optional)
*/
@RequestLine("GET /rest/api/3/universal_avatar/view/type/{type}?size={size}&format={format}")
@Headers({
"Accept: */*"
})
void getAvatarImageByType(@Param("type") @NotNull String type, @Param("size") @Nullable String size, @Param("format") @Nullable String format);
/**
* Get avatars
*
* Returns the system and custom avatars for a project or issue type.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* for custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to.
* *
* for custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in.
* *
* for system avatars, none.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param type The avatar type. (required)
* @param entityId The ID of the item the avatar is associated with. (required)
*/
@RequestLine("GET /rest/api/3/universal_avatar/type/{type}/owner/{entityId}")
@Headers({
"Accept: application/json"
})
Avatars getAvatars(@Param("type") @NotNull String type, @Param("entityId") @NotNull String entityId);
/**
* Get announcement banner configuration
*
* Returns the current announcement banner configuration.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/announcementBanner")
@Headers({
"Accept: application/json"
})
AnnouncementBannerConfiguration getBanner();
/**
* Get bulk permissions
*
* Returns:
* *
* for a list of global permissions, the global permissions granted to a user.
* *
* for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate.
* If no account ID is provided, the operation returns details for the logged in user.
* Note that:
* *
* Invalid project and issue IDs are ignored.
* *
* A maximum of 1000 projects and 1000 issues can be checked.
* *
* Null values in {@code globalPermissions}, {@code projectPermissions}, {@code projectPermissions.projects}, and {@code projectPermissions.issues} are ignored.
* *
* Empty strings in {@code projectPermissions.permissions} are ignored.
* **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024.
* *
* **Classic**: {@code read:jira-work}
* *
* **Granular**: {@code read:permission:jira}
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to check the permissions for other users, otherwise none. However, Connect apps can make a call from the app server to the product to obtain permission details for any user, without admin permission. This Connect app ability doesn't apply to calls made using AP.request() in a browser.
*
* @param bulkPermissionsRequestBean Details of the permissions to check. (required)
*/
@RequestLine("POST /rest/api/3/permissions/check")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
BulkPermissionGrants getBulkPermissions(@NotNull BulkPermissionsRequestBean bulkPermissionsRequestBean);
/**
* Get bulk screen tabs
*
* Returns the list of tabs for a bulk of screens.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param screenId The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example, {@code screenId=10000&screenId=10001}. (optional)
* @param tabId The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example, {@code tabId=10000&tabId=10001}. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResult The maximum number of items to return per page. The maximum number is 100, (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/screens/tabs?screenId={screenId}&tabId={tabId}&startAt={startAt}&maxResult={maxResult}")
@Headers({
"Accept: application/json"
})
void getBulkScreenTabs(@Param("screenId") @Nullable Set screenId, @Param("tabId") @Nullable Set tabId, @Param("startAt") @Nullable Long startAt, @Param("maxResult") @Nullable Integer maxResult);
/**
* Get changelogs
*
* Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/changelog?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanChangelog getChangeLogs(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get changelogs by IDs
*
* Returns changelogs for an issue specified by a list of changelog IDs.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param issueChangelogIds (required)
*/
@RequestLine("POST /rest/api/3/issue/{issueIdOrKey}/changelog/list")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PageOfChangelogs getChangeLogsByIds(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @NotNull IssueChangelogIds issueChangelogIds);
/**
* Get columns
*
* Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None, however, column details are only returned for:
* *
* filters owned by the user.
* *
* filters shared with a group that the user is a member of.
* *
* filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* *
* filters shared with a public project.
* *
* filters shared with the public.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the filter. (required)
*/
@RequestLine("GET /rest/api/3/filter/{id}/columns")
@Headers({
"Accept: application/json"
})
List getColumns(@Param("id") @NotNull Long id);
/**
* Get comment
*
* Returns a comment.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param id The ID of the comment. (required)
* @param expand Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts {@code renderedBody}, which returns the comment body rendered in HTML. (optional)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/comment/{id}?expand={expand}")
@Headers({
"Accept: application/json"
})
Comment getComment(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("id") @NotNull String id, @Param("expand") @Nullable String expand);
/**
* Get comment property
*
* Returns the value of a comment property.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [read:jira-work]
* @param commentId The ID of the comment. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("GET /rest/api/3/comment/{commentId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
EntityProperty getCommentProperty(@Param("commentId") @NotNull String commentId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Get comment property keys
*
* Returns the keys of all the properties of a comment.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [read:jira-work]
* @param commentId The ID of the comment. (required)
*/
@RequestLine("GET /rest/api/3/comment/{commentId}/properties")
@Headers({
"Accept: application/json"
})
PropertyKeys getCommentPropertyKeys(@Param("commentId") @NotNull String commentId);
/**
* Get comments
*
* Returns all comments for an issue.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Comments are included in the response where the user has:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 5000)
* @param orderBy [Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date. (optional)
* @param expand Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts {@code renderedBody}, which returns the comment body rendered in HTML. (optional)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/comment?startAt={startAt}&maxResults={maxResults}&orderBy={orderBy}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageOfComments getComments(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("orderBy") @Nullable String orderBy, @Param("expand") @Nullable String expand);
/**
* Get comments by IDs
*
* Returns a [paginated](#pagination) list of comments specified by a list of comment IDs.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Comments are returned where the user:
* *
* has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueCommentListRequestBean The list of comment IDs. (required)
* @param expand Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: * {@code renderedBody} Returns the comment body rendered in HTML. * {@code properties} Returns the comment's properties. (optional)
*/
@RequestLine("POST /rest/api/3/comment/list?expand={expand}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PageBeanComment getCommentsByIds(@NotNull IssueCommentListRequestBean issueCommentListRequestBean, @Param("expand") @Nullable String expand);
/**
* Get component
*
* Returns a component.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the component. (required)
*/
@RequestLine("GET /rest/api/3/component/{id}")
@Headers({
"Accept: application/json"
})
ProjectComponent getComponent(@Param("id") @NotNull String id);
/**
* Get component issues count
*
* Returns the counts of issues assigned to the component.
* This operation can be accessed anonymously.
* **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024.
* *
* **Classic**: {@code read:jira-work}
* *
* **Granular**: {@code read:field:jira}, {@code read:project.component:jira}
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the component. (required)
*/
@RequestLine("GET /rest/api/3/component/{id}/relatedIssueCounts")
@Headers({
"Accept: application/json"
})
ComponentIssuesCount getComponentRelatedIssues(@Param("id") @NotNull String id);
/**
* Get global settings
*
* Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-user]
*/
@RequestLine("GET /rest/api/3/configuration")
@Headers({
"Accept: application/json"
})
Configuration getConfiguration();
/**
* Get custom field contexts
*
* Returns a [paginated](#pagination) list of [ contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html) for a custom field. Contexts can be returned as follows:
* *
* With no other parameters set, all contexts.
* *
* By defining {@code id} only, all contexts from the list of IDs.
* *
* By defining {@code isAnyIssueType}, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false)
* *
* By defining {@code isGlobalContext}, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param isAnyIssueType Whether to return contexts that apply to all issue types. (optional)
* @param isGlobalContext Whether to return contexts that apply to all projects. (optional)
* @param contextId The list of context IDs. To include multiple contexts, separate IDs with ampersand: {@code contextId=10000&contextId=10001}. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/field/{fieldId}/context?isAnyIssueType={isAnyIssueType}&isGlobalContext={isGlobalContext}&contextId={contextId}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanCustomFieldContext getContextsForField(@Param("fieldId") @NotNull String fieldId, @Param("isAnyIssueType") @Nullable Boolean isAnyIssueType, @Param("isGlobalContext") @Nullable Boolean isGlobalContext, @Param("contextId") @Nullable Set contextId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get contexts for a field
*
* Returns a [paginated](#pagination) list of the contexts a field is used in. Deprecated, use [ Get custom field contexts](#api-rest-api-3-field-fieldId-context-get).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
* @param fieldId The ID of the field to return contexts for. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 20)
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/field/{fieldId}/contexts?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanContext getContextsForFieldDeprecated(@Param("fieldId") @NotNull String fieldId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get create issue metadata
*
* 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](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
* The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIds List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, {@code projectIds=10000,10001&projectIds=10020,10021}. This parameter may be provided with {@code projectKeys}. (optional)
* @param projectKeys List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, {@code projectKeys=proj1,proj2&projectKeys=proj3}. This parameter may be provided with {@code projectIds}. (optional)
* @param issuetypeIds List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, {@code issuetypeIds=10000,10001&issuetypeIds=10020,10021}. This parameter may be provided with {@code issuetypeNames}. (optional)
* @param issuetypeNames List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, {@code issuetypeNames=name1,name2&issuetypeNames=name3}. This parameter may be provided with {@code issuetypeIds}. (optional)
* @param expand Use [expand](#expansion) to include additional information about issue metadata in the response. This parameter accepts {@code projects.issuetypes.fields}, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the {@code fields} and {@code update} fields in [Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post). (optional)
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/issue/createmeta?projectIds={projectIds}&projectKeys={projectKeys}&issuetypeIds={issuetypeIds}&issuetypeNames={issuetypeNames}&expand={expand}")
@Headers({
"Accept: application/json"
})
IssueCreateMetadata getCreateIssueMeta(@Param("projectIds") @Nullable List projectIds, @Param("projectKeys") @Nullable List projectKeys, @Param("issuetypeIds") @Nullable List issuetypeIds, @Param("issuetypeNames") @Nullable List issuetypeNames, @Param("expand") @Nullable String expand);
/**
* Get create field metadata for a project and issue type id
*
* Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The ID or key of the project. (required)
* @param issueTypeId The issuetype ID. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageOfCreateMetaIssueTypeWithField getCreateIssueMetaIssueTypeId(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("issueTypeId") @NotNull String issueTypeId, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get create metadata issue types for a project
*
* Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The ID or key of the project. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageOfCreateMetaIssueTypes getCreateIssueMetaIssueTypes(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("startAt") @Nullable Integer startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get current user
*
* Returns details for the current user.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-user]
* @param expand Use [expand](#expansion) to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * {@code groups} Returns all groups, including nested groups, the user belongs to. * {@code applicationRoles} Returns the application roles the user is assigned to. (optional)
*/
@RequestLine("GET /rest/api/3/myself?expand={expand}")
@Headers({
"Accept: application/json"
})
User getCurrentUser(@Param("expand") @Nullable String expand);
/**
* Get custom field configurations
*
* Returns a [paginated](#pagination) list of configurations for a custom field of a [type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) created by a [Forge app](https://developer.atlassian.com/platform/forge/).
* The result can be filtered by one of these criteria:
* *
* {@code id}.
* *
* {@code fieldContextId}.
* *
* {@code issueId}.
* *
* {@code projectKeyOrId} and {@code issueTypeId}.
* Otherwise, all configurations are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that provided the custom field type.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldIdOrKey The ID or key of the custom field, for example {@code customfield_10000}. (required)
* @param id The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: {@code id=10000&id=10001}. Can't be provided with {@code fieldContextId}, {@code issueId}, {@code projectKeyOrId}, or {@code issueTypeId}. (optional)
* @param fieldContextId The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: {@code fieldContextId=10000&fieldContextId=10001}. Can't be provided with {@code id}, {@code issueId}, {@code projectKeyOrId}, or {@code issueTypeId}. (optional)
* @param issueId The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with {@code projectKeyOrId}, or {@code issueTypeId}. (optional)
* @param projectKeyOrId The ID or key of the project to filter results by. Must be provided with {@code issueTypeId}. Can't be provided with {@code issueId}. (optional)
* @param issueTypeId The ID of the issue type to filter results by. Must be provided with {@code projectKeyOrId}. Can't be provided with {@code issueId}. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/app/field/{fieldIdOrKey}/context/configuration?id={id}&fieldContextId={fieldContextId}&issueId={issueId}&projectKeyOrId={projectKeyOrId}&issueTypeId={issueTypeId}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanContextualConfiguration getCustomFieldConfiguration(@Param("fieldIdOrKey") @NotNull String fieldIdOrKey, @Param("id") @Nullable Set id, @Param("fieldContextId") @Nullable Set fieldContextId, @Param("issueId") @Nullable Long issueId, @Param("projectKeyOrId") @Nullable String projectKeyOrId, @Param("issueTypeId") @Nullable String issueTypeId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get custom field contexts for projects and issue types
*
* Returns a [paginated](#pagination) list of project and issue type mappings and, for each mapping, the ID of a [custom field context](https://confluence.atlassian.com/x/k44fOw) that applies to the project and issue type.
* If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is {@code null}.
* Duplicate project and issue type mappings cannot be provided in the request.
* The order of the returned values is the same as provided in the request.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param projectIssueTypeMappings The list of project and issue type mappings. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("POST /rest/api/3/field/{fieldId}/context/mapping?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PageBeanContextForProjectAndIssueType getCustomFieldContextsForProjectsAndIssueTypes(@Param("fieldId") @NotNull String fieldId, @NotNull ProjectIssueTypeMappings projectIssueTypeMappings, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get custom field option
*
* Returns a custom field option. For example, an option in a select list.
* Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** The custom field option is returned as follows:
* *
* if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* *
* if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the custom field option. (required)
*/
@RequestLine("GET /rest/api/3/customFieldOption/{id}")
@Headers({
"Accept: application/json"
})
CustomFieldOption getCustomFieldOption(@Param("id") @NotNull String id);
/**
* Get dashboard
*
* Returns a dashboard.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
* However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the dashboard. (required)
*/
@RequestLine("GET /rest/api/3/dashboard/{id}")
@Headers({
"Accept: application/json"
})
Dashboard getDashboard(@Param("id") @NotNull String id);
/**
* Get dashboard item property
*
* Returns the key and value of a dashboard item property.
* A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
* When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see [ Building a dashboard item for a JIRA Connect add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation.
* There is no resource to set or get dashboard items.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira\\\\u2019s anonymous access is permitted.
*
* Authentication - Required Scopes: [read:jira-work]
* @param dashboardId The ID of the dashboard. (required)
* @param itemId The ID of the dashboard item. (required)
* @param propertyKey The key of the dashboard item property. (required)
*/
@RequestLine("GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
EntityProperty getDashboardItemProperty(@Param("dashboardId") @NotNull String dashboardId, @Param("itemId") @NotNull String itemId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Get dashboard item property keys
*
* Returns the keys of all properties for a dashboard item.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira\\\\u2019s anonymous access is permitted.
*
* Authentication - Required Scopes: [read:jira-work]
* @param dashboardId The ID of the dashboard. (required)
* @param itemId The ID of the dashboard item. (required)
*/
@RequestLine("GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties")
@Headers({
"Accept: application/json"
})
PropertyKeys getDashboardItemPropertyKeys(@Param("dashboardId") @NotNull String dashboardId, @Param("itemId") @NotNull String itemId);
/**
* Search for dashboards
*
* Returns a [paginated](#pagination) list of dashboards. This operation is similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** The following dashboards that match the query parameters are returned:
* *
* Dashboards owned by the user. Not returned for anonymous users.
* *
* Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
* *
* Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
* *
* Dashboards shared with a public project.
* *
* Dashboards shared with the public.
*
* Authentication - Required Scopes: [read:jira-work]
* @param dashboardName String used to perform a case-insensitive partial match with {@code name}. (optional)
* @param accountId User account ID used to return dashboards with the matching {@code owner.accountId}. This parameter cannot be used with the {@code owner} parameter. (optional)
* @param owner This parameter is deprecated because of privacy changes. Use {@code accountId} instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching {@code owner.name}. This parameter cannot be used with the {@code accountId} parameter. (optional)
* @param groupname As a group's name can change, use of {@code groupId} is recommended. Group name used to return dashboards that are shared with a group that matches {@code sharePermissions.group.name}. This parameter cannot be used with the {@code groupId} parameter. (optional)
* @param groupId Group ID used to return dashboards that are shared with a group that matches {@code sharePermissions.group.groupId}. This parameter cannot be used with the {@code groupname} parameter. (optional)
* @param projectId Project ID used to returns dashboards that are shared with a project that matches {@code sharePermissions.project.id}. (optional)
* @param orderBy [Order](#ordering) the results by a field: * {@code description} Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * {@code favourite_count} Sorts by dashboard popularity. * {@code id} Sorts by dashboard ID. * {@code is_favourite} Sorts by whether the dashboard is marked as a favorite. * {@code name} Sorts by dashboard name. * {@code owner} Sorts by dashboard owner name. (optional, defaults to name)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param status The status to filter by. It may be active, archived or deleted. (optional, defaults to active)
* @param expand Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * {@code description} Returns the description of the dashboard. * {@code owner} Returns the owner of the dashboard. * {@code viewUrl} Returns the URL that is used to view the dashboard. * {@code favourite} Returns {@code isFavourite}, an indicator of whether the user has set the dashboard as a favorite. * {@code favouritedCount} Returns {@code popularity}, a count of how many users have set this dashboard as a favorite. * {@code sharePermissions} Returns details of the share permissions defined for the dashboard. * {@code editPermissions} Returns details of the edit permissions defined for the dashboard. * {@code isWritable} Returns whether the current user has permission to edit the dashboard. (optional)
*/
@RequestLine("GET /rest/api/3/dashboard/search?dashboardName={dashboardName}&accountId={accountId}&owner={owner}&groupname={groupname}&groupId={groupId}&projectId={projectId}&orderBy={orderBy}&startAt={startAt}&maxResults={maxResults}&status={status}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageBeanDashboard getDashboardsPaginated(@Param("dashboardName") @Nullable String dashboardName, @Param("accountId") @Nullable String accountId, @Param("owner") @Nullable String owner, @Param("groupname") @Nullable String groupname, @Param("groupId") @Nullable String groupId, @Param("projectId") @Nullable Long projectId, @Param("orderBy") @Nullable String orderBy, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("status") @Nullable String status, @Param("expand") @Nullable String expand);
/**
* Get default share scope
*
* Returns the default sharing settings for new filters and dashboards for a user.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/filter/defaultShareScope")
@Headers({
"Accept: application/json"
})
DefaultShareScope getDefaultShareScope();
/**
* Get custom field contexts default values
*
* Returns a [paginated](#pagination) list of defaults for a custom field. The results can be filtered by {@code contextId}, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
* The returned object depends on type of the custom field:
* *
* {@code CustomFieldContextDefaultValueDate} (type {@code datepicker}) for date fields.
* *
* {@code CustomFieldContextDefaultValueDateTime} (type {@code datetimepicker}) for date-time fields.
* *
* {@code CustomFieldContextDefaultValueSingleOption} (type {@code option.single}) for single choice select lists and radio buttons.
* *
* {@code CustomFieldContextDefaultValueMultipleOption} (type {@code option.multiple}) for multiple choice select lists and checkboxes.
* *
* {@code CustomFieldContextDefaultValueCascadingOption} (type {@code option.cascading}) for cascading select lists.
* *
* {@code CustomFieldContextSingleUserPickerDefaults} (type {@code single.user.select}) for single users.
* *
* {@code CustomFieldContextDefaultValueMultiUserPicker} (type {@code multi.user.select}) for user lists.
* *
* {@code CustomFieldContextDefaultValueSingleGroupPicker} (type {@code grouppicker.single}) for single choice group pickers.
* *
* {@code CustomFieldContextDefaultValueMultipleGroupPicker} (type {@code grouppicker.multiple}) for multiple choice group pickers.
* *
* {@code CustomFieldContextDefaultValueURL} (type {@code url}) for URLs.
* *
* {@code CustomFieldContextDefaultValueProject} (type {@code project}) for project pickers.
* *
* {@code CustomFieldContextDefaultValueFloat} (type {@code float}) for floats (floating-point numbers).
* *
* {@code CustomFieldContextDefaultValueLabels} (type {@code labels}) for labels.
* *
* {@code CustomFieldContextDefaultValueTextField} (type {@code textfield}) for text fields.
* *
* {@code CustomFieldContextDefaultValueTextArea} (type {@code textarea}) for text area fields.
* *
* {@code CustomFieldContextDefaultValueReadOnly} (type {@code readonly}) for read only (text) fields.
* *
* {@code CustomFieldContextDefaultValueMultipleVersion} (type {@code version.multiple}) for single choice version pickers.
* *
* {@code CustomFieldContextDefaultValueSingleVersion} (type {@code version.single}) for multiple choice version pickers.
* Forge custom fields [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types) are also supported, returning:
* *
* {@code CustomFieldContextDefaultValueForgeStringFieldBean} (type {@code forge.string}) for Forge string fields.
* *
* {@code CustomFieldContextDefaultValueForgeMultiStringFieldBean} (type {@code forge.string.list}) for Forge string collection fields.
* *
* {@code CustomFieldContextDefaultValueForgeObjectFieldBean} (type {@code forge.object}) for Forge object fields.
* *
* {@code CustomFieldContextDefaultValueForgeDateTimeFieldBean} (type {@code forge.datetime}) for Forge date-time fields.
* *
* {@code CustomFieldContextDefaultValueForgeGroupFieldBean} (type {@code forge.group}) for Forge group fields.
* *
* {@code CustomFieldContextDefaultValueForgeMultiGroupFieldBean} (type {@code forge.group.list}) for Forge group collection fields.
* *
* {@code CustomFieldContextDefaultValueForgeNumberFieldBean} (type {@code forge.number}) for Forge number fields.
* *
* {@code CustomFieldContextDefaultValueForgeUserFieldBean} (type {@code forge.user}) for Forge user fields.
* *
* {@code CustomFieldContextDefaultValueForgeMultiUserFieldBean} (type {@code forge.user.list}) for Forge user collection fields.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field, for example {@code customfield\\_10000}. (required)
* @param contextId The IDs of the contexts. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/field/{fieldId}/context/defaultValue?contextId={contextId}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanCustomFieldContextDefaultValue getDefaultValues(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @Nullable Set contextId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get default workflow
*
* Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme. (required)
* @param returnDraftIfExists Set to {@code true} to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned. (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/workflowscheme/{id}/default?returnDraftIfExists={returnDraftIfExists}")
@Headers({
"Accept: application/json"
})
DefaultWorkflow getDefaultWorkflow(@Param("id") @NotNull Long id, @Param("returnDraftIfExists") @Nullable Boolean returnDraftIfExists);
/**
* Get draft default workflow
*
* Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme that the draft belongs to. (required)
*/
@RequestLine("GET /rest/api/3/workflowscheme/{id}/draft/default")
@Headers({
"Accept: application/json"
})
DefaultWorkflow getDraftDefaultWorkflow(@Param("id") @NotNull Long id);
/**
* Get issue types for workflows in draft workflow scheme
*
* Returns the workflow-issue type mappings for a workflow scheme's draft.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the workflow scheme that the draft belongs to. (required)
* @param workflowName The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. (optional)
*/
@RequestLine("GET /rest/api/3/workflowscheme/{id}/draft/workflow?workflowName={workflowName}")
@Headers({
"Accept: application/json"
})
IssueTypesWorkflowMapping getDraftWorkflow(@Param("id") @NotNull Long id, @Param("workflowName") @Nullable String workflowName);
/**
* Get dynamic webhooks for app
*
* Returns a [paginated](#pagination) list of the webhooks registered by the calling app.
* **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps) and [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps can use this operation.
*
* Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/webhook?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanWebhook getDynamicWebhooksForApp(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get edit issue metadata
*
* 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](#api-rest-api-3-issue-issueIdOrKey-put).
* This endpoint will check for these conditions:
* 1.
* Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. {@code overrideScreenSecurity=true} skips this condition. 2.
* Field is visible in the [field configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/). {@code overrideScreenSecurity=true} skips this condition. 3.
* Field is shown on the issue: each field has different conditions here. For example: Attachment field only shows if attachments are enabled. Assignee only shows if user has permissions to assign the issue. 4.
* If a field is custom then it must have valid custom field context, applicable for its project and issue type. All system fields are assumed to have context in all projects and all issue types. 5.
* Issue has a project, issue type, and status defined. 6.
* Issue is assigned to a valid workflow, and the current status has assigned a workflow step. {@code overrideEditableFlag=true} skips this condition. 7.
* The current workflow step is editable. This is true by default, but [can be disabled by setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) the {@code jira.issue.editable} property to {@code false}. {@code overrideEditableFlag=true} skips this condition. 8.
* User has [Edit issues permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/). 9.
* Workflow permissions allow editing a field. This is true by default but [can be modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) using {@code jira.permission.*} workflow properties.
* Fields hidden using [Issue layout settings page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/) remain editable.
* Connect apps having an app user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), can return additional details using:
* *
* {@code overrideScreenSecurity} When this flag is {@code true}, then this endpoint skips checking if fields are available through screens, and field configuration (conditions 1. and 2. from the list above).
* *
* {@code overrideEditableFlag} When this flag is {@code true}, then this endpoint skips checking if workflow is present and if the current step is editable (conditions 6. and 7. from the list above).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Note: For any fields to be editable the user must have the *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param overrideScreenSecurity Whether hidden fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
* @param overrideEditableFlag Whether non-editable fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/editmeta?overrideScreenSecurity={overrideScreenSecurity}&overrideEditableFlag={overrideEditableFlag}")
@Headers({
"Accept: application/json"
})
IssueUpdateMetadata getEditIssueMeta(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("overrideScreenSecurity") @Nullable Boolean overrideScreenSecurity, @Param("overrideEditableFlag") @Nullable Boolean overrideEditableFlag);
/**
* Get events
*
* Returns all issue events.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/events")
@Headers({
"Accept: application/json"
})
List getEvents();
/**
* Get failed webhooks
*
* Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries.
* After 72 hours the failure may no longer be returned by this operation.
* The oldest failure is returned first.
* This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the {@code failedAfter} value or use the URL provided in {@code next}.
* **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) can use this operation.
*
* Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]
* @param maxResults The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page. (optional)
* @param after The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch. (optional)
*/
@RequestLine("GET /rest/api/3/webhook/failed?maxResults={maxResults}&after={after}")
@Headers({
"Accept: application/json"
})
FailedWebhooks getFailedWebhooks(@Param("maxResults") @Nullable Integer maxResults, @Param("after") @Nullable Long after);
/**
* Get favorite filters
*
* Returns the visible favorite filters of the user.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** A favorite filter is only visible to the user where the filter is:
* *
* owned by the user.
* *
* shared with a group that the user is a member of.
* *
* shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* *
* shared with a public project.
* *
* shared with the public.
* For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
*
* Authentication - Required Scopes: [read:jira-work]
* @param expand Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * {@code sharedUsers} Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify {@code sharedUsers}, then the {@code sharedUsers} object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 users, use {@code ?expand=sharedUsers[1001:2000]}. * {@code subscriptions} Returns the users that are subscribed to the filter. If you don't specify {@code subscriptions}, the {@code subscriptions} object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 subscriptions, use {@code ?expand=subscriptions[1001:2000]}. (optional)
*/
@RequestLine("GET /rest/api/3/filter/favourite?expand={expand}")
@Headers({
"Accept: application/json"
})
List getFavouriteFilters(@Param("expand") @Nullable String expand);
/**
* Get project features
*
* Returns the list of features for a project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The ID or (case-sensitive) key of the project. (required)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/features")
@Headers({
"Accept: application/json"
})
ContainerForProjectFeatures getFeaturesForProject(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Get field auto complete suggestions
*
* Returns the JQL search auto complete suggestions for a field.
* Suggestions can be obtained by providing:
* *
* {@code fieldName} to get a list of all values for the field.
* *
* {@code fieldName} and {@code fieldValue} to get a list of values containing the text in {@code fieldValue}.
* *
* {@code fieldName} and {@code predicateName} to get a list of all predicate values for the field.
* *
* {@code fieldName}, {@code predicateName}, and {@code predicateValue} to get a list of predicate values containing the text in {@code predicateValue}.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param fieldName The name of the field. (optional)
* @param fieldValue The partial field item name entered by the user. (optional)
* @param predicateName The name of the [ CHANGED operator predicate](https://confluence.atlassian.com/x/hQORLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for which the suggestions are generated. The valid predicate operators are *by*, *from*, and *to*. (optional)
* @param predicateValue The partial predicate item name entered by the user. (optional)
*/
@RequestLine("GET /rest/api/3/jql/autocompletedata/suggestions?fieldName={fieldName}&fieldValue={fieldValue}&predicateName={predicateName}&predicateValue={predicateValue}")
@Headers({
"Accept: application/json"
})
AutoCompleteSuggestions getFieldAutoCompleteForQueryString(@Param("fieldName") @Nullable String fieldName, @Param("fieldValue") @Nullable String fieldValue, @Param("predicateName") @Nullable String predicateName, @Param("predicateValue") @Nullable String predicateValue);
/**
* Get field configuration items
*
* Returns a [paginated](#pagination) list of all fields for a configuration.
* Only the fields from configurations used in company-managed (classic) projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the field configuration. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/fieldconfiguration/{id}/fields?startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanFieldConfigurationItem getFieldConfigurationItems(@Param("id") @NotNull Long id, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get field configuration issue type items
*
* Returns a [paginated](#pagination) list of field configuration issue type items.
* Only items used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param fieldConfigurationSchemeId The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: {@code fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001}. (optional)
*/
@RequestLine("GET /rest/api/3/fieldconfigurationscheme/mapping?startAt={startAt}&maxResults={maxResults}&fieldConfigurationSchemeId={fieldConfigurationSchemeId}")
@Headers({
"Accept: application/json"
})
PageBeanFieldConfigurationIssueTypeItem getFieldConfigurationSchemeMappings(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("fieldConfigurationSchemeId") @Nullable Set fieldConfigurationSchemeId);
/**
* Get field configuration schemes for projects
*
* Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it.
* The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.
* Only field configuration schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param projectId The list of project IDs. To include multiple projects, separate IDs with ampersand: {@code projectId=10000&projectId=10001}. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/fieldconfigurationscheme/project?startAt={startAt}&maxResults={maxResults}&projectId={projectId}")
@Headers({
"Accept: application/json"
})
PageBeanFieldConfigurationSchemeProjects getFieldConfigurationSchemeProjectMapping(@Param("projectId") @NotNull Set projectId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get fields
*
* Returns system and custom issue fields according to the following rules:
* *
* Fields that cannot be added to the issue navigator are always returned.
* *
* Fields that cannot be placed on an issue screen are always returned.
* *
* Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
* *
* For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.)
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/field")
@Headers({
"Accept: application/json"
})
List getFields();
/**
* Get fields paginated
*
* Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include:
* *
* all fields
* *
* specific fields, by defining {@code id}
* *
* fields that contain a string in the field name or description, by defining {@code query}
* *
* specific fields that contain a string in the field name or description, by defining {@code id} and {@code query}
* Only custom fields can be queried, {@code type} must be set to {@code custom}.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param type The type of fields to search. (optional)
* @param id The IDs of the custom fields to return or, where {@code query} is specified, filter. (optional)
* @param query String used to perform a case-insensitive partial match with field names or descriptions. (optional)
* @param orderBy [Order](#ordering) the results by a field: * {@code contextsCount} sorts by the number of contexts related to a field * {@code lastUsed} sorts by the date when the value of the field last changed * {@code name} sorts by the field name * {@code screensCount} sorts by the number of screens related to a field (optional)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code key} returns the key for each field * {@code lastUsed} returns the date when the value of the field last changed * {@code screensCount} returns the number of screens related to a field * {@code contextsCount} returns the number of contexts related to a field * {@code isLocked} returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * {@code searcherKey} returns the searcher key for each custom field (optional)
*/
@RequestLine("GET /rest/api/3/field/search?startAt={startAt}&maxResults={maxResults}&type={type}&id={id}&query={query}&orderBy={orderBy}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageBeanField getFieldsPaginated(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("type") @Nullable List type, @Param("id") @Nullable Set id, @Param("query") @Nullable String query, @Param("orderBy") @Nullable String orderBy, @Param("expand") @Nullable String expand);
/**
* Get filter
*
* Returns a filter.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None, however, the filter is only returned where it is:
* *
* owned by the user.
* *
* shared with a group that the user is a member of.
* *
* shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* *
* shared with a public project.
* *
* shared with the public.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the filter to return. (required)
* @param expand Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * {@code sharedUsers} Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify {@code sharedUsers}, then the {@code sharedUsers} object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 users, use {@code ?expand=sharedUsers[1001:2000]}. * {@code subscriptions} Returns the users that are subscribed to the filter. If you don't specify {@code subscriptions}, the {@code subscriptions} object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 subscriptions, use {@code ?expand=subscriptions[1001:2000]}. (optional)
* @param overrideSharePermissions EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/filter/{id}?expand={expand}&overrideSharePermissions={overrideSharePermissions}")
@Headers({
"Accept: application/json"
})
Filter getFilter(@Param("id") @NotNull Long id, @Param("expand") @Nullable String expand, @Param("overrideSharePermissions") @Nullable Boolean overrideSharePermissions);
/**
* Search for filters
*
* Returns a [paginated](#pagination) list of filters. Use this operation to get:
* *
* specific filters, by defining {@code id} only.
* *
* filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None, however, only the following filters that match the query parameters are returned:
* *
* filters owned by the user.
* *
* filters shared with a group that the user is a member of.
* *
* filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* *
* filters shared with a public project.
* *
* filters shared with the public.
*
* Authentication - Required Scopes: [read:jira-work]
* @param filterName String used to perform a case-insensitive partial match with {@code name}. (optional)
* @param accountId User account ID used to return filters with the matching {@code owner.accountId}. This parameter cannot be used with {@code owner}. (optional)
* @param owner This parameter is deprecated because of privacy changes. Use {@code accountId} instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching {@code owner.name}. This parameter cannot be used with {@code accountId}. (optional)
* @param groupname As a group's name can change, use of {@code groupId} is recommended to identify a group. Group name used to returns filters that are shared with a group that matches {@code sharePermissions.group.groupname}. This parameter cannot be used with the {@code groupId} parameter. (optional)
* @param groupId Group ID used to returns filters that are shared with a group that matches {@code sharePermissions.group.groupId}. This parameter cannot be used with the {@code groupname} parameter. (optional)
* @param projectId Project ID used to returns filters that are shared with a project that matches {@code sharePermissions.project.id}. (optional)
* @param id The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, {@code id=10000&id=10001}. Do not exceed 200 filter IDs. (optional)
* @param orderBy [Order](#ordering) the results by a field: * {@code description} Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. * {@code favourite_count} Sorts by the count of how many users have this filter as a favorite. * {@code is_favourite} Sorts by whether the filter is marked as a favorite. * {@code id} Sorts by filter ID. * {@code name} Sorts by filter name. * {@code owner} Sorts by the ID of the filter owner. * {@code is_shared} Sorts by whether the filter is shared. (optional, defaults to name)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param expand Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * {@code description} Returns the description of the filter. * {@code favourite} Returns an indicator of whether the user has set the filter as a favorite. * {@code favouritedCount} Returns a count of how many users have set this filter as a favorite. * {@code jql} Returns the JQL query that the filter uses. * {@code owner} Returns the owner of the filter. * {@code searchUrl} Returns a URL to perform the filter's JQL query. * {@code sharePermissions} Returns the share permissions defined for the filter. * {@code editPermissions} Returns the edit permissions defined for the filter. * {@code isWritable} Returns whether the current user has permission to edit the filter. * {@code subscriptions} Returns the users that are subscribed to the filter. * {@code viewUrl} Returns a URL to view the filter. (optional)
* @param overrideSharePermissions EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/filter/search?filterName={filterName}&accountId={accountId}&owner={owner}&groupname={groupname}&groupId={groupId}&projectId={projectId}&id={id}&orderBy={orderBy}&startAt={startAt}&maxResults={maxResults}&expand={expand}&overrideSharePermissions={overrideSharePermissions}")
@Headers({
"Accept: application/json"
})
PageBeanFilterDetails getFiltersPaginated(@Param("filterName") @Nullable String filterName, @Param("accountId") @Nullable String accountId, @Param("owner") @Nullable String owner, @Param("groupname") @Nullable String groupname, @Param("groupId") @Nullable String groupId, @Param("projectId") @Nullable Long projectId, @Param("id") @Nullable Set id, @Param("orderBy") @Nullable String orderBy, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("expand") @Nullable String expand, @Param("overrideSharePermissions") @Nullable Boolean overrideSharePermissions);
/**
* Get group
*
* This operation is deprecated, use [{@code group/member}](#api-rest-api-3-group-member-get).
* Returns all users in a group.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-user]
* @param groupname As a group's name can change, use of {@code groupId} is recommended to identify a group. The name of the group. This parameter cannot be used with the {@code groupId} parameter. (optional)
* @param groupId The ID of the group. This parameter cannot be used with the {@code groupName} parameter. (optional)
* @param expand List of fields to expand. (optional)
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/group?groupname={groupname}&groupId={groupId}&expand={expand}")
@Headers({
"Accept: application/json"
})
Group getGroup(@Param("groupname") @Nullable String groupname, @Param("groupId") @Nullable String groupId, @Param("expand") @Nullable String expand);
/**
* Get project issue type hierarchy
*
* Get the issue type hierarchy for a next-gen project.
* The issue type hierarchy for a project consists of:
* *
* *Epic* at level 1 (optional).
* *
* One or more issue types at level 0 such as *Story*, *Task*, or *Bug*. Where the issue type *Epic* is defined, these issue types are used to break down the content of an epic.
* *
* *Subtask* at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectId The ID of the project. (required)
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/project/{projectId}/hierarchy")
@Headers({
"Accept: application/json"
})
ProjectIssueTypeHierarchy getHierarchy(@Param("projectId") @NotNull Long projectId);
/**
* Get IDs of deleted worklogs
*
* Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
* This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, {@code until} indicates the timestamp of the youngest item on the page. Also, {@code nextPage} provides the URL for the next page of worklogs. The {@code lastPage} parameter is set to true on the last page of worklogs.
* This resource does not return worklogs deleted during the minute preceding the request.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param since The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned. (optional, defaults to 0)
*/
@RequestLine("GET /rest/api/3/worklog/deleted?since={since}")
@Headers({
"Accept: application/json"
})
ChangedWorklogs getIdsOfWorklogsDeletedSince(@Param("since") @Nullable Long since);
/**
* Get IDs of updated worklogs
*
* Returns a list of IDs and update timestamps for worklogs updated after a date and time.
* This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, {@code until} indicates the timestamp of the youngest item on the page. Also, {@code nextPage} provides the URL for the next page of worklogs. The {@code lastPage} parameter is set to true on the last page of worklogs.
* This resource does not return worklogs updated during the minute preceding the request.
* **[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:
* *
* the worklog is set as *Viewable by All Users*.
* *
* the user is a member of a project role or group with permission to view the worklog.
*
* Authentication - Required Scopes: [read:jira-work]
* @param since The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned. (optional, defaults to 0)
* @param expand Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts {@code properties} that returns the properties of each worklog. (optional)
*/
@RequestLine("GET /rest/api/3/worklog/updated?since={since}&expand={expand}")
@Headers({
"Accept: application/json"
})
ChangedWorklogs getIdsOfWorklogsModifiedSince(@Param("since") @Nullable Long since, @Param("expand") @Nullable String expand);
/**
* Get is watching issue bulk
*
* Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned watched status is {@code false}.
* This operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueList A list of issue IDs. (required)
*/
@RequestLine("POST /rest/api/3/issue/watching")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
BulkIssueIsWatching getIsWatchingIssueBulk(@NotNull IssueList issueList);
/**
* Get issue
*
* Returns the details for an issue.
* The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is **not** returned. The issue key returned in the response is the key of the issue found.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param fields A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * {@code *all} Returns all fields. * {@code *navigable} Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * {@code summary,comment} Returns only the summary and comments fields. * {@code -description} Returns all (default) fields except description. * {@code *navigable,-comment} Returns all navigable fields except comment. This parameter may be specified multiple times. For example, {@code fields=field1,field2& fields=field3}. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields. (optional)
* @param fieldsByKeys Whether fields in {@code fields} are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID. (optional, defaults to false)
* @param expand Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * {@code renderedFields} Returns field values rendered in HTML format. * {@code names} Returns the display name of each field. * {@code schema} Returns the schema describing a field type. * {@code transitions} Returns all possible transitions for the issue. * {@code editmeta} Returns information about how each field can be edited. * {@code changelog} Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * {@code versionedRepresentations} Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the {@code fields} parameter is ignored. (optional)
* @param properties A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * {@code *all} Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * {@code *all} Returns all properties. * {@code *all,-prop1} Returns all properties except {@code prop1}. * {@code prop1,prop2} Returns {@code prop1} and {@code prop2} properties. This parameter may be specified multiple times. For example, {@code properties=prop1,prop2& properties=prop3}. (optional)
* @param updateHistory Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-3-search-get) {@code lastViewed} field. (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}?fields={fields}&fieldsByKeys={fieldsByKeys}&expand={expand}&properties={properties}&updateHistory={updateHistory}")
@Headers({
"Accept: application/json"
})
IssueBean getIssue(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("fields") @Nullable List fields, @Param("fieldsByKeys") @Nullable Boolean fieldsByKeys, @Param("expand") @Nullable String expand, @Param("properties") @Nullable List properties, @Param("updateHistory") @Nullable Boolean updateHistory);
/**
* Get all issue types for user
*
* Returns all issue types.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Issue types are only returned as follows:
* *
* if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned.
* *
* if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/issuetype")
@Headers({
"Accept: application/json"
})
List getIssueAllTypes();
/**
* Get issue field option
*
* Returns an option from a select list issue field.
* Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldKey The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the {@code fieldKey} value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the {@code jiraIssueFields} module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in {@code key}. For example, {@code "key": "teams-add-on__team-issue-field"} (required)
* @param optionId The ID of the option to be returned. (required)
*/
@RequestLine("GET /rest/api/3/field/{fieldKey}/option/{optionId}")
@Headers({
"Accept: application/json"
})
IssueFieldOption getIssueFieldOption(@Param("fieldKey") @NotNull String fieldKey, @Param("optionId") @NotNull Long optionId);
/**
* Get issue link
*
* Returns an issue link.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the linked issues.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.
*
* Authentication - Required Scopes: [read:jira-work]
* @param linkId The ID of the issue link. (required)
*/
@RequestLine("GET /rest/api/3/issueLink/{linkId}")
@Headers({
"Accept: application/json"
})
IssueLink getIssueLink(@Param("linkId") @NotNull String linkId);
/**
* Get issue link type
*
* Returns an issue link type.
* To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueLinkTypeId The ID of the issue link type. (required)
*/
@RequestLine("GET /rest/api/3/issueLinkType/{issueLinkTypeId}")
@Headers({
"Accept: application/json"
})
IssueLinkType getIssueLinkType(@Param("issueLinkTypeId") @NotNull String issueLinkTypeId);
/**
* Get issue link types
*
* Returns a list of all issue link types.
* To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.
*
* Authentication - Required Scopes: [read:jira-work]
*/
@RequestLine("GET /rest/api/3/issueLinkType")
@Headers({
"Accept: application/json"
})
IssueLinkTypes getIssueLinkTypes();
/**
* Get issue navigator default columns
*
* Returns the default issue navigator columns.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
*/
@RequestLine("GET /rest/api/3/settings/columns")
@Headers({
"Accept: application/json"
})
List getIssueNavigatorDefaultColumns();
/**
* Get issue picker suggestions
*
* Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.
* This operation returns two lists:
* *
* {@code History Search} which includes issues from the user's history of created, edited, or viewed issues that contain the string in the {@code query} parameter.
* *
* {@code Current Search} which includes issues that match the JQL expression in {@code currentJQL} and contain the string in the {@code query} parameter.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param query A string to match against text fields in the issue such as title, description, or comments. (optional)
* @param currentJQL A JQL query defining a list of issues to search for the query term. Note that {@code username} and {@code userkey} cannot be used as search terms for this parameter, due to privacy reasons. Use {@code accountId} instead. (optional)
* @param currentIssueKey The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query. (optional)
* @param currentProjectId The ID of a project that suggested issues must belong to. (optional)
* @param showSubTasks Indicate whether to include subtasks in the suggestions list. (optional)
* @param showSubTaskParent When {@code currentIssueKey} is a subtask, whether to include the parent issue in the suggestions if it matches the query. (optional)
*/
@RequestLine("GET /rest/api/3/issue/picker?query={query}¤tJQL={currentJQL}¤tIssueKey={currentIssueKey}¤tProjectId={currentProjectId}&showSubTasks={showSubTasks}&showSubTaskParent={showSubTaskParent}")
@Headers({
"Accept: application/json"
})
IssuePickerSuggestions getIssuePickerResource(@Param("query") @Nullable String query, @Param("currentJQL") @Nullable String currentJQL, @Param("currentIssueKey") @Nullable String currentIssueKey, @Param("currentProjectId") @Nullable String currentProjectId, @Param("showSubTasks") @Nullable Boolean showSubTasks, @Param("showSubTaskParent") @Nullable Boolean showSubTaskParent);
/**
* Get issue property
*
* Returns the key and value of an issue's property.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The key or ID of the issue. (required)
* @param propertyKey The key of the property. (required)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
EntityProperty getIssueProperty(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("propertyKey") @NotNull String propertyKey);
/**
* Get issue property keys
*
* Returns the URLs and keys of an issue's properties.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Property details are only returned where the user has:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The key or ID of the issue. (required)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/properties")
@Headers({
"Accept: application/json"
})
PropertyKeys getIssuePropertyKeys(@Param("issueIdOrKey") @NotNull String issueIdOrKey);
/**
* Get issue security level
*
* Returns details of an issue security level.
* Use [Get issue security scheme](#api-rest-api-3-issuesecurityschemes-id-get) to obtain the IDs of issue security levels associated with the issue security scheme.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the issue security level. (required)
*/
@RequestLine("GET /rest/api/3/securitylevel/{id}")
@Headers({
"Accept: application/json"
})
SecurityLevel getIssueSecurityLevel(@Param("id") @NotNull String id);
/**
* Get issue security level members
*
* Returns issue security level members.
* Only issue security level members in context of classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueSecuritySchemeId The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param issueSecurityLevelId The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: {@code issueSecurityLevelId=10000&issueSecurityLevelId=10001}. (optional)
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("GET /rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members?startAt={startAt}&maxResults={maxResults}&issueSecurityLevelId={issueSecurityLevelId}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageBeanIssueSecurityLevelMember getIssueSecurityLevelMembers(@Param("issueSecuritySchemeId") @NotNull Long issueSecuritySchemeId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("issueSecurityLevelId") @Nullable Set issueSecurityLevelId, @Param("expand") @Nullable String expand);
/**
* Get issue security scheme
*
* Returns an issue security scheme along with its security levels.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* *
* *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project that uses the requested issue security scheme.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param id The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. (required)
*/
@RequestLine("GET /rest/api/3/issuesecurityschemes/{id}")
@Headers({
"Accept: application/json"
})
SecurityScheme getIssueSecurityScheme(@Param("id") @NotNull Long id);
/**
* Get issue security schemes
*
* Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg).
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-project]
*/
@RequestLine("GET /rest/api/3/issuesecurityschemes")
@Headers({
"Accept: application/json"
})
SecuritySchemes getIssueSecuritySchemes();
/**
* Get issue type
*
* Returns an issue type.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue type is associated with or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the issue type. (required)
*/
@RequestLine("GET /rest/api/3/issuetype/{id}")
@Headers({
"Accept: application/json"
})
IssueTypeDetails getIssueType(@Param("id") @NotNull String id);
/**
* Get issue types for custom field context
*
* Returns a [paginated](#pagination) list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, {@code contextId=10001&contextId=10002}. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/field/{fieldId}/context/issuetypemapping?contextId={contextId}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeToContextMapping getIssueTypeMappingsForContexts(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @Nullable List contextId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get issue type property
*
* Returns the key and value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the details of any issue type.
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the details of any issue types associated with the projects the user has permission to browse.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueTypeId The ID of the issue type. (required)
* @param propertyKey The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys. (required)
*/
@RequestLine("GET /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
EntityProperty getIssueTypeProperty(@Param("issueTypeId") @NotNull String issueTypeId, @Param("propertyKey") @NotNull String propertyKey);
/**
* Get issue type property keys
*
* Returns all the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys of the issue type.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the property keys of any issue type.
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the property keys of any issue types associated with the projects the user has permission to browse.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueTypeId The ID of the issue type. (required)
*/
@RequestLine("GET /rest/api/3/issuetype/{issueTypeId}/properties")
@Headers({
"Accept: application/json"
})
PropertyKeys getIssueTypePropertyKeys(@Param("issueTypeId") @NotNull String issueTypeId);
/**
* Get issue type schemes for projects
*
* Returns a [paginated](#pagination) list of issue type schemes and, for each issue type scheme, a list of the projects that use it.
* Only issue type schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param projectId The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, {@code projectId=10000&projectId=10001}. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/issuetypescheme/project?startAt={startAt}&maxResults={maxResults}&projectId={projectId}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeSchemeProjects getIssueTypeSchemeForProjects(@Param("projectId") @NotNull Set projectId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get issue type scheme items
*
* Returns a [paginated](#pagination) list of issue type scheme items.
* Only issue type scheme items used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param issueTypeSchemeId The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, {@code issueTypeSchemeId=10000&issueTypeSchemeId=10001}. (optional)
*/
@RequestLine("GET /rest/api/3/issuetypescheme/mapping?startAt={startAt}&maxResults={maxResults}&issueTypeSchemeId={issueTypeSchemeId}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeSchemeMapping getIssueTypeSchemesMapping(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("issueTypeSchemeId") @Nullable Set issueTypeSchemeId);
/**
* Get issue type screen scheme items
*
* Returns a [paginated](#pagination) list of issue type screen scheme items.
* Only issue type screen schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param issueTypeScreenSchemeId The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: {@code issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001}. (optional)
*/
@RequestLine("GET /rest/api/3/issuetypescreenscheme/mapping?startAt={startAt}&maxResults={maxResults}&issueTypeScreenSchemeId={issueTypeScreenSchemeId}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeScreenSchemeItem getIssueTypeScreenSchemeMappings(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("issueTypeScreenSchemeId") @Nullable Set issueTypeScreenSchemeId);
/**
* Get issue type screen schemes for projects
*
* Returns a [paginated](#pagination) list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.
* Only issue type screen schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param projectId The list of project IDs. To include multiple projects, separate IDs with ampersand: {@code projectId=10000&projectId=10001}. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/issuetypescreenscheme/project?startAt={startAt}&maxResults={maxResults}&projectId={projectId}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeScreenSchemesProjects getIssueTypeScreenSchemeProjectAssociations(@Param("projectId") @NotNull Set projectId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get issue type screen schemes
*
* Returns a [paginated](#pagination) list of issue type screen schemes.
* Only issue type screen schemes used in classic projects are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param id The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, {@code id=10000&id=10001}. (optional)
* @param queryString String used to perform a case-insensitive partial match with issue type screen scheme name. (optional)
* @param orderBy [Order](#ordering) the results by a field: * {@code name} Sorts by issue type screen scheme name. * {@code id} Sorts by issue type screen scheme ID. (optional, defaults to id)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts {@code projects} that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to. (optional)
*/
@RequestLine("GET /rest/api/3/issuetypescreenscheme?startAt={startAt}&maxResults={maxResults}&id={id}&queryString={queryString}&orderBy={orderBy}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageBeanIssueTypeScreenScheme getIssueTypeScreenSchemes(@Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("id") @Nullable Set id, @Param("queryString") @Nullable String queryString, @Param("orderBy") @Nullable String orderBy, @Param("expand") @Nullable String expand);
/**
* Get issue types for project
*
* Returns issue types for a project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectId The ID of the project. (required)
* @param level The level of the issue type to filter by. Use: * {@code -1} for Subtask. * {@code 0} for Base. * {@code 1} for Epic. (optional)
*/
@RequestLine("GET /rest/api/3/issuetype/project?projectId={projectId}&level={level}")
@Headers({
"Accept: application/json"
})
List getIssueTypesForProject(@Param("projectId") @NotNull Long projectId, @Param("level") @Nullable Integer level);
/**
* Get issue watchers
*
* Returns the watchers for an issue.
* This operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:**
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* To see details of users on the watchlist other than themselves, *View voters and watchers* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/watchers")
@Headers({
"Accept: application/json"
})
Watchers getIssueWatchers(@Param("issueIdOrKey") @NotNull String issueIdOrKey);
/**
* Get issue worklogs
*
* Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.
* Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Workloads are only returned where the user has:
* *
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* *
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
*
* Authentication - Required Scopes: [read:jira-work]
* @param issueIdOrKey The ID or key of the issue. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 5000)
* @param startedAfter The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned. (optional)
* @param startedBefore The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned. (optional)
* @param expand Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts{@code properties}, which returns worklog properties. (optional)
*/
@RequestLine("GET /rest/api/3/issue/{issueIdOrKey}/worklog?startAt={startAt}&maxResults={maxResults}&startedAfter={startedAfter}&startedBefore={startedBefore}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageOfWorklogs getIssueWorklog(@Param("issueIdOrKey") @NotNull String issueIdOrKey, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("startedAfter") @Nullable Long startedAfter, @Param("startedBefore") @Nullable Long startedBefore, @Param("expand") @Nullable String expand);
/**
* Get license
*
* Returns licensing information about the Jira instance.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/instance/license")
@Headers({
"Accept: application/json"
})
License getLicense();
/**
* Get locale
*
* Returns the locale for the user.
* If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the *Accept-Language* header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [manage:jira-configuration]
*/
@RequestLine("GET /rest/api/3/mypreferences/locale")
@Headers({
"Accept: application/json"
})
Locale getLocale();
/**
* Get my filters
*
* Returns the filters owned by the user. If {@code includeFavourites} is {@code true}, the user's visible favorite filters are also returned.
* **[Permissions](#permissions) required:** Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:
* *
* owned by the user.
* *
* shared with a group that the user is a member of.
* *
* shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.
* *
* shared with a public project.
* *
* shared with the public.
* For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
*
* Authentication - Required Scopes: [read:jira-work]
* @param expand Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * {@code sharedUsers} Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify {@code sharedUsers}, then the {@code sharedUsers} object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 users, use {@code ?expand=sharedUsers[1001:2000]}. * {@code subscriptions} Returns the users that are subscribed to the filter. If you don't specify {@code subscriptions}, the {@code subscriptions} object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append {@code [start-index:end-index]} to the expand request. For example, to access the next 1000 subscriptions, use {@code ?expand=subscriptions[1001:2000]}. (optional)
* @param includeFavourites Include the user's favorite filters in the response. (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/filter/my?expand={expand}&includeFavourites={includeFavourites}")
@Headers({
"Accept: application/json"
})
List getMyFilters(@Param("expand") @Nullable String expand, @Param("includeFavourites") @Nullable Boolean includeFavourites);
/**
* Get my permissions
*
* Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.
* The user is reported as having a project permission:
* *
* in the global context, if the user has the project permission in any project.
* *
* for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
* *
* for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.
* *
* for a comment, where the user has both the permission to browse the comment and the project permission for the comment's parent issue. Only the BROWSE\\_PROJECTS permission is supported. If a {@code commentId} is provided whose {@code permissions} does not equal BROWSE\\_PROJECTS, a 400 error will be returned.
* This means that users may be shown as having an issue permission (such as EDIT\\_ISSUES) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT\\_ISSUES permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT\\_ISSUES permission for that issue.
* Global permissions are unaffected by context.
* **Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024.
* *
* **Classic**: {@code read:jira-work}
* *
* **Granular**: {@code read:permission:jira}
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* @param projectKey The key of project. Ignored if {@code projectId} is provided. (optional)
* @param projectId The ID of project. (optional)
* @param issueKey The key of the issue. Ignored if {@code issueId} is provided. (optional)
* @param issueId The ID of the issue. (optional)
* @param permissions A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use [Get all permissions](#api-rest-api-3-permissions-get). (optional)
* @param projectUuid (optional)
* @param projectConfigurationUuid (optional)
* @param commentId The ID of the comment. (optional)
*/
@RequestLine("GET /rest/api/3/mypermissions?projectKey={projectKey}&projectId={projectId}&issueKey={issueKey}&issueId={issueId}&permissions={permissions}&projectUuid={projectUuid}&projectConfigurationUuid={projectConfigurationUuid}&commentId={commentId}")
@Headers({
"Accept: application/json"
})
Permissions getMyPermissions(@Param("projectKey") @Nullable String projectKey, @Param("projectId") @Nullable String projectId, @Param("issueKey") @Nullable String issueKey, @Param("issueId") @Nullable String issueId, @Param("permissions") @Nullable String permissions, @Param("projectUuid") @Nullable String projectUuid, @Param("projectConfigurationUuid") @Nullable String projectConfigurationUuid, @Param("commentId") @Nullable String commentId);
/**
* Get notification scheme
*
* Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.
* **[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) to get a list of notification scheme IDs. (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code all} Returns all expandable information * {@code field} Returns information about any custom fields assigned to receive an event * {@code group} Returns information about any groups assigned to receive an event * {@code notificationSchemeEvents} Returns a list of event associations. This list is returned for all expandable information * {@code projectRole} Returns information about any project roles assigned to receive an event * {@code user} Returns information about any users assigned to receive an event (optional)
*/
@RequestLine("GET /rest/api/3/notificationscheme/{id}?expand={expand}")
@Headers({
"Accept: application/json"
})
NotificationScheme getNotificationScheme(@Param("id") @NotNull Long id, @Param("expand") @Nullable String expand);
/**
* Get project notification scheme
*
* Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectKeyOrId The project ID or project key (case sensitive). (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code all} Returns all expandable information * {@code field} Returns information about any custom fields assigned to receive an event * {@code group} Returns information about any groups assigned to receive an event * {@code notificationSchemeEvents} Returns a list of event associations. This list is returned for all expandable information * {@code projectRole} Returns information about any project roles assigned to receive an event * {@code user} Returns information about any users assigned to receive an event (optional)
*/
@RequestLine("GET /rest/api/3/project/{projectKeyOrId}/notificationscheme?expand={expand}")
@Headers({
"Accept: application/json"
})
NotificationScheme getNotificationSchemeForProject(@Param("projectKeyOrId") @NotNull String projectKeyOrId, @Param("expand") @Nullable String expand);
/**
* Get projects using notification schemes paginated
*
* Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param notificationSchemeId The list of notifications scheme IDs to be filtered out (optional)
* @param projectId The list of project IDs to be filtered out (optional)
*/
@RequestLine("GET /rest/api/3/notificationscheme/project?startAt={startAt}&maxResults={maxResults}¬ificationSchemeId={notificationSchemeId}&projectId={projectId}")
@Headers({
"Accept: application/json"
})
PageBeanNotificationSchemeAndProjectMappingJsonBean getNotificationSchemeToProjectMappings(@Param("startAt") @Nullable String startAt, @Param("maxResults") @Nullable String maxResults, @Param("notificationSchemeId") @Nullable Set notificationSchemeId, @Param("projectId") @Nullable Set projectId);
/**
* Get notification schemes paginated
*
* Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.
* *Note that you should allow for events without recipients to appear in responses.*
* **[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param id The list of notification schemes IDs to be filtered by (optional)
* @param projectId The list of projects IDs to be filtered by (optional)
* @param onlyDefault When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false. (optional, defaults to false)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code all} Returns all expandable information * {@code field} Returns information about any custom fields assigned to receive an event * {@code group} Returns information about any groups assigned to receive an event * {@code notificationSchemeEvents} Returns a list of event associations. This list is returned for all expandable information * {@code projectRole} Returns information about any project roles assigned to receive an event * {@code user} Returns information about any users assigned to receive an event (optional)
*/
@RequestLine("GET /rest/api/3/notificationscheme?startAt={startAt}&maxResults={maxResults}&id={id}&projectId={projectId}&onlyDefault={onlyDefault}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageBeanNotificationScheme getNotificationSchemes(@Param("startAt") @Nullable String startAt, @Param("maxResults") @Nullable String maxResults, @Param("id") @Nullable Set id, @Param("projectId") @Nullable Set projectId, @Param("onlyDefault") @Nullable Boolean onlyDefault, @Param("expand") @Nullable String expand);
/**
* Get custom field options (context)
*
* Returns a [paginated](#pagination) list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira.
* This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field. (required)
* @param contextId The ID of the context. (required)
* @param optionId The ID of the option. (optional)
* @param onlyOptions Whether only options are returned. (optional, defaults to false)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 100)
*/
@RequestLine("GET /rest/api/3/field/{fieldId}/context/{contextId}/option?optionId={optionId}&onlyOptions={onlyOptions}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanCustomFieldContextOption getOptionsForContext(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @NotNull Long contextId, @Param("optionId") @Nullable Long optionId, @Param("onlyOptions") @Nullable Boolean onlyOptions, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get permission scheme
*
* Returns a permission scheme.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param schemeId The ID of the permission scheme to return. (required)
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code permissions} Returns all permission grants for each permission scheme. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("GET /rest/api/3/permissionscheme/{schemeId}?expand={expand}")
@Headers({
"Accept: application/json"
})
PermissionScheme getPermissionScheme(@Param("schemeId") @NotNull Long schemeId, @Param("expand") @Nullable String expand);
/**
* Get permission scheme grant
*
* Returns a permission grant.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param schemeId The ID of the permission scheme. (required)
* @param permissionId The ID of the permission grant. (required)
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * {@code all} Returns all expandable information. * {@code field} Returns information about the custom field granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code permissions} Returns all permission grants for each permission scheme. * {@code projectRole} Returns information about the project role granted the permission. * {@code user} Returns information about the user who is granted the permission. (optional)
*/
@RequestLine("GET /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}?expand={expand}")
@Headers({
"Accept: application/json"
})
PermissionGrant getPermissionSchemeGrant(@Param("schemeId") @NotNull Long schemeId, @Param("permissionId") @NotNull Long permissionId, @Param("expand") @Nullable String expand);
/**
* Get permission scheme grants
*
* Returns all permission grants for a permission scheme.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param schemeId The ID of the permission scheme. (required)
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * {@code permissions} Returns all permission grants for each permission scheme. * {@code user} Returns information about the user who is granted the permission. * {@code group} Returns information about the group that is granted the permission. * {@code projectRole} Returns information about the project role granted the permission. * {@code field} Returns information about the custom field granted the permission. * {@code all} Returns all expandable information. (optional)
*/
@RequestLine("GET /rest/api/3/permissionscheme/{schemeId}/permission?expand={expand}")
@Headers({
"Accept: application/json"
})
PermissionGrants getPermissionSchemeGrants(@Param("schemeId") @NotNull Long schemeId, @Param("expand") @Nullable String expand);
/**
* Get permitted projects
*
* Returns all the projects where the user is granted a list of project permissions.
* **Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024.
* *
* **Classic**: {@code read:jira-work}
* *
* **Granular**: {@code read:permission:jira}, {@code read:project:jira}
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* @param permissionsKeysBean (required)
*/
@RequestLine("POST /rest/api/3/permissions/project")
@Headers({
"Content-Type: application/json",
"Accept: application/json"
})
PermittedProjects getPermittedProjects(@NotNull PermissionsKeysBean permissionsKeysBean);
/**
* Get precomputations (apps)
*
* Returns the list of a function's precomputations along with information about when they were created, updated, and last used. Each precomputation has a {@code value} \\- the JQL fragment to replace the custom function clause with.
* **[Permissions](#permissions) required:** This API is only accessible to apps and apps can only inspect their own functions.
*
* @param functionKey The function key in format: * Forge: {@code ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest]} * Connect: {@code [App key]__[Module key]} (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 100)
* @param orderBy [Order](#ordering) the results by a field: * {@code functionKey} Sorts by the functionKey. * {@code used} Sorts by the used timestamp. * {@code created} Sorts by the created timestamp. * {@code updated} Sorts by the updated timestamp. (optional)
*/
@RequestLine("GET /rest/api/3/jql/function/computation?functionKey={functionKey}&startAt={startAt}&maxResults={maxResults}&orderBy={orderBy}")
@Headers({
"Accept: application/json"
})
PageBeanJqlFunctionPrecomputationBean getPrecomputations(@Param("functionKey") @Nullable List functionKey, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("orderBy") @Nullable String orderBy);
/**
* Get preference
*
* Returns the value of a preference of the current user.
* Note that these keys are deprecated:
* *
* *jira.user.locale* The locale of the user. By default this is not set and the user takes the locale of the instance.
* *
* *jira.user.timezone* The time zone of the user. By default this is not set and the user takes the timezone of the instance.
* These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not have any impact on Notification behaviour.
* *
* *user.notifiy.own.changes* Whether the user gets notified of their own changes.
* *
* *user.notifications.watcher* Whether the user gets notified when they are watcher.
* *
* *user.notifications.assignee* Whether the user gets notified when they are assignee.
* *
* *user.notifications.reporter* Whether the user gets notified when they are reporter.
* *
* *user.notifications.mentions* Whether the user gets notified when they are mentions.
* Use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param key The key of the preference. (required)
*/
@RequestLine("GET /rest/api/3/mypreferences?key={key}")
@Headers({
"Accept: application/json"
})
String getPreference(@Param("key") @NotNull String key);
/**
* Get priorities
*
* Returns the list of all issue priorities.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @deprecated
*/
@Deprecated
@RequestLine("GET /rest/api/3/priority")
@Headers({
"Accept: application/json"
})
List getPriorities();
/**
* Get priority
*
* Returns an issue priority.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the issue priority. (required)
*/
@RequestLine("GET /rest/api/3/priority/{id}")
@Headers({
"Accept: application/json"
})
Priority getPriority(@Param("id") @NotNull String id);
/**
* Get project
*
* Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: * {@code description} The project description. * {@code issueTypes} The issue types associated with the project. * {@code lead} The project lead. * {@code projectKeys} All project keys associated with the project. * {@code issueTypeHierarchy} The project issue type hierarchy. (optional)
* @param properties A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}?expand={expand}&properties={properties}")
@Headers({
"Accept: application/json"
})
Project getProject(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("expand") @Nullable String expand, @Param("properties") @Nullable List properties);
/**
* Get project category by ID
*
* Returns a project category.
* **[Permissions](#permissions) required:** Permission to access Jira.
*
* Authentication - Required Scopes: [read:jira-work]
* @param id The ID of the project category. (required)
*/
@RequestLine("GET /rest/api/3/projectCategory/{id}")
@Headers({
"Accept: application/json"
})
ProjectCategory getProjectCategoryById(@Param("id") @NotNull Long id);
/**
* Get project components
*
* Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination.
* If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param componentSource The source of the components to return. Can be {@code jira} (default), {@code compass} or {@code auto}. When {@code auto} is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to {@code jira}. (optional, defaults to jira)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/components?componentSource={componentSource}")
@Headers({
"Accept: application/json"
})
List getProjectComponents(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("componentSource") @Nullable String componentSource);
/**
* Get project components paginated
*
* Returns a [paginated](#pagination) list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination.
* If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param orderBy [Order](#ordering) the results by a field: * {@code description} Sorts by the component description. * {@code issueCount} Sorts by the count of issues associated with the component. * {@code lead} Sorts by the user key of the component's project lead. * {@code name} Sorts by component name. (optional)
* @param componentSource The source of the components to return. Can be {@code jira} (default), {@code compass} or {@code auto}. When {@code auto} is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to {@code jira}. (optional, defaults to jira)
* @param query Filter the results using a literal string. Components with a matching {@code name} or {@code description} are returned (case insensitive). (optional)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/component?startAt={startAt}&maxResults={maxResults}&orderBy={orderBy}&componentSource={componentSource}&query={query}")
@Headers({
"Accept: application/json"
})
PageBeanComponentWithIssueCount getProjectComponentsPaginated(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("orderBy") @Nullable String orderBy, @Param("componentSource") @Nullable String componentSource, @Param("query") @Nullable String query);
/**
* Get project mappings for custom field context
*
* Returns a [paginated](#pagination) list of context to project mappings for a custom field. The result can be filtered by {@code contextId}. Otherwise, all mappings are returned. Invalid IDs are ignored.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param fieldId The ID of the custom field, for example {@code customfield\\_10000}. (required)
* @param contextId The list of context IDs. To include multiple context, separate IDs with ampersand: {@code contextId=10000&contextId=10001}. (optional)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
*/
@RequestLine("GET /rest/api/3/field/{fieldId}/context/projectmapping?contextId={contextId}&startAt={startAt}&maxResults={maxResults}")
@Headers({
"Accept: application/json"
})
PageBeanCustomFieldContextProjectMapping getProjectContextMapping(@Param("fieldId") @NotNull String fieldId, @Param("contextId") @Nullable Set contextId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults);
/**
* Get project's sender email
*
* Returns the [project's sender email address](https://confluence.atlassian.com/x/dolKLg).
* **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [manage:jira-project]
* @param projectId The project ID. (required)
*/
@RequestLine("GET /rest/api/3/project/{projectId}/email")
@Headers({
"Accept: application/json"
})
ProjectEmailAddress getProjectEmail(@Param("projectId") @NotNull Long projectId);
/**
* Get project issue security scheme
*
* Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or the *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectKeyOrId The project ID or project key (case sensitive). (required)
*/
@RequestLine("GET /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme")
@Headers({
"Accept: application/json"
})
SecurityScheme getProjectIssueSecurityScheme(@Param("projectKeyOrId") @NotNull String projectKeyOrId);
/**
* Get project property
*
* Returns the value of a [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param propertyKey The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. (required)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}")
@Headers({
"Accept: application/json"
})
EntityProperty getProjectProperty(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("propertyKey") @NotNull String propertyKey);
/**
* Get project property keys
*
* Returns all [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys for the project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/properties")
@Headers({
"Accept: application/json"
})
PropertyKeys getProjectPropertyKeys(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Get project role for project
*
* Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.
* To check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-3-user-get) with the {@code groups} expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
* @param excludeInactiveUsers Exclude inactive users. (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/role/{id}?excludeInactiveUsers={excludeInactiveUsers}")
@Headers({
"Accept: application/json"
})
ProjectRole getProjectRole(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("id") @NotNull Long id, @Param("excludeInactiveUsers") @Nullable Boolean excludeInactiveUsers);
/**
* Get default actors for project role
*
* Returns the [default actors](#api-rest-api-3-resolution-get) for the project role.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
*/
@RequestLine("GET /rest/api/3/role/{id}/actors")
@Headers({
"Accept: application/json"
})
ProjectRole getProjectRoleActorsForRole(@Param("id") @NotNull Long id);
/**
* Get project role by ID
*
* Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param id The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
*/
@RequestLine("GET /rest/api/3/role/{id}")
@Headers({
"Accept: application/json"
})
ProjectRole getProjectRoleById(@Param("id") @NotNull Long id);
/**
* Get project role details
*
* Returns all [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) and the details for each role. Note that the list of project roles is common to all projects.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param currentMember Whether the roles should be filtered to include only those the user is assigned to. (optional, defaults to false)
* @param excludeConnectAddons (optional, defaults to false)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/roledetails?currentMember={currentMember}&excludeConnectAddons={excludeConnectAddons}")
@Headers({
"Accept: application/json"
})
List getProjectRoleDetails(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("currentMember") @Nullable Boolean currentMember, @Param("excludeConnectAddons") @Nullable Boolean excludeConnectAddons);
/**
* Get project roles for project
*
* Returns a list of [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) for the project returning the name and self URL for each role.
* Note that all project roles are shared with all projects in Jira Cloud. See [Get all project roles](#api-rest-api-3-role-get) for more information.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for any project on the site or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/role")
@Headers({
"Accept: application/json"
})
Map getProjectRoles(@Param("projectIdOrKey") @NotNull String projectIdOrKey);
/**
* Get project type by key
*
* Returns a [project type](https://confluence.atlassian.com/x/Var1Nw).
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** None.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectTypeKey The key of the project type. (required)
*/
@RequestLine("GET /rest/api/3/project/type/{projectTypeKey}")
@Headers({
"Accept: application/json"
})
ProjectType getProjectTypeByKey(@Param("projectTypeKey") @NotNull String projectTypeKey);
/**
* Get project versions
*
* Returns all versions in a project. The response is not paginated. Use [Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) if you want to get the versions in a project with pagination.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts {@code operations}, which returns actions that can be performed on the version. (optional)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/versions?expand={expand}")
@Headers({
"Accept: application/json"
})
List getProjectVersions(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("expand") @Nullable String expand);
/**
* Get project versions paginated
*
* Returns a [paginated](#pagination) list of all versions in a project. See the [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get) resource if you want to get a full list of versions without pagination.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
*
* Authentication - Required Scopes: [read:jira-work]
* @param projectIdOrKey The project ID or project key (case sensitive). (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param orderBy [Order](#ordering) the results by a field: * {@code description} Sorts by version description. * {@code name} Sorts by version name. * {@code releaseDate} Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * {@code sequence} Sorts by the order of appearance in the user interface. * {@code startDate} Sorts by start date, starting with the oldest date. Versions with no start date are listed last. (optional)
* @param query Filter the results using a literal string. Versions with matching {@code name} or {@code description} are returned (case insensitive). (optional)
* @param status A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are {@code released}, {@code unreleased}, and {@code archived}. (optional)
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code issuesstatus} Returns the number of issues in each status category for each version. * {@code operations} Returns actions that can be performed on the specified version. * {@code driver} Returns the Atlassian account ID of the version driver. * {@code approvers} Returns a list containing the approvers for this version. (optional)
*/
@RequestLine("GET /rest/api/3/project/{projectIdOrKey}/version?startAt={startAt}&maxResults={maxResults}&orderBy={orderBy}&query={query}&status={status}&expand={expand}")
@Headers({
"Accept: application/json"
})
PageBeanVersion getProjectVersionsPaginated(@Param("projectIdOrKey") @NotNull String projectIdOrKey, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("orderBy") @Nullable String orderBy, @Param("query") @Nullable String query, @Param("status") @Nullable String status, @Param("expand") @Nullable String expand);
/**
* Get issue type screen scheme projects
*
* Returns a [paginated](#pagination) list of projects associated with an issue type screen scheme.
* Only company-managed projects associated with an issue type screen scheme are returned.
* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [manage:jira-configuration]
* @param issueTypeScreenSchemeId The ID of the issue type screen scheme. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
* @param maxResults The maximum number of items to return per page. (optional, defaults to 50)
* @param query (optional)
*/
@RequestLine("GET /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project?startAt={startAt}&maxResults={maxResults}&query={query}")
@Headers({
"Accept: application/json"
})
PageBeanProjectDetails getProjectsForIssueTypeScreenScheme(@Param("issueTypeScreenSchemeId") @NotNull Long issueTypeScreenSchemeId, @Param("startAt") @Nullable Long startAt, @Param("maxResults") @Nullable Integer maxResults, @Param("query") @Nullable String query);
/**
* Get recent projects
*
* Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.
* This operation can be accessed anonymously.
* **[Permissions](#permissions) required:** Projects are returned only where the user has one of:
* *
* *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *
* *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
*
* Authentication - Required Scopes: [read:jira-work]
* @param expand Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * {@code description} Returns the project description. * {@code projectKeys} Returns all project keys associated with a project. * {@code lead} Returns information about the project lead. * {@code issueTypes} Returns all issue types associated with the project. * {@code url} Returns the URL associated with the project. * {@code permissions} Returns the permissions associated with the project. * {@code insight} EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. * {@code *} Returns the project with all available expand options. (optional)
* @param properties EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored. (optional)
*/
@RequestLine("GET /rest/api/3/project/recent?expand={expand}&properties={properties}")
@Headers({
"Accept: application/json"
})
List getRecent(@Param("expand") @Nullable String expand, @Param("properties") @Nullable List