jira_platform
library
Classes
ActorInputBean
ActorsMap
AddFieldBean
AddGroupBean
AddNotificationsDetails
Details of notifications which should be added to the notification scheme.
AddSecuritySchemeLevelsRequestBean
AnnouncementBannerApi
Jira Cloud platform REST API documentation
AnnouncementBannerConfiguration
Announcement banner configuration.
AnnouncementBannerConfigurationUpdate
Configuration of the announcement banner.
AnnouncementBannerConfigurationVisibility
ApiClient
Application
The application the linked item is in.
ApplicationProperty
Details of an application property.
ApplicationRole
Details of an application role.
ApplicationRolesApi
Jira Cloud platform REST API documentation
AppMigrationApi
Jira Cloud platform REST API documentation
AppPropertiesApi
Jira Cloud platform REST API documentation
AppWorkflowTransitionRule
A workflow transition rule.
ArchivedIssuesFilterRequest
Details of a filter for exporting archived issues.
ArchiveIssueAsyncRequest
AssociatedItemBean
Details of an item associated with the changed record.
AssociateFieldConfigurationsWithIssueTypesRequest
Details of a field configuration to issue type mappings.
AssociateSecuritySchemeWithProjectDetails
Issue security scheme, project, and remapping details.
Attachment
Details about an attachment.
AttachmentArchive
AttachmentArchiveEntry
AttachmentArchiveImpl
AttachmentArchiveItemReadable
Metadata for an item in an attachment archive.
AttachmentArchiveMetadataReadable
Metadata for an archive (for example a zip) and its contents.
AttachmentMetadata
Metadata for an issue attachment.
AttachmentSettings
Details of the instance's attachment settings.
AuditRecordBean
An audit record.
AuditRecords
Container for a list of audit records.
AuditRecordsApi
Jira Cloud platform REST API documentation
AutoCompleteSuggestion
A field auto-complete suggestion.
AutoCompleteSuggestions
The results from a JQL query.
AvailableDashboardGadget
The details of the available dashboard gadget.
AvailableDashboardGadgetsResponse
The list of available gadgets.
AvailableWorkflowConnectRule
The Connect provided ecosystem rules available.
AvailableWorkflowConnectRuleRuleType
AvailableWorkflowForgeRule
The Forge provided ecosystem rules available.
AvailableWorkflowForgeRuleRuleType
AvailableWorkflowSystemRule
The Atlassian provided system rules available.
AvailableWorkflowSystemRuleRuleType
AvailableWorkflowTriggers
The trigger rules available.
AvailableWorkflowTriggerTypes
The list of available trigger types.
Avatar
Details of an avatar.
Avatars
Details about system and custom avatars.
AvatarsApi
Jira Cloud platform REST API documentation
AvatarUrlsBean
BulkCustomFieldOptionCreateRequest
Details of the options to create for a custom field.
BulkCustomFieldOptionUpdateRequest
Details of the options to update for a custom field.
BulkIssueIsWatching
A container for the watch status of a list of issues.
BulkIssuePropertyUpdateRequest
Bulk issue property update request details.
BulkOperationErrorResult
BulkPermissionGrants
Details of global and project permissions granted to the user.
BulkPermissionsRequestBean
Details of global permissions to look up and project permissions with
associated projects and issues to look up.
BulkProjectPermissionGrants
List of project permissions and the projects and issues those permissions
grant access to.
BulkProjectPermissions
Details of project permissions and associated issues and projects to look
up.
ChangeDetails
A change item.
ChangedValueBean
Details of names changed in the record event.
ChangedWorklog
Details of a changed worklog.
ChangedWorklogs
List of changed worklogs.
ChangeFilterOwner
The account ID of the new owner.
Changelog
A log of changes made to issue fields. Changelogs related to workflow
associations are currently being deprecated.
ColumnItem
Details of an issue navigator column item.
A comment.
ComponentIssuesCount
Count of issues assigned to a component.
ComponentWithIssueCount
Details about a component with a count of the issues it contains.
ComponentWithIssueCountAssigneeType
ComponentWithIssueCountRealAssigneeType
CompoundClause
A JQL query clause that consists of nested clauses. For example, (labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the precedence of operators for more information about precedence in JQL queries.
CompoundClauseOperator
ConditionGroupConfiguration
The conditions group associated with the transition.
ConditionGroupConfigurationOperation
ConditionGroupUpdate
The conditions group associated with the transition.
ConditionGroupUpdateOperation
Configuration
Details about the configuration of Jira.
ConnectCustomFieldValue
A list of custom field details.
ConnectCustomFieldValues
Details of updates for a custom field.
ConnectCustomFieldValueType
ConnectModule
A
Connect module
in the same format as in the
app descriptor .
ConnectModules
ConnectWorkflowTransitionRule
A workflow transition rule.
ContainerForProjectFeatures
The list of features on a project.
ContainerForRegisteredWebhooks
Container for a list of registered webhooks. Webhook details are returned in
the same order as the request.
ContainerForWebhookIDs
Container for a list of webhook IDs.
ContainerOfWorkflowSchemeAssociations
A container for a list of workflow schemes together with the projects they
are associated with.
Context
A context.
ContextForProjectAndIssueType
The project and issue type mapping with a matching custom field context.
ContextualConfiguration
Details of the contextual configuration for a custom field.
ConvertedJQLQueries
The converted JQL queries.
CreateCustomFieldContext
The details of a created custom field context.
CreatedIssue
Details about a created issue or subtask.
CreatedIssues
Details about the issues created and the errors for requests that failed.
CreateIssueSecuritySchemeDetails
Issue security scheme and it's details
CreateNotificationSchemeDetails
Details of an notification scheme.
CreatePriorityDetails
Details of an issue priority.
CreatePriorityDetailsIconUrl
CreateProjectDetails
Details about the project.
CreateProjectDetailsAssigneeType
CreateProjectDetailsProjectTemplateKey
CreateProjectDetailsProjectTypeKey
CreateResolutionDetails
Details of an issue resolution.
CreateUiModificationDetails
The details of a UI modification.
CreateUpdateRoleRequestBean
CreateWorkflowCondition
A workflow transition condition.
CreateWorkflowConditionOperator
CreateWorkflowDetails
The details of a workflow.
CreateWorkflowStatusDetails
The details of a transition status.
CreateWorkflowTransitionDetails
The details of a workflow transition.
CreateWorkflowTransitionDetailsType
CreateWorkflowTransitionRule
A workflow transition rule.
CreateWorkflowTransitionRulesDetails
The details of a workflow transition rules.
CreateWorkflowTransitionScreenDetails
The details of a transition screen.
CustomContextVariable
CustomFieldConfigurations
Details of configurations for a custom field.
CustomFieldContext
The details of a custom field context.
CustomFieldContextDefaultValue
CustomFieldContextDefaultValueCascadingOption
The default value for a cascading select custom field.
CustomFieldContextDefaultValueDate
The default value for a Date custom field.
CustomFieldContextDefaultValueDateTime
The default value for a date time custom field.
CustomFieldContextDefaultValueFloat
Default value for a float (number) custom field.
CustomFieldContextDefaultValueForgeDateTimeField
The default value for a Forge date time custom field.
CustomFieldContextDefaultValueForgeGroupField
The default value for a Forge group custom field.
CustomFieldContextDefaultValueForgeMultiGroupField
The default value for a Forge collection of groups custom field.
CustomFieldContextDefaultValueForgeMultiStringField
The default text for a Forge collection of strings custom field.
CustomFieldContextDefaultValueForgeMultiUserField
Defaults for a Forge collection of users custom field.
CustomFieldContextDefaultValueForgeNumberField
Default value for a Forge number custom field.
CustomFieldContextDefaultValueForgeObjectField
The default value for a Forge object custom field.
CustomFieldContextDefaultValueForgeStringField
The default text for a Forge string custom field.
CustomFieldContextDefaultValueForgeUserField
Defaults for a Forge user custom field.
CustomFieldContextDefaultValueLabels
Default value for a labels custom field.
CustomFieldContextDefaultValueMultipleGroupPicker
The default value for a multiple group picker custom field.
CustomFieldContextDefaultValueMultipleOption
The default value for a multi-select custom field.
CustomFieldContextDefaultValueMultipleVersionPicker
The default value for a multiple version picker custom field.
CustomFieldContextDefaultValueMultiUserPicker
The default value for a User Picker (multiple) custom field.
CustomFieldContextDefaultValueProject
The default value for a project custom field.
CustomFieldContextDefaultValueReadOnly
The default text for a read only custom field.
CustomFieldContextDefaultValueSingleGroupPicker
The default value for a group picker custom field.
CustomFieldContextDefaultValueSingleOption
The default value for a single select custom field.
CustomFieldContextDefaultValueSingleVersionPicker
The default value for a version picker custom field.
CustomFieldContextDefaultValueTextArea
The default text for a text area custom field.
CustomFieldContextDefaultValueTextField
The default text for a text custom field.
CustomFieldContextDefaultValueUpdate
Default values to update.
CustomFieldContextDefaultValueURL
The default value for a URL custom field.
CustomFieldContextOption
Details of the custom field options for a context.
CustomFieldContextProjectMapping
Details of a context to project association.
CustomFieldContextSingleUserPickerDefaults
Defaults for a User Picker (single) custom field.
CustomFieldContextUpdateDetails
Details of a custom field context.
CustomFieldCreatedContextOptionsList
A list of custom field options for a context.
CustomFieldDefinitionJsonBean
CustomFieldDefinitionJsonBeanSearcherKey
CustomFieldOption
Details of a custom option for a field.
CustomFieldOptionCreate
Details of a custom field option to create.
CustomFieldOptionUpdate
Details of a custom field option for a context.
CustomFieldReplacement
Details about the replacement for a deleted version.
CustomFieldUpdatedContextOptionsList
A list of custom field options for a context.
CustomFieldValueUpdate
A list of issue IDs and the value to update a custom field to.
CustomFieldValueUpdateDetails
Details of updates for a custom field.
Dashboard
Details of a dashboard.
DashboardDetails
Details of a dashboard.
DashboardGadget
Details of a gadget.
DashboardGadgetColor
DashboardGadgetPosition
Details of a gadget position.
DashboardGadgetResponse
The list of gadgets on the dashboard.
DashboardGadgetSettings
Details of the settings for a dashboard gadget.
DashboardGadgetUpdateRequest
The details of the gadget to update.
DashboardsApi
Jira Cloud platform REST API documentation
DateRangeFilterRequest
List issues archived within a specified date range.
DefaultLevelValue
Details of scheme and new default level.
DefaultShareScope
Details of the scope of the default sharing for new filters and dashboards.
DefaultShareScopeScope
DefaultWorkflow
Details about the default workflow.
DeleteAndReplaceVersionBean
DeprecatedWorkflow
Details about a workflow.
DocumentVersion
The version details of the workflow.
DynamicModulesApi
Jira Cloud platform REST API documentation
EntityProperty
An entity property, for more information see
Entity properties .
EntityPropertyDetails
Error
ErrorCollection
Error messages from an operation.
ErrorMessage
Errors
EventNotification
Details about a notification associated with an event.
EventNotificationNotificationType
ExportArchivedIssuesTaskProgressResponse
The response for status request for a running/completed export task.
FailedWebhook
Details about a failed webhook.
FailedWebhooks
A page of failed webhooks.
Field
Details of a field.
FieldChangedClause
A clause that asserts whether a field was changed. For example, status CHANGED AFTER startOfMonth(-1M).See
CHANGED
for more information about the CHANGED operator.
FieldChangedClauseOperator
FieldConfiguration
Details of a field configuration.
FieldConfigurationDetails
Details of a field configuration.
FieldConfigurationIssueTypeItem
The field configuration for an issue type.
FieldConfigurationItem
A field within a field configuration.
FieldConfigurationItemsDetails
Details of field configuration items.
FieldConfigurationScheme
Details of a field configuration scheme.
FieldConfigurationSchemeProjectAssociation
Associated field configuration scheme and project.
FieldConfigurationSchemeProjects
Project list with assigned field configuration schema.
FieldConfigurationToIssueTypeMapping
The field configuration to issue type mapping.
FieldDetails
Details about a field.
FieldLastUsed
Information about the most recent use of a field.
FieldLastUsedType
FieldMetadata
The metadata describing an issue field.
FieldReferenceData
Details of a field that can be used in advanced searches.
FieldReferenceDataAuto
FieldReferenceDataDeprecated
FieldReferenceDataOrderable
FieldReferenceDataSearchable
Fields
Key fields from the linked issue.
FieldUpdateOperation
Details of an operation to perform on a field.
FieldValueClause
A clause that asserts the current value of a field. For example, summary ~ test.
FieldValueClauseOperator
FieldWasClause
A clause that asserts a previous value of a field. For example, status WAS "Resolved" BY currentUser() BEFORE "2019/02/02". See
WAS
for more information about the WAS operator.
FieldWasClauseOperator
Filter
Details about a filter.
FilterDetails
Details of a filter.
FiltersApi
Jira Cloud platform REST API documentation
FilterSharingApi
Jira Cloud platform REST API documentation
FilterSubscription
Details of a user or group subscribing to a filter.
FilterSubscriptionsList
A paginated list of subscriptions to a filter.
FoundGroup
A group found in a search.
FoundGroups
The list of groups found in a search, including header text (Showing X of Y
matching groups) and total of matched groups.
FoundUsers
The list of users found in a search, including header text (Showing X of Y
matching users) and total of matched users.
FoundUsersAndGroups
List of users and groups found in a search.
FunctionOperand
An operand that is a function. See
Advanced searching - functions reference
for more information about JQL functions.
FunctionReferenceData
Details of functions that can be used in advanced searches.
FunctionReferenceDataIsList
GlobalScopeBean
GlobalScopeBeanAttributes
Group
GroupAndUserPickerApi
Jira Cloud platform REST API documentation
GroupDetails
Details about a group.
GroupLabel
A group label.
GroupLabelType
GroupName
Details about a group.
GroupsApi
Jira Cloud platform REST API documentation
HealthCheckResult
Jira instance health check results. Deprecated and no longer returned.
Hierarchy
The project issue type hierarchy.
HistoryMetadata
Details of issue history metadata.
HistoryMetadataParticipant
Details of user or system associated with a issue history metadata item.
Icon
An icon. If no icon is defined:
IconBean
An icon.
IdBean
IdOrKeyBean
IncludedFields
IssueArchivalSyncRequest
List of Issue Ids Or Keys that are to be archived or unarchived
IssueArchivalSyncResponse
Number of archived/unarchived issues and list of errors that occurred during
the action, if any.
IssueAttachmentsApi
Jira Cloud platform REST API documentation
IssueBean
Details about an issue.
IssueChangelogIds
A list of changelog IDs.
Jira Cloud platform REST API documentation
Jira Cloud platform REST API documentation
IssueContextVariable
An
issue
specified by ID or key. All the fields of the issue object are available in
the Jira expression.
IssueCreateMetadata
The wrapper for the issue creation metadata for a list of projects.
IssueCustomFieldConfigurationAppsApi
Jira Cloud platform REST API documentation
IssueCustomFieldContextsApi
Jira Cloud platform REST API documentation
IssueCustomFieldOptionsApi
Jira Cloud platform REST API documentation
IssueCustomFieldOptionsAppsApi
Jira Cloud platform REST API documentation
IssueCustomFieldValuesAppsApi
Jira Cloud platform REST API documentation
IssueEntityProperties
Lists of issues and entity properties. See
Entity properties
for more information.
IssueEntityPropertiesForMultiUpdate
An issue ID with entity property values. See
Entity properties
for more information.
IssueEvent
Details about an issue event.
IssueFieldConfigurationsApi
Jira Cloud platform REST API documentation
IssueFieldOption
Details of the options for a select list issue field.
IssueFieldOptionConfiguration
Details of the projects the option is available in.
IssueFieldOptionConfigurationAttributes
IssueFieldOptionCreateBean
IssueFieldOptionScopeBean
IssueFieldsApi
Jira Cloud platform REST API documentation
IssueFilterForBulkPropertyDelete
Bulk operation filter details.
IssueFilterForBulkPropertySet
Bulk operation filter details.
IssueLink
Details of a link between issues.
IssueLinksApi
Jira Cloud platform REST API documentation
IssueLinkType
This object is used as follows:
IssueLinkTypes
A list of issue link type beans.
IssueLinkTypesApi
Jira Cloud platform REST API documentation
IssueList
A list of issue IDs.
IssueMatches
A list of matched issues or errors for each JQL query, in the order the JQL
queries were passed.
IssueMatchesForJQL
A list of the issues matched to a JQL query or details of errors encountered
during matching.
IssueNavigatorSettingsApi
Jira Cloud platform REST API documentation
IssueNotificationSchemesApi
Jira Cloud platform REST API documentation
IssuePickerSuggestions
A list of issues suggested for use in auto-completion.
IssuePickerSuggestionsIssueType
A type of issue suggested for use in auto-completion.
IssuePrioritiesApi
Jira Cloud platform REST API documentation
IssuePropertiesApi
Jira Cloud platform REST API documentation
IssueRemoteLinksApi
Jira Cloud platform REST API documentation
IssueResolutionsApi
Jira Cloud platform REST API documentation
IssuesAndJQLQueries
List of issues and JQL queries.
IssuesApi
Jira Cloud platform REST API documentation
IssueSearchApi
Jira Cloud platform REST API documentation
IssueSecurityLevelApi
Jira Cloud platform REST API documentation
IssueSecurityLevelMember
Issue security level member.
IssueSecuritySchemesApi
Jira Cloud platform REST API documentation
IssueSecuritySchemeToProjectMapping
Details about an project using security scheme mapping.
IssuesJqlMetaDataBean
The description of the page of issues loaded by the provided JQL query.
IssuesMetaBean
Meta data describing the issues context variable.
IssuesUpdateBean
IssueTransition
Details of an issue transition.
IssueTypeCreateBean
IssueTypeCreateBeanType
IssueTypeDetails
Details about an issue type.
IssueTypeIds
The list of issue type IDs.
IssueTypeIdsToRemove
The list of issue type IDs to be removed from the field configuration
scheme.
IssueTypeInfo
Details of an issue type.
IssueTypeIssueCreateMetadata
Details of the issue creation metadata for an issue type.
IssueTypePropertiesApi
Jira Cloud platform REST API documentation
IssueTypesApi
Jira Cloud platform REST API documentation
IssueTypeScheme
Details of an issue type scheme.
IssueTypeSchemeDetails
Details of an issue type scheme and its associated issue types.
IssueTypeSchemeID
The ID of an issue type scheme.
IssueTypeSchemeMapping
Issue type scheme item.
IssueTypeSchemeProjectAssociation
Details of the association between an issue type scheme and project.
IssueTypeSchemeProjects
Issue type scheme with a list of the projects that use it.
IssueTypeSchemesApi
Jira Cloud platform REST API documentation
IssueTypeSchemeUpdateDetails
Details of the name, description, and default issue type for an issue type
scheme.
IssueTypeScreenScheme
Details of an issue type screen scheme.
IssueTypeScreenSchemeDetails
The details of an issue type screen scheme.
IssueTypeScreenSchemeId
The ID of an issue type screen scheme.
IssueTypeScreenSchemeItem
The screen scheme for an issue type.
IssueTypeScreenSchemeMapping
The IDs of the screen schemes for the issue type IDs.
IssueTypeScreenSchemeMappingDetails
A list of issue type screen scheme mappings.
IssueTypeScreenSchemeProjectAssociation
Associated issue type screen scheme and project.
IssueTypeScreenSchemesApi
Jira Cloud platform REST API documentation
IssueTypeScreenSchemesProjects
Issue type screen scheme with a list of the projects that use it.
IssueTypeScreenSchemeUpdateDetails
Details of an issue type screen scheme.
IssueTypesWorkflowMapping
Details about the mapping between issue types and a workflow.
IssueTypeToContextMapping
Mapping of an issue type to a context.
IssueTypeUpdateBean
IssueTypeWithStatus
Status details for an issue type.
IssueTypeWorkflowMapping
Details about the mapping between an issue type and a workflow.
IssueUpdateDetails
Details of an issue update request.
IssueUpdateMetadata
A list of editable field details.
IssueVotesApi
Jira Cloud platform REST API documentation
IssueWatchersApi
Jira Cloud platform REST API documentation
IssueWorklogPropertiesApi
Jira Cloud platform REST API documentation
IssueWorklogsApi
Jira Cloud platform REST API documentation
JexpIssues
The JQL specifying the issues available in the evaluated Jira expression
under the issues context variable.
JexpJqlIssues
The JQL specifying the issues available in the evaluated Jira expression
under the issues context variable. Not all issues returned by the JQL
query are loaded, only those described by the startAt and maxResults
properties. To determine whether it is necessary to iterate to ensure all
the issues returned by the JQL query are evaluated, inspect
meta.issues.jql.count in the response.
JexpJqlIssuesValidation
JiraExpressionAnalysis
Details about the analysed Jira expression.
JiraExpressionComplexity
Details about the complexity of the analysed Jira expression.
JiraExpressionEvalContextBean
JiraExpressionEvalRequestBean
JiraExpressionEvaluationMetaDataBean
JiraExpressionForAnalysis
Details of Jira expressions for analysis.
JiraExpressionResult
The result of evaluating a Jira expression.
JiraExpressionsAnalysis
Details about the analysed Jira expression.
JiraExpressionsApi
Jira Cloud platform REST API documentation
JiraExpressionsComplexityBean
JiraExpressionsComplexityValueBean
JiraExpressionValidationError
Details about syntax and type errors. The error details apply to the entire
expression, unless the object includes:
JiraExpressionValidationErrorType
JiraPlatformApi
JiraSettingsApi
Jira Cloud platform REST API documentation
JiraStatus
Details of a status.
JiraStatusStatusCategory
JiraWorkflow
Details of a workflow.
JiraWorkflowStatus
Details of a status.
JiraWorkflowStatusStatusCategory
JQLApi
Jira Cloud platform REST API documentation
JqlFunctionPrecomputationBean
Jql function precomputation.
JqlFunctionPrecomputationUpdateBean
Precomputation id and its new value.
JqlFunctionPrecomputationUpdateRequestBean
List of pairs (id and value) for precomputation updates.
JQLFunctionsAppsApi
Jira Cloud platform REST API documentation
JQLPersonalDataMigrationRequest
The JQL queries to be converted.
JqlQueriesToParse
A list of JQL queries to parse.
JqlQueriesToSanitize
The list of JQL queries to sanitize for the given account IDs.
JqlQuery
A parsed JQL query.
JqlQueryClause
A JQL query clause.
JqlQueryClauseOperand
Details of an operand in a JQL clause.
JqlQueryClauseTimePredicate
A time predicate for a temporal JQL clause.
JqlQueryClauseTimePredicateOperator
JqlQueryField
A field used in a JQL query. See
Advanced searching - fields reference
for more information about fields in JQL queries.
JqlQueryFieldEntityProperty
Details of an entity property.
JqlQueryFieldEntityPropertyType
JqlQueryOrderByClause
Details of the order-by JQL clause.
JqlQueryOrderByClauseElement
An element of the order-by JQL clause.
JqlQueryOrderByClauseElementDirection
JqlQueryToSanitize
The JQL query to sanitize for the account ID. If the account ID is null,
sanitizing is performed for an anonymous user.
JqlQueryUnitaryOperand
An operand that can be part of a list operand.
JQLQueryWithUnknownUsers
JQL queries that contained users that could not be found
JQLReferenceData
Lists of JQL reference data.
JsonContextVariable
A JSON object with custom content.
JsonNode
JsonNodeNumberType
JsonTypeBean
The schema of a field.
KeywordOperand
An operand that is a JQL keyword. See
Advanced searching - keywords reference
for more information about operand keywords.
KeywordOperandKeyword
LabelsApi
Jira Cloud platform REST API documentation
License
Details about a license for the Jira instance.
LicensedApplication
Details about a licensed Jira application.
LicensedApplicationPlan
LicenseMetric
A metric that provides insight into the active licence details
LicenseMetricsApi
Jira Cloud platform REST API documentation
LinkedIssue
The ID or key of a linked issue.
LinkGroup
Details a link group, which defines issue operations.
LinkIssueRequestJsonBean
ListOperand
An operand that is a list of values.
ListWrapperCallbackApplicationRole
ListWrapperCallbackGroupName
Locale
Details of a locale.
MoveFieldBean
MoveFieldBeanPosition
MultiIssueEntityProperties
A list of issues and their respective properties to set or update. See
Entity properties
for more information.
MultipartFile
A file to be uploaded as part of a MultipartRequest.
MultipleCustomFieldValuesUpdate
A custom field and its new value with a list of issue to update.
MultipleCustomFieldValuesUpdateDetails
List of updates for a custom fields.
MyselfApi
Jira Cloud platform REST API documentation
NestedResponse
NewUserDetails
The user details.
Notification
Details about a notification.
NotificationEvent
Details about a notification event.
NotificationRecipients
Details of the users and groups to receive the notification.
NotificationRecipientsRestrictions
Details of the group membership or permissions needed to receive the
notification.
NotificationScheme
Details about a notification scheme.
NotificationSchemeAndProjectMappingJsonBean
NotificationSchemeEvent
Details about a notification scheme event.
NotificationSchemeEventDetails
Details of a notification scheme event.
NotificationSchemeEventTypeId
The ID of an event that is being mapped to notifications.
NotificationSchemeId
The ID of a notification scheme.
NotificationSchemeNotificationDetails
Details of a notification within a notification scheme.
OldToNewSecurityLevelMappingsBean
OperationMessage
Operations
Details of the operations that can be performed on the issue.
OrderOfCustomFieldOptions
An ordered list of custom field option IDs and information on where to move
them.
OrderOfCustomFieldOptionsPosition
OrderOfIssueTypes
An ordered list of issue type IDs and information about where to move them.
OrderOfIssueTypesPosition
PageBeanChangelog
A page of items.
A page of items.
PageBeanComponentWithIssueCount
A page of items.
PageBeanContext
A page of items.
PageBeanContextForProjectAndIssueType
A page of items.
PageBeanContextualConfiguration
A page of items.
PageBeanCustomFieldContext
A page of items.
PageBeanCustomFieldContextDefaultValue
A page of items.
PageBeanCustomFieldContextOption
A page of items.
PageBeanCustomFieldContextProjectMapping
A page of items.
PageBeanDashboard
A page of items.
PageBeanField
A page of items.
PageBeanFieldConfigurationDetails
A page of items.
PageBeanFieldConfigurationIssueTypeItem
A page of items.
PageBeanFieldConfigurationItem
A page of items.
PageBeanFieldConfigurationScheme
A page of items.
PageBeanFieldConfigurationSchemeProjects
A page of items.
PageBeanFilterDetails
A page of items.
PageBeanGroupDetails
A page of items.
PageBeanIssueFieldOption
A page of items.
PageBeanIssueSecurityLevelMember
A page of items.
PageBeanIssueSecuritySchemeToProjectMapping
A page of items.
PageBeanIssueTypeScheme
A page of items.
PageBeanIssueTypeSchemeMapping
A page of items.
PageBeanIssueTypeSchemeProjects
A page of items.
PageBeanIssueTypeScreenScheme
A page of items.
PageBeanIssueTypeScreenSchemeItem
A page of items.
PageBeanIssueTypeScreenSchemesProjects
A page of items.
PageBeanIssueTypeToContextMapping
A page of items.
PageBeanJqlFunctionPrecomputationBean
A page of items.
PageBeanNotificationScheme
A page of items.
PageBeanNotificationSchemeAndProjectMappingJsonBean
A page of items.
PageBeanPriority
A page of items.
PageBeanProject
A page of items.
PageBeanProjectDetails
A page of items.
PageBeanResolutionJsonBean
A page of items.
PageBeanScreen
A page of items.
PageBeanScreenScheme
A page of items.
PageBeanScreenWithTab
A page of items.
PageBeanSecurityLevel
A page of items.
PageBeanSecurityLevelMember
A page of items.
PageBeanSecuritySchemeWithProjects
A page of items.
PageBeanString
A page of items.
PageBeanUiModificationDetails
A page of items.
PageBeanUser
A page of items.
PageBeanUserDetails
A page of items.
PageBeanUserKey
A page of items.
PageBeanVersion
A page of items.
PageBeanWebhook
A page of items.
PageBeanWorkflow
A page of items.
PageBeanWorkflowScheme
A page of items.
PageBeanWorkflowTransitionRules
A page of items.
PagedListUserDetailsApplicationUser
A paged list. To access additional details append [start-index:end-index]
to the expand request. For example, ?expand=sharedUsers[10:40] returns a
list starting at item 10 and finishing at item 40.
PageOfChangelogs
A page of changelogs.
A page of comments.
PageOfDashboards
A page containing dashboard details.
PageOfStatuses
PageOfWorklogs
Paginated list of worklog details
ParsedJqlQueries
A list of parsed JQL queries.
ParsedJqlQuery
Details of a parsed JQL query.
PermissionGrant
Details about a permission granted to a user or group.
PermissionGrants
List of permission grants.
PermissionHolder
Details of a user, group, field, or project role that holds a permission.
See Holder object in Get
all permission schemes for more information.
Permissions
Details about permissions.
PermissionsApi
Jira Cloud platform REST API documentation
PermissionScheme
Details of a permission scheme.
PermissionSchemes
List of all permission schemes.
PermissionSchemesApi
Jira Cloud platform REST API documentation
PermissionsKeysBean
PermittedProjects
A list of projects in which a user is granted permissions.
Priority
An issue priority.
PriorityId
The ID of an issue priority.
Project
Details about a project.
ProjectAndIssueTypePair
A project and issueType ID pair that identifies a status mapping.
ProjectAssigneeType
ProjectAvatars
List of project avatars.
ProjectAvatarsApi
Jira Cloud platform REST API documentation
ProjectCategoriesApi
Jira Cloud platform REST API documentation
ProjectCategory
A project category.
ProjectComponent
Details about a project component.
ProjectComponentAssigneeType
ProjectComponentRealAssigneeType
ProjectComponentsApi
Jira Cloud platform REST API documentation
ProjectDetails
Details about a project.
ProjectDetailsProjectTypeKey
ProjectEmailAddress
A project's sender email address.
ProjectEmailApi
Jira Cloud platform REST API documentation
ProjectFeature
Details of a project feature.
ProjectFeaturesApi
Jira Cloud platform REST API documentation
ProjectFeatureState
Details of the feature state.
ProjectFeatureStateEnum
ProjectFeatureStateState
ProjectId
Project ID details.
ProjectIdentifierBean
The identifiers for a project.
ProjectIdentifiers
Identifiers for a project.
ProjectIds
A list of project IDs.
ProjectInsight
Additional details about a project.
ProjectIssueCreateMetadata
Details of the issue creation metadata for a project.
ProjectIssueSecurityLevels
List of issue level security items in a project.
ProjectIssueTypeHierarchy
The hierarchy of issue types within a project.
ProjectIssueTypeMapping
The project and issue type mapping.
ProjectIssueTypeMappings
The project and issue type mappings.
ProjectIssueTypes
Projects and issue types where the status is used. Only available if the
usages expand is requested.
ProjectIssueTypesHierarchyLevel
Details of an issue type hierarchy level.
ProjectKeyAndNameValidationApi
Jira Cloud platform REST API documentation
ProjectLandingPageInfo
ProjectPermissions
Permissions which a user has on a project.
ProjectPermissionSchemesApi
Jira Cloud platform REST API documentation
ProjectProjectTypeKey
ProjectPropertiesApi
Jira Cloud platform REST API documentation
ProjectRole
Details about the roles in a project.
ProjectRoleActorsApi
Jira Cloud platform REST API documentation
ProjectRoleActorsUpdateBean
ProjectRoleDetails
Details about a project role.
ProjectRoleGroup
Details of the group associated with the role.
ProjectRolesApi
Jira Cloud platform REST API documentation
ProjectRoleUser
Details of the user associated with the role.
ProjectsApi
Jira Cloud platform REST API documentation
ProjectScopeBean
ProjectScopeBeanAttributes
ProjectStyle
ProjectType
Details about a project type.
ProjectTypesApi
Jira Cloud platform REST API documentation
ProjectVersionsApi
Jira Cloud platform REST API documentation
PropertyKey
Property key details.
PropertyKeys
List of property keys.
PublishDraftWorkflowScheme
Details about the status mappings for publishing a draft workflow scheme.
PublishedWorkflowId
Properties that identify a published workflow.
RegisteredWebhook
ID of a registered webhook or error messages explaining why a webhook wasn't
registered.
RemoteIssueLink
Details of an issue remote link.
RemoteIssueLinkIdentifies
Details of the identifiers for a created or updated remote issue link.
RemoteIssueLinkRequest
Details of a remote issue link.
RemoteObject
The linked item.
RemoveOptionFromIssuesResult
ReorderIssuePriorities
Change the order of issue priorities.
ReorderIssueResolutionsRequest
Change the order of issue resolutions.
Resolution
Details of an issue resolution.
ResolutionId
The ID of an issue resolution.
ResolutionJsonBean
RestrictedPermission
Details of the permission.
RichText
RoleActor
Details about a user assigned to a project role.
RoleActorType
RuleConfiguration
A rule configuration.
SanitizedJqlQueries
The sanitized JQL queries for the given account IDs.
SanitizedJqlQuery
Details of the sanitized JQL query.
Scope
The projects the item is associated with. Indicated for items associated
with next-gen projects .
ScopeType
Screen
A screen.
ScreenableField
A screen tab field.
ScreenableTab
A screen tab.
ScreenDetails
Details of a screen.
ScreensApi
Jira Cloud platform REST API documentation
ScreenScheme
A screen scheme.
ScreenSchemeDetails
Details of a screen scheme.
ScreenSchemeId
The ID of a screen scheme.
ScreenSchemesApi
Jira Cloud platform REST API documentation
ScreenTabFieldsApi
Jira Cloud platform REST API documentation
ScreenTabsApi
Jira Cloud platform REST API documentation
ScreenTypes
The IDs of the screens for the screen types of the screen scheme.
ScreenWithTab
A screen with tab details.
SearchAutoCompleteFilter
Details of how to filter and list search auto complete information.
SearchRequestBean
SearchRequestBeanValidateQuery
SearchResults
The result of a JQL search.
SecurityLevel
Details of an issue level security item.
SecurityLevelMember
Issue security level member.
SecurityScheme
Details about a security scheme.
SecuritySchemeId
The ID of the issue security scheme.
SecuritySchemeLevelBean
SecuritySchemeLevelMemberBean
SecuritySchemeMembersRequest
Details of issue security scheme level new members.
SecuritySchemes
List of security schemes.
SecuritySchemeWithProjects
Details about an issue security scheme.
ServerInfoApi
Jira Cloud platform REST API documentation
ServerInformation
Details about the Jira instance.
ServiceManagementNavigationInfo
SetDefaultLevelsRequest
Details of new default levels.
SetDefaultPriorityRequest
The new default issue priority.
SetDefaultResolutionRequest
The new default issue resolution.
SharePermission
Details of a share permission for the filter.
SharePermissionInputBean
SharePermissionInputBeanType
SharePermissionType
SimpleApplicationPropertyBean
SimpleErrorCollection
SimpleLink
Details about the operations available in this version.
SimpleListWrapperApplicationRole
SimpleListWrapperGroupName
SimplifiedHierarchyLevel
SoftwareNavigationInfo
Status
The status of the item.
StatusApi
Jira Cloud platform REST API documentation
StatusCategory
A status category.
StatusCreate
Details of the status being created.
StatusCreateRequest
Details of the statuses being created and their scope.
StatusCreateStatusCategory
StatusDetails
A status.
StatusLayoutUpdate
The statuses associated with this workflow.
StatusMapping
Details about the mapping from a status to a new status for an issue type.
StatusMappingDTO
The mapping of old to new status ID for a specific project and issue type.
StatusMigration
The mapping of old to new status ID.
StatusReferenceAndPort
The status reference and port that a transition is connected to.
StatusScope
The scope of the status.
StatusScopeType
StatusUpdate
Details of the status being updated.
StatusUpdateRequest
The list of statuses that will be updated.
StatusUpdateStatusCategory
StringList
SuggestedIssue
An issue suggested for use in the issue picker auto-completion.
SystemAvatars
List of system avatars.
TaskProgressBeanObject
Details about a task.
TaskProgressBeanObjectStatus
TaskProgressBeanRemoveOptionFromIssuesResult
Details about a task.
TaskProgressBeanRemoveOptionFromIssuesResultStatus
TasksApi
Jira Cloud platform REST API documentation
TimeTrackingApi
Jira Cloud platform REST API documentation
TimeTrackingConfiguration
Details of the time tracking configuration.
TimeTrackingConfigurationDefaultUnit
TimeTrackingConfigurationTimeFormat
TimeTrackingDetails
Time tracking details.
TimeTrackingProvider
Details about the time tracking provider.
Transition
Details of a workflow transition.
Transitions
List of issue transitions.
TransitionScreenDetails
The details of a transition screen.
TransitionType
TransitionUpdateDTO
The transitions of this workflow.
TransitionUpdateDTOType
UiModificationContextDetails
The details of a UI modification's context, which define where to activate
the UI modification.
UiModificationDetails
The details of a UI modification.
UiModificationIdentifiers
Identifiers for a UI modification.
UIModificationsAppsApi
Jira Cloud platform REST API documentation
UnrestrictedUserEmail
UpdateCustomFieldDetails
Details of a custom field.
UpdateCustomFieldDetailsSearcherKey
UpdateDefaultScreenScheme
The ID of a screen scheme.
UpdatedProjectCategory
A project category.
UpdateFieldConfigurationSchemeDetails
The details of the field configuration scheme.
UpdateIssueSecurityLevelDetails
Details of issue security scheme level.
UpdateIssueSecuritySchemeRequestBean
UpdateNotificationSchemeDetails
Details of a notification scheme.
UpdatePriorityDetails
Details of an issue priority.
UpdatePriorityDetailsIconUrl
UpdateProjectDetails
Details about the project.
UpdateProjectDetailsAssigneeType
UpdateResolutionDetails
Details of an issue resolution.
UpdateScreenDetails
Details of a screen.
UpdateScreenSchemeDetails
Details of a screen scheme.
UpdateScreenTypes
The IDs of the screens for the screen types of the screen scheme.
UpdateUiModificationDetails
The details of a UI modification.
UpdateUserToGroupBean
User
A user with details as permitted by the user's Atlassian Account privacy
settings. However, be aware of these exceptions:
UserAccountType
UserBean
UserBeanAvatarUrls
UserContextVariable
A
user
specified as an Atlassian account ID.
UserDetails
User details permitted by the user's Atlassian Account privacy settings.
However, be aware of these exceptions:
UserFilter
Filter for a User Picker (single) custom field.
UserKey
List of user account IDs.
UserList
A paginated list of users sharing the filter. This includes users that are
members of the groups or can browse the projects that the filter is shared
with.
UserMigrationBean
UserPermission
Details of a permission and its availability to a user.
UserPermissionType
UserPickerUser
A user found in a search.
UserPropertiesApi
Jira Cloud platform REST API documentation
UsersApi
Jira Cloud platform REST API documentation
UserSearchApi
Jira Cloud platform REST API documentation
ValidationOptionsForCreate
The level of validation to return from the API. If no values are provided,
the default would return WARNING and ERROR level validation results.
ValidationOptionsForCreateLevels
ValidationOptionsForUpdate
The level of validation to return from the API. If no values are provided,
the default would return WARNING and ERROR level validation results.
ValidationOptionsForUpdateLevels
ValueOperand
An operand that is a user-provided value.
Version
Details about a project version.
VersionIssueCounts
Various counts of issues within a version.
VersionIssuesStatus
Counts of the number of issues in various statuses.
VersionMoveBean
VersionMoveBeanPosition
VersionUnresolvedIssuesCount
Count of a version's unresolved issues.
VersionUsageInCustomField
List of custom fields using the version.
Visibility
The group or role to which this item is visible.
VisibilityType
Votes
The details of votes on an issue.
WarningCollection
Watchers
The details of watchers on an issue.
Webhook
A webhook.
WebhookDetails
A list of webhooks.
WebhookDetailsEvents
WebhookEvents
WebhookRegistrationDetails
Details of webhooks to register.
WebhooksApi
Jira Cloud platform REST API documentation
WebhooksExpirationDate
The date the refreshed webhooks expire.
Workflow
Details about a workflow.
WorkflowCapabilities
WorkflowCapabilitiesEditorScope
WorkflowCapabilitiesProjectTypes
WorkflowCompoundCondition
A compound workflow transition rule condition. This object returns
nodeType as compound.
WorkflowCompoundConditionOperator
WorkflowCondition
The workflow transition rule conditions tree.
WorkflowCreate
The details of the workflows to create.
WorkflowCreateRequest
The create workflows payload.
WorkflowCreateResponse
Details of the created workflows and statuses.
WorkflowCreateValidateRequest
WorkflowElementReference
A reference to the location of the error. This will be null if the error
does not refer to a specific element.
WorkflowId
Properties that identify a workflow.
WorkflowIDs
The classic workflow identifiers.
WorkflowLayout
The starting point for the statuses in the workflow.
WorkflowOperations
Operations allowed on a workflow
WorkflowReadRequest
WorkflowReadResponse
Details of workflows and related statuses.
WorkflowReferenceStatus
The statuses referenced in the workflow.
WorkflowRuleConfiguration
The configuration of the rule.
WorkflowRules
A collection of transition rules.
WorkflowRulesSearch
Details of the workflow and its transition rules.
WorkflowRulesSearchDetails
Details of workflow transition rules.
WorkflowsApi
Jira Cloud platform REST API documentation
WorkflowScheme
Details about a workflow scheme.
WorkflowSchemeAssociations
A workflow scheme along with a list of projects that use it.
WorkflowSchemeDraftsApi
Jira Cloud platform REST API documentation
WorkflowSchemeIdName
The ID and the name of the workflow scheme.
WorkflowSchemeProjectAssociation
An associated workflow scheme and project.
WorkflowSchemeProjectAssociationsApi
Jira Cloud platform REST API documentation
WorkflowSchemesApi
Jira Cloud platform REST API documentation
WorkflowScope
The scope of the workflow.
WorkflowScopeType
WorkflowSimpleCondition
A workflow transition rule condition. This object returns nodeType as
simple.
WorkflowStatus
Details of a workflow status.
WorkflowStatusAndPort
The status reference and port that a transition is connected to.
WorkflowStatusCategoriesApi
Jira Cloud platform REST API documentation
WorkflowStatusesApi
Jira Cloud platform REST API documentation
WorkflowStatusLayout
The x and y location of the status in the workflow.
WorkflowStatusUpdate
Details of the status being updated.
WorkflowStatusUpdateStatusCategory
WorkflowsWithTransitionRulesDetails
Details of workflows and their transition rules to delete.
WorkflowTransition
A workflow transition.
WorkflowTransitionPropertiesApi
Jira Cloud platform REST API documentation
WorkflowTransitionProperty
Details about the server Jira is running on.
WorkflowTransitionRule
A workflow transition rule.
WorkflowTransitionRules
A workflow with transition rules.
WorkflowTransitionRulesApi
Jira Cloud platform REST API documentation
WorkflowTransitionRulesDetails
Details about a workflow configuration update request.
WorkflowTransitionRulesUpdate
Details about a workflow configuration update request.
WorkflowTransitionRulesUpdateErrorDetails
Details of any errors encountered while updating workflow transition rules
for a workflow.
WorkflowTransitionRulesUpdateErrors
Details of any errors encountered while updating workflow transition rules.
WorkflowTransitions
The transitions of the workflow.
WorkflowTransitionsType
WorkflowTrigger
The trigger configuration associated with a workflow.
WorkflowUpdate
The details of the workflows to update.
WorkflowUpdateRequest
The update workflows payload.
WorkflowUpdateResponse
WorkflowUpdateValidateRequestBean
WorkflowUsages
The workflows that use this status. Only available if the workflowUsages
expand is requested.
WorkflowValidationError
The details about a workflow validation error.
WorkflowValidationErrorLevel
WorkflowValidationErrorList
WorkflowValidationErrorType
Worklog
Details of a worklog.
WorklogIdsRequestBean
WorkManagementNavigationInfo
