Jira Structured Connector Objects

Objects Supported

Name Description
AdvancedSettings Query the application properties that are accessible on the Advanced Settings page.
ApplicationRoles Query all application roles. In Jira, application roles are managed using the Application access configuration page.
Attachments Query, insert and delete the available Attachments in Jira.
Audit Query the audit log of your Jira account.
BoardConfiguration Query the agile Board Configuration in Jira.
BoardIssues Query the agile Board Issues in Jira.
Boards Query, insert and delete the agile Boards in Jira.
BoardSprints Query the agile Sprints related to a Jira Board.
Comments Create, modify, delete and query the available Comment types in Jira.
Configuration Query the available Configurations in Jira.
Dashboards Query the available Dashboards in Jira.
Epics Query all the Epics.
FavouriteFilters Query the favourite Filters in Jira.
Fields Query the available System and Custom Fields in Jira.
Filters Query the set up Filters in Jira. This table is not available in Jira Server.
FiltersUsers Query the users that filters are shared with.
Groups Query the available Groups in Jira.
GroupsUsers Query the users available in Jira and their associated groups.
IssueAffectedVersions Query the Affected Versions of an issue in Jira.
IssueChangelogs Query the available IssueChangelogs in Jira.
IssueComponents Query the available IssueComponents in Jira.
IssueCustomFieldOptions Query Issue Custom Field Options in Jira. This resource is not available in Jira Server or when using OAuth authentication. Specifying at least CUSTOMFIELDID, or ID is required.
IssueCustomFields Query the available Custom Fields in Jira.
IssueFixVersions Query the available IssueFixVersions in Jira.
IssueLinks Query the available IssueLinks in Jira.
IssueLinkTypes Lists all the issue link types.
IssueNavigatorDefaultColumns Query the default issue navigator columns.
IssuePriorities Query the list of all issue priorities.
IssueResolutions Query the list of all issue resolution values.
Issues Create, modify, delete and query Issues in Jira.
IssueSecurityLevelMembers Query the members of issue security level entities.
IssueSubtasks Query the available IssueSubtasks in Jira.
IssueTransitions Query the available IssueTransitions in Jira.
IssueTypes Query the available Issue Types in Jira.
MyPermissions Query the available Permissions of the current user in Jira.
PermissionGrants Query the available permission grants for a permission scheme in Jira.
Permissions Query the available Permissions in Jira.
PermissionSchemes Query the available permission schemes in Jira.
ProjectCategories Query all the project categories.
ProjectComponents Query, create, modify, and delete the available Components of a project in Jira.
ProjectRoleActors Query the actors who act in a role for specific projects in Jira.
ProjectRoles Query roles for all projects in Jira.
Projects Query, update, insert and delete the available Projects in Jira.
ProjectsIssueTypes Query the available Issue Types of projects.
ProjectsPermissionScheme Query the available permissions schemes for a project in Jira.
ProjectTypes Query the list of all issue priorities.
ProjectVersions Query,create, modify and delete the available Versions of a project in Jira.
RoleActors Query the default actors for project roles in Jira.
Roles Query the available roles in Jira.
SecurityLevels Query all the created security levels.
SecuritySchemes Query all the created security schemes.
SprintIssues Query the agile Sprint Issues in Jira.
Sprints Query,create, modify and delete the agile Sprints in Jira.
Statuses Query the possible Statuses in Jira.
TimeTrackingProviders Query the list of all time tracking providers.
Users Query the available Users in Jira.
Votes Query the available Votes in Jira.
Watchers Query the available Watchers in Jira.
Workflows Query the available Workflows in Jira.
WorkflowSchemes Create, modify, delete and query the available workflow schemes in Jira.
WorkflowStatusCategories Query the list of all status categories.
WorkflowStatuses Query the list of all statuses associated with workflows.
WorklogDeleted Queries the deleted worklogs in your Jira account.
Worklogs Create, modify, delete and query the available Worklogs in Jira.

AdvancedSettings

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The ID of the application property.
Name String False No The name of the application property.
Description String False No The description of the application property.
Type String False No The data type of the application property.
Value String False No The new value.
DefaultValue String False No The default value of the application property.
AllowedValues String False No The allowed values, if applicable.

Return to Top

ApplicationRoles

Name Type ReadOnly References FilterOnly Description
Key [KEY] String False No The key of the application role.
Name String False No The display name of the application role.
Groups String False No The groups associated with the application role.
DefaultGroups String False No The groups that are granted default access for this application role.
SelectedByDefault Boolean False No Determines whether this application role should be selected by default on user creation.
NumberOfSeats Integer False No The maximum count of users on your license.
RemainingSeats Integer False No The count of users remaining on your license.
UserCount Integer False No The number of users counting against your license.
UserCountDescription String False No The type of users being counted against your license.
HasUnlimitedSeats Boolean False No Determines whether this application role has unlimited seats.
Platform Boolean False No Indicates if the application role belongs to Jira platform (jira-core).

Return to Top

Attachments

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the attachment.
IssueId [KEY] Integer False Issues.Id No The Id of the issue.
IssueKey String False Issues.Key No The key of the issue.
ProjectId Integer True Projects.Id No The project Id of the attachment's issue.
ProjectName String True No The project name of the attachment's issue.
IssueCreatedDate Datetime False No The date the attachment's issue was created.
IssueUpdatedDate Datetime False No The date the attachment's issue was last updated.
Filename String False No The filename of the attachment.
AuthorName String False No The name of the author of the attachment.
AuthorDisplayName String False Users.DisplayName No The display name of the author of the attachment.
Created Datetime False No The creation date of the attachment.
Size Integer False No The size of the attachment.
MimeType String False No The MIME type of the attachment.
Content String False No The URI of the actual attached file.
Thumbnail String False No The thumbnail of the attachment.
AuthorAccountId String False Users.AccountId No The account Id of the author of the attachment.
AuthorKey String False No The author key of the attachment.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.
FilePath String False Yes The path of the file to insert.
ContentEncoded String False Yes BASE64 encoded content of the file to insert.
Name String False Yes The name of the file to upload. Also the file extension should be specified.

Return to Top

Audit

Name Type ReadOnly References FilterOnly Description
RecordId Integer False No The Id of the audit record.
Summary String False No Summary of the change.
RemoteAddress String False No The remote address of the record.
AuthorKey String False No Key of the author that made the change.
Created Datetime False No Date on when the change was made.
Category String False No Category of the change.
EventSource String False No What triggered the event.
Description String False No Description of the change.
ItemId String False No Unique identifier of the object item.
ItemName String False No Name of the object item.
ItemTypeName String False No Typename of the object item.
ItemParentId String False No Identifier of the parent of the object item.
ItemParentName String False No Parent name of the object item.
FieldName String False No The name of the changed field.
ChangedFrom String False No The updated value.
ChangedTo String False No The previous value.
Filter String False Yes Containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.

Return to Top

BoardConfiguration

Name Type ReadOnly References FilterOnly Description
BoardId [KEY] Integer False Boards.Id No The Id of the board.
ColumnConfig String False No The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues.
Filter String False No Reference to the filter used by the given board.
Name String False No The Name of the board.
CustomFieldIdRank Integer False No The CustomFieldId ranking.
Self String False No The self/url column.
SubQuery String False No JQL subquery used by the given board.
Type String False No The type of the board.
EstimationDisplayName String False No Display name of the field used for estimation.
EstimationFieldId String False No The Id of the field used for estimation.
EstimationType String False No Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is

Return to Top

BoardIssues

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False Issues.Id No The Id of the issue.
Key String False Issues.Key No The key of the issue.
BoardId [KEY] Integer False Boards.Id No The board the issue is included in.
IssueTypeId String False Issuetypes.Id No The issue type Id.
IssueTypeName String False No The issue type name.
StatusId Integer False Statuses.Id No The issue status Id.
StatusName String False No The issue status name.
ProjectId Integer False Projects.Id No The project Id of the issue.
ProjectKey String False Projects.Key No The project key of the issue.
ProjectName String False No The project name of the issue.
ClosedSprintsAggregate String False No The issue's previous sprints that have been closed.
Created Datetime False No The creation date of the issue.
Updated Datetime False No The updated date of the issue.

Return to Top

Boards

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The Id of the board.
Name String False No The name of the board.
Type String False No The type of the board.
ProjectKeyOrId String False Yes Filter the agile boards based on the project they are located in.
FilterId String False Yes ID of a filter that the user has permissions to view. Not supported for next-gen boards.

Return to Top

BoardSprints

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the sprint.
BoardId [KEY] Integer False Boards.Id No The board Id the sprint is in.
Name String False No The name of the sprint.
State String False No The state of the sprint. The sprint state can only transition from 'future' to 'active', and from 'active' to 'close'
Goal String False No The goal assigned for the sprint.
OriginBoardId Integer False Boards.Id No The board Id the sprint originated from. This field cannot be updated
StartDate Datetime False No The date when the sprint was started.
EndDate Datetime False No The date when the sprint has ended.
CompleteDate Datetime True No The date when the sprint was completed.

Return to Top

Comments

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The Id of the comment.
IssueId [KEY] Integer False Issues.Id No The Id of the issue.
IssueKey String False Issues.Key No The key of the issue.
ProjectId Integer True Projects.Id No The project Id of the comment's issue.
ProjectName String True No The project name of the comment's issue.
IssueCreatedDate Datetime True No The date the comment's issue was created.
IssueUpdatedDate Datetime True No The date the comment's issue was last updated.
AuthorDisplayName String True Users.DisplayName No The display name of the author who made the comment.
AuthorEmail String True Users.EmailAddress No The email address of the author who made the comment.
UpdateDisplayName String True Users.DisplayName No The display name of the author who changed the comment.
UpdateAuthorEmail String True Users.EmailAddress No The email address of the author who edited the comment.
Body String False No The body of the comment.
RenderedBody String True No The rendered body of the comment.
Created Datetime True No The date the comment was created.
Updated Datetime True No The date the comment was updated.
VisibilityType String False No The visibility type of the comment.
VisibilityValue String False No The visibility value of the comment.
AuthorAccountName String True No The name of the author who made the comment.
AuthorAccountKey String True No The key of the author who made the comment.
UpdateAuthorAccountKey String True No The Id of the author who edited the comment.
UpdateAuthorAccountName String True No The name of the author who edited the comment.
AuthorAccountId String True Users.AccountId No The name of the author who made the comment.
UpdateAuthorAccountId String True Users.AccountId No The Id of the author who edited the comment.
ItemURL String True No A browsable link of the comment.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

Configuration

Name Type ReadOnly References FilterOnly Description
VotingEnabled Boolean False No Configuration for voting.
WatchingEnabled Boolean False No Configuration for watching.
UnassignedIssuesAllowed Boolean False No Configuration to allow unassigned issues.
SubTasksEnabled Boolean False No Configuration to enable subtasks.
IssueLinkingEnabled Boolean False No Configuration to enable issue linking.
TimeTrackingEnabled Boolean False No Configuration to enable time tracking.
AttachmentsEnabled Boolean False No Configuration to enable attachments.
WorkingHoursPerDay Double False No Configuration of the working hours per day.
WorkingDaysPerWeek Double False No Configuration of the working days per week.
TimeFormat String False No Configuration of the time format.
DefaultUnit String False No Configuration of the default unit.

Return to Top

Dashboards

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the dashboard.
Name String False No The name of the dashboard
View String False No The view URL of the dashboard.
Filter String False Yes This is used to filter data. Valid values include favourite and my.

Return to Top

Epics

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the Epic.
Key [KEY] String False No The key of the Epic.
BoardId [KEY] Integer False Boards.Id No The board Id the Epic is in.
Name String False No The name of the Epic.
Done Boolean False No Whether or not the Epic is done.
ColorKey String False No The key of the Epic's color.
Summary String False No A brief summary for the Epic.

Return to Top

FavouriteFilters

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the favourite filter.
Name String False No The name assigned to the favourite filter.
JQLExpression String False No The JQL by which the favourite filter will search issues by.
Description String False No The description given to the favourite filter.
OwnerDisplayName String False No The display name of the user who owns the favourite filter.
OwnerAccountId String False No The account ID of the user who owns the favourite filter.
Count Integer False No How many users have this filter as a favourite.
OwnerKey String False No The key of the user who owns the favourite filter.

Return to Top

Fields

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the field.
Key String False No The key of the field.
Name String False No The name of the field.
Custom Boolean False No A boolean indicating if the field is custom.
Orderable Boolean False No A boolean indicating if the field is orderable.
Navigable Boolean False No A boolean indicating if the field is navigable.
Searchable Boolean False No A boolean indicating if the field is searchable.

Return to Top

Filters

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the filter.
Name String False No The name assigned to the filter.
JQLExpression String False No The JQL by which the filter will search issues by.
Description String False No The description given to the filter.
OwnerDisplayName String False No The board Id the sprint originated from.
Favourite Boolean False No Whether you have set this filter as a favourite.
FavouritedCount Integer False No How many users have this filter as a favourite.
SubscriptionsAggregate String False No Collection of user subscriptions to the filter .
SharePermissionsAggregate String False No Aggregate of share permissions to the filter.

Return to Top

FiltersUsers

Name Type ReadOnly References FilterOnly Description
AccountId [KEY] String False No The accountId of the user, which uniquely identifies the user across all Atlassian products.
FilterId [KEY] String False Filters.Id No The key of the project.
DisplayName String False No The display name of the user.
EmailAddress String False No The email address of the user.
Active Bool False No Indicates whether the user is active.
TimeZone String False No The time zone specified in the user's profile.
Locale String False No The locale of the user.
AccountType String False No The accountType of the user.

Return to Top

Groups

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the group.
Name String False No The name of the group.
Html String False No The HTML of the group.
LabelsAggregate String False No The labels of the group.

Return to Top

GroupsUsers

Name Type ReadOnly References FilterOnly Description
AccountId [KEY] String False No The accountId of the user, which uniquely identifies the user across all Atlassian products.
Key [KEY] String False No The key of the user.
GroupId [KEY] String False No The group Id the user is part of.
GroupName [KEY] String False No The group name the user is part of.
Name String False No The name of the user.
DisplayName String False No The display name of the user.
EmailAddress String False No The email address of the user.
Active Bool False No Indicates whether the user is active.
TimeZone String False No The time zone specified in the user's profile.
Locale String False No The locale of the user.
AccountType String False No The accountType of the user.
Products String False No A delimited string of jira products to which the user has access to, ex: jira-core,jira-servicedesk,jira-product-discovery,jira-software

Return to Top

IssueAffectedVersions

Name Type ReadOnly References FilterOnly Description
VersionId [KEY] String False No The Id of the affected version.
IssueId [KEY] Integer False Issues.Id No The issue Id of the affected version.
IssueKey String False Issues.Key No The issue key of the affected version.
IssueCreatedDate Datetime False No The date the affected version's issue was created.
IssueUpdatedDate Datetime False No The date the affected version's issue was last updated.
Name String False No The name of the affected version.
Archived Boolean False No A boolean indicating if the affected is archived.
Released Boolean False No A boolean indicating if the affected is released.
ReleaseDate Date False No The release date.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueChangelogs

Name Type ReadOnly References FilterOnly Description
HistoryId Integer False No The Id of the change.
IssueId Integer False Issues.Id No The Id of the issue.
IssueKey String False Issues.Key No The key of the issue.
Created Datetime False No The creation date of the change.
IssueCreatedDate Datetime False No The date the change's issue was created.
IssueUpdatedDate Datetime False No The date the change's issue was last updated.
ItemField String False No The item field of the change.
ItemFieldType String False No The item field type of the change.
ItemFrom String False No The item the issue changed from.
ItemFromString String False No The description of the item the issue changed from.
ItemTo String False No The item the issue changed to.
ItemToString String False No The description of the item the issue changed to.
AuthorDisplayName String False No The display name of the author who has updated the change.
AuthorAccountId String False No The author name of the change.
AuthorName String False No The author name of the change.
AuthorAccountKey String False No The key of the author of the change.
AuthorAccountName String False No The name of the author who has updated the change.
ProjectId Integer False Projects.Id No The project Id of the issue.
ProjectKey String False Projects.Key No The project key of the issue.
ProjectName String False No The project name of the issue.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueComponents

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the component.
Name String False No The name of the component.
IssueId [KEY] Integer False Issues.Id No The issue Id of the component.
IssueKey String False Issues.Key No The issue key of the component.
IssueCreatedDate Datetime False No The date the component's issue was created.
IssueUpdatedDate Datetime False No The date the component's issue was last updated.
Description String False No The description of the component.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueCustomFieldOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The ID of the custom field option.
CustomFieldId Long False IssueCustomFields.CustomId No The ID of the custom field.
Name String False No The name of the custom field option.

Return to Top

IssueCustomFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the custom field.
Key String False No The key of the custom field.
CustomId Long False No The custom ID of the field.
Name String False No The name of the custom field.
CDataName String False No The name of the custom field on the Issues table provided by CData, when IncludeCustomFields=true
Orderable Boolean False No A boolean indicating if the field is orderable.
Navigable Boolean False No A boolean indicating if the field is navigable.
Searchable Boolean False No A boolean indicating if the field is searchable.

Return to Top

IssueFixVersions

Name Type ReadOnly References FilterOnly Description
VersionId [KEY] String False No The Id of the fix version.
IssueId [KEY] Integer False Issues.Id No The issue Id of the fix version.
IssueKey String False Issues.Key No The issue key of the fix version.
IssueCreatedDate Datetime False No The date the fix version's issue was created.
IssueUpdatedDate Datetime False No The date the fix version's issue was last updated.
Name String False No The name of the fix version.
Archived Boolean False No A boolean indicating if the fix is archived.
Released Boolean False No A boolean indicating if the fix is released.
ReleaseDate Datetime False No The release date.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueLinks

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the link.
InwardIssueId Integer False Issues.Id No The Id of the issue targeting this issue in the link.
InwardIssueKey String False Issues.Key No The Key of the issue targeting this issue in the link.
OutWardIssueId Integer False Issues.Id No The Id of the issue this link is targeting.
OutwardIssueKey String False Issues.Key No The Key of the issue this link is targeting.
IssueId [KEY] Integer False Issues.Id No The link's original issue Id.
IssueKey String False Issues.Key No The link's original issue Key.
IssueCreatedDate Datetime False No The date the link's issue was created.
IssueUpdatedDate Datetime False No The date the links's issue was last updated.
TypeId Id False No The Id of the link type.
TypeName String False No The Name of the link type.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueLinkTypes

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No Unique identifier of the issue link type.
Name String False No The name of the issue link type.
Inward String False No The description of the issue link type inward link.
Outward String False No The description of the issue link type outward link.

Return to Top

IssueNavigatorDefaultColumns

Name Type ReadOnly References FilterOnly Description
Label String False No The issue navigator column label.
Value String False No The issue navigator column value.

Return to Top

IssuePriorities

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The ID of the issue priority.
Name String False No The name of the issue priority.
Description String False No The description of the issue priority.
URL String False No The URL of the issue priority.
StatusColor String False No The color used to indicate the issue priority.
IconUrl String False No The URL of the icon for the issue priority.

Return to Top

IssueResolutions

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The ID of the issue resolution.
Name String False No The name of the issue resolution.
Description String False No The description of the issue resolution.
URL String False No The URL of the issue resolution.

Return to Top

Issues

Name Type ReadOnly References FilterOnly Description
Id [KEY] Int True No The Id of the issue.
Key String True No The key of the issue.
IssueTypeId String False No The issue type Id.
IssueTypeName String True No The issue type name.
ProjectId String False No The project Id of the issue.
ProjectName String True No The project name of the issue.
ProjectKey String False No The project key of the issue.
ParentId Int False No The Id of the issue's parent if the issue is a subtask.
ParentKey String True No The key of the issue's parent if the issue is a subtask.
ParentIssueTypeId String True No The issue type id of the issue's parent.
ParentIssueTypeName String True No The issue type name of the issue's parent.
ParentStatusId String True No The status id of the issue's parent.
ParentStatusName String True No The status name of the issue's parent.
ResolutionId String True No The resolution Id of the issue.
ResolutionName String True No The resolution name of the issue.
ResolutionDescription String True No The resolution description of the issue.
ResolutionDate Datetime True No The resolution date of the issue.
Workratio Long True No The work ratio of the issue.
LastViewed Datetime True No The last time that the issue was viewed.
WatchCount Int True No The number of watches of the issue.
IsWatching Bool True No Whether the currently authenticated user is watching the issue.
Created Datetime True No The creation date of the issue.
PriorityId String False No The priority Id of the issue.
PriorityName String True No The priority name of the issue.
TimeSpentSeconds Long True No The time spent in seconds on the issue.
TimeSpent String True No The time spent on the issue.
RemainingEstimateSeconds Long True No The time estimate in seconds of the issue.
RemainingEstimate String False No The time estimate of the issue.
OriginalEstimateSeconds Long True No The original time estimate in seconds of the issue.
OriginalEstimate String False No The original time estimate of the issue.
AggregateTimeSpent Long True No The aggregate time spent of the issue.
AggregateTimeOriginalEstimate Long True No The original aggregate time estimate of the issue.
AggregateTimeEstimate Long True No The aggregate time estimate of the issue.
AssigneeDisplayName String True No Assignee display name.
AssigneeKey String True No [DEPRECATED] The assignee key of the issue.
AssigneeAccountId String False No The assignee account id.
AssigneeName String False No The assignee name of the issue.
AssigneeEmail String True No The assignee email of the issue.
Updated Datetime True No The updated date of the issue.
StatusId String True No The status Id of the issue.
StatusName String True No The status name of the issue.
StatusCategoryId String True No The status category id of the issue.
StatusCategoryKey String True No The status category key of the issue.
StatusCategoryName String True No The status category name of the issue.
Description String False No The description of the issue.
Summary String False No The summary of the issue.
CreatorDisplayName String True No Issue creator display name.
CreatorName String True No The creator name of the issue.
CreatorAccountId String True No The creator account id.
CreatorKey String True No [DEPRECATED] The creator key of the issue.
CreatorEmail String True No The creator email of the issue.
ReporterDisplayName String True No Issue reporter display name.
ReporterName String False No The reporter name of the issue.
ReporterKey String True No [DEPRECATED]The reporter key of the issue.
ReporterAccountId String False No The reporter account id.
ReporterEmail String True No The reporter email of the issue.
AggregateProgress Long True No The aggregate progress of the issue.
TotalProgress Long True No The aggregate total progress of the issue.
Votes Int True No Votes of the issue.
HasVotes Bool True No The vote status of the issue.
DueDate Date False No The due date of the issue.
Labels String False No The labels of an issue.
Environment String False No The environment of an issue.
SecurityLevel String False No The security level of an issue.
FixVersionsAggregate String False No The fix versions of the issue
ComponentsAggregate String False No Aggregate list of components included in the issue.
IssueLinksAggregate String False No The issue links of the issue.
AffectedVersionsAggregate String False No The affected versions of the issue.
SubtasksAggregate String True No The subtasks of the issue.
ItemURL String True No A browsable link of the issue.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.
Attachments String False Yes Search for issues that have or do not have attachments. This column can be queried with IS EMPTY or IS NOT EMPTY.
Comment String False Yes Search for issues that have a comment that contains particular text.
Category String False Yes Search for issues that belong to projects in a particular category.
SprintId Integer False Yes Search for issues that belongs to a specific sprint, by specifying the Id of the Sprint.
SprintName String False Yes Search for issues that belongs to a specific sprint, by specifying the name of the Sprint.
Filter String False Yes Search for issues of saved filters. This column can be queried with filter name or filter id.

Return to Top

IssueSecurityLevelMembers

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The ID of the issue security level member.
IssueSecurityLevelId String False No The ID of the issue security level.
IssueSecuritySchemeId String False No The ID of the issue security scheme.
HolderParameter String False No As a group's name can change, use of value is recommended. The identifier associated with the type value that defines the holder of the permission.
HolderType String False No The type of the permission holder.
HolderValue String False No The identifier associated with the type value that defines the holder of the permission.

Return to Top

IssueSubtasks

Name Type ReadOnly References FilterOnly Description
SubtaskId [KEY] String False No The Id of the subtask.
SubtaskKey String False No The key of the subtask.
IssueId Integer False Issues.Id No The Id of the parent issue.
IssueKey String False Issues.Key No The key of the parent issue.
IssueCreatedDate Datetime False No The date the subtask's issue was created.
IssueUpdatedDate Datetime False No The date the subtask's issue was last updated.
Summary String False No The summary of the subtask.
TypeId String False IssueTypes.Id No The issue type Id of the subtask.
TypeName String False IssueTypes.Name No The issue type name of the subtask.
TypeDescription String False IssueTypes.Description No The issue type description of the subtask.
TypeSubtask Boolean False IssueTypes.Subtask No A boolean indicating if the issue is a subtask.
PriorityId String False No The priority Id of the subtask.
PriorityName String False No The priority name of the subtask.
StatusId String False No The status Id of the subtask.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueTransitions

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the transition.
IssueId [KEY] Integer False Issues.Id No The Id of the issue.
IssueKey String False Issues.Key No The key of the issue.
IssueCreatedDate Datetime False No The date the transition's issue was created.
IssueUpdatedDate Datetime False No The date the transition's issue was last updated.
HasScreen String False No Whether the transition has a screen.
Name String False No The name of the transition.
ToDescription String False No The description of the status the issue is transitioning to.
ToId String False No The Id of the status the issue is transitioning to.
ToName String False No The name of the status the issue is transitioning to.
StatusCategoryId String False No The status category Id of the transition.
StatusCategoryKey String False No The status category key of the transition.
StatusCategoryName String False No The status category name of the transition.
JQL String False Yes JQL (Jira Query Language) allows you to build structured queries.

Return to Top

IssueTypes

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No The Id of the issue type.
Name String False No The name of the issue type.
Description String False No The description of the issue type.
Subtask Boolean False No The subtask of the issue type. Not applicable for update.
IconUrl String True No The icon URL of the issue type.

Return to Top

MyPermissions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the permission.
Key [KEY] String False No The key of the permission.
Name String False No The name of the permission.
Type String False No The type of the permission.
Description String False No The description of the permission.
HavePermission Boolean False No Boolean indicating if the permission is set or not.
DeprecatedKey Boolean False No Boolean indicating if the permission is deprecated.
Permissions String False No Permissions as comma seperated values.
ProjectKey String False Yes The key of the project associated with the permission.
ProjectId String False Yes The Id of the project associated with the permission.
IssueKey String False Yes The key of the issue associated with the permission.
IssueId String False Yes The Id of the issue associated with the permission.

Return to Top

PermissionGrants

Name Type ReadOnly References FilterOnly Description
PermissionSchemeId [KEY] String False PermissionSchemes.Id No The ID of the permission scheme.
Id [KEY] String False No The ID of the permission granted details.
Permission String False No The permission to grant.
HolderParameter String False No As a group's name can change, use of value is recommended. The identifier associated with the type value that defines the holder of the permission.
HolderType String False No The type of the permission holder.
HolderValue String False No The identifier associated with the type value that defines the holder of the permission.

Return to Top

Permissions

Name Type ReadOnly References FilterOnly Description
Key [KEY] String False No The key of the permission.
Name String False No The name of the permission.
Type String False No The type of the permission.
Description String False No The description of the permission.

Return to Top

PermissionSchemes

Name Type ReadOnly References FilterOnly Description
Id String False No The ID of the permission scheme.
Name String False No The name of the permission scheme.
Description String False No A description for the permission scheme.
ScopeType String False No The type of the scope.
ScopeProjectId String False No The id of the project the item has scope in.

Return to Top

ProjectCategories

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No Unique identifier of the project category.
Name String False No Name of the project category.
Description String False No Description of the project category.
Link String False No Link to this project category.

Return to Top

ProjectComponents

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The Id of the component.
ProjectId Integer True Projects.Id No The selected project's id.
ProjectKey String False No The selected project's key.
Name String False No The name of the component.
Description String False No The description of the component.
LeadDisplayName String True No The display name of the component's lead.
LeadKey String False No The key of the component's lead.
AssigneeType String False No The type of the component's default assignee.
AssigneeDisplayName String True No The display name of the component's default assignee.
AssigneeKey String True No The key of the component's default assignee.
IsAssigneeTypeValid Boolean True No Whether the assignee type is valid.

Return to Top

ProjectRoleActors

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The ID of the role actor.
DisplayName String False No The display name of the role actor. For users, depending on the user?s privacy setting, this may return an alternative value for the user's name.
Type String False No The type of role actor.
Name String False No The name of the role.
AvatarUrl String False No The avatar of the role actor.
ActorUserAccountId String False No Details of the user associated with the role. The account ID of the user, which uniquely identifies the user across all Atlassian products.
ActorGroupName String False No Details of the group associated with the role. The name of the group. As a group's name can change, use of groupId is recommended to identify the group.
ActorGroupDisplayName String False No Details of the group associated with the role. The display name of the group.
ActorGroupGroupId String False No Details of the group associated with the role. The ID of the group.
RoleId Long False Roles.Id No The Id of the role.
ProjectId Integer False Projects.Id No The Id of the project associated with the role.
ProjectKey String False Projects.Key No The key of the project associated with the role.
UserName String False Yes Server platform only. Input for Insert and Delete statements. Details of the user associated with the role. The name of the user.
GroupName String False Yes Server platform only. Input for Insert and Delete statements. Details of the group associated with the role. The name of the group.

Return to Top

ProjectRoles

Name Type ReadOnly References FilterOnly Description
RoleId [KEY] Long False Roles.Id No The Id of the role.
RoleName String False Roles.Name No The name of the role.
ProjectId [KEY] Integer False Projects.Id No The Id of the project associated with the role.
ProjectKey [KEY] String False Projects.Key No The key of the project associated with the role.

Return to Top

Projects

Name Type ReadOnly References FilterOnly Description
Id [KEY] Int True No The Id of the project.
Key String False No The key of the project.
Name String False No The name of the project.
Description String False No The description of the project.
LeadEmailAddress String True Users.EmailAddress No The email address of the project lead.
LeadDisplayName String True Users.DisplayName No The display name of the project lead.
ComponentsAggregate String True No The components of the project.
IssueTypesAggregate String True No The issue types of the project.
Url String True No The URL of the project.
Email String True No The email of the project.
AssigneeType String False No The assignee type of the project.
VersionsAggregate String True No The versions of the project.
RolesAggregate String True No The roles of the project.
ProjectKeysAggregate String True No The project keys of the project.
ProjectCategoryId String False No The Id of the project category.
ProjectCategoryName String True No The name of the project category.
ProjectCategoryDescription String True No The description of the project category.
ProjectTypeKey String False No The key of the project type. Not applicable for update.
LeadAccountId String False Users.AccountId No The Id of the project lead.
LeadAccountKey String True Users.Key No The Key of the project lead.
LeadAccountName String False Users.Name No The user name of the project lead.
Simplified Boolean True No Whether the project is team-managed or not.
ItemURL String True No A browsable link of the project.

Return to Top

ProjectsIssueTypes

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the issue type.
ProjectId [KEY] Int False Projects.Id No The Id of the project.
ProjectName String False Projects.Name No The name of the project
Name String False No The name of the issue type.
Description String False No The description of the issue type.
Subtask Boolean False No The subtask of the issue type. Not applicable for update.
IconUrl String False No The icon URL of the issue type.
AvatarId String False No The id of the avatar

Return to Top

ProjectsPermissionScheme

Name Type ReadOnly References FilterOnly Description
ProjectId Int64 False No The project ID.
ProjectKey String False No The project key.
Id String False No The ID of the permission scheme.
Name String False No The name of the permission scheme.
Description String False No The description of the permission scheme.

Return to Top

ProjectTypes

Name Type ReadOnly References FilterOnly Description
Key [KEY] String False No The key of the project type.
DescriptionKey String False No The key of the project type's description.
Icon String False No The icon of the project type.
Color String False No The color of the project type.

Return to Top

ProjectVersions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The Id of the version.
ProjectId Integer False Projects.Id No The selected project's id.
ProjectKey String False No The selected project's key.
Name String False No The name of the version.
Description String False No The description of the version.
Released Boolean False No Whether the version has been released.
ReleaseDate Date False No Release date of the version.
StartDate Date False No Optional start date of the version.
UserStartDate Date False No The date on which work on this version is expected to start.
UserReleaseDate Date False No The date on which work on this version is expected to finish.
Overdue Boolean True No Whether the version is overdue for release.
Archived Boolean False No Whether the version has been archived. When a new version is created, this field is always set to False.

Return to Top

RoleActors

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The ID of the role actor.
DisplayName String False No The display name of the role actor. For users, depending on the user?s privacy setting, this may return an alternative value for the user's name.
Type String False No The type of role actor.
AvatarUrl String False No The avatar of the role actor.
ActorUserAccountId String False Users.AccountId No Details of the user associated with the role. The account ID of the user, which uniquely identifies the user across all Atlassian products.
ActorGroupName String False Groups.Name No Details of the group associated with the role. The name of the group. As a group's name can change, use of groupId is recommended to identify the group.
ActorGroupDisplayName String False No Details of the group associated with the role. The display name of the group.
ActorGroupGroupId String False Groups.Id No Details of the group associated with the role. The ID of the group.
Name String False No The name of the role.
RoleId Long False Roles.Id No The Id of the role.
UserKey String False Yes Server platform only. Input for Insert and Delete statements. Details of the user associated with the role. The key of the user.
GroupName String False Yes Server platform only. Input for Insert and Delete statements. Details of the group associated with the role. The name of the group.

Return to Top

Roles

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The Id of the role.
Name String False No The name of the role.
Description String False No The description of the role.
Actors String False No The list of users who act in this role.
Scope String False No The scope of the role.
IsAdmin Boolean False No Whether this role is the admin role for the project.
IsDefault Boolean False No Whether this role is the default role for the project.

Return to Top

SecurityLevels

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The ID of the issue level security item.
SecuritySchemeId Long False SecuritySchemes.Id No Link to this security level.
Name String False No The name of the issue level security item.
Description String False No The description of the issue level security item.

Return to Top

SecuritySchemes

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The ID of the issue security scheme.
Name String False No The name of the issue security scheme.
Description String False No The description of the issue security scheme.
DefaultSecurityLevelId Long False No The ID of the default security level.

Return to Top

SprintIssues

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False Issues.Id No The Id of the issue.
Key String False Issues.Key No The key of the issue.
SprintId [KEY] Integer False Sprints.Id No The sprint the issue is assigned to.
IssueTypeId String False Issuetypes.Id No The issue type Id.
IssueTypeName String False No The issue type name.
StatusId Integer False Statuses.Id No The issue status Id.
StatusName String False No The issue status name.
ProjectId Integer False Projects.Id No The project Id of the issue.
ProjectKey String False Projects.Key No The project key of the issue.
ProjectName String False No The project name of the issue.
ClosedSprintsAggregate String False No The issue's previous sprints that have been closed.
Created Datetime False No The creation date of the issue.
Updated Datetime False No The updated date of the issue.

Return to Top

Sprints

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The Id of the sprint.
Name String False No The name of the sprint.
State String False No The state of the sprint. A newly created sprint starts in the 'future' state. The state can only transition from 'future' to 'active', and from 'active' to 'closed'
Goal String False No The goal assigned for the sprint.
OriginBoardId Integer False Boards.Id No The board Id the sprint originated from. This field cannot be updated
StartDate Datetime False No The date when the sprint was started.
EndDate Datetime False No The date when the sprint has ended.
CompleteDate Datetime True No The date when the sprint was completed.

Return to Top

Statuses

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer False No The Id of the status.
Name String False No The name of the status.
Description String False No The description of the status.
CategoryId Integer False No The Category Id of the status.
CategoryKey String False No The Category Key of the status.

Return to Top

TimeTrackingProviders

Name Type ReadOnly References FilterOnly Description
Key [KEY] String False No The key for the time tracking provider. For example, Jira.
Name String False No The name of the time tracking provider. For example, Jira provided time tracking.
URL String False No The URL of the configuration page for the time tracking provider app. For example, /example/config/url. This property is only returned if the adminPageKey property is set in the module descriptor of the time tracking provider app.

Return to Top

Users

Name Type ReadOnly References FilterOnly Description
GroupName String True No The name of the group the user is part of.
GroupId String True No The Id of the group the user is part of.
DisplayName String False No The display name of the user.
EmailAddress String False No The email address of the user.
Active Bool True No Indicates whether the user is active.
TimeZone String True No The time zone specified in the user's profile.
Locale String True No The locale of the user.
AccountId [KEY] String True No The accountId of the user, which uniquely identifies the user across all Atlassian products.
AccountType String False No The accountType of the user.
Products String False No A delimited string of jira products to which the user has access to, ex: jira-core,jira-servicedesk,jira-product-discovery,jira-software
Key [KEY] String True No The key of the user.
Name String False No The name of the user.
IssueKey String False Yes Search for users who can browse a specific issue.
ProjectKey String False Yes Search for users who can browse any issue in a project.

Return to Top

Votes

Name Type ReadOnly References FilterOnly Description
DisplayName String False No The display name of the vote.
Active Boolean False No Boolean indicating if the vote is active.
AccountId String False No The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
IssueId String False No The issue Id of the vote.
IssueKey String False No The issue key of the vote.

Return to Top

Watchers

Name Type ReadOnly References FilterOnly Description
DisplayName String False No The displayed name of the watcher.
EmailAddress String False No The email address of the watcher.
AccountId [KEY] String False No The accountId of the watcher.
Key [KEY] String False No The key of the watcher.
Name String False No The name of the watcher.
IssueId String False No The issue Id of the watcher.
IssueKey String False No The issue key of the watcher.

Return to Top

Workflows

Name Type ReadOnly References FilterOnly Description
Id String False No The entity ID of the workflow.
Name String False No The name of the workflow.
Description String False No The description of the workflow.
Created String False No The date when the workflow was created.
Updated String False No The date when the workflow was updated.
IsDefault Boolean False No Boolean indicating if the workflow is set as the default.
CanDelete Boolean False No Boolean indicating whether the workflow can be deleted.
CanEdit Boolean False No Boolean indicating whether the workflow can be edited.
IsActive Boolean False No Filters active and inactive workflows.
Query String False No String used to perform a case-insensitive partial match with workflow name.
Scope String False No A JSON aggregate outlining the scope of the workflow. This column used exclusively for inserting to and updating workflows (does not return in SELECT query results).
Statuses String False No A JSON aggregate outlining the statuses to associate with the workflows. This column used exclusively for inserting to and updating workflows (does not return in SELECT query results).
Workflows String False No The details of the workflows to create. This column used exclusively for inserting to and updating workflows (does not return in SELECT query results).

Return to Top

WorkflowSchemes

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The ID of the workflow scheme.
Name String False No The name of the workflow scheme.
Description String False No The description of the workflow scheme.
IssueTypeMappingsAggregate String False No The issue type to workflow mappings aggregate, where each mapping is an issue type ID and workflow name pair.
DefaultWorkflow String False No The name of the default workflow for the workflow scheme.
Self String True No The self/url column.

Return to Top

WorkflowStatusCategories

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The ID of the status category.
Key String False No The key of the status category.
Name String False No The name of the status category.
ColorName String False No The name of the color used to represent the status category.
URL String False No The URL of the status category.

Return to Top

WorkflowStatuses

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The ID of the status.
StatusCategoryId Long False WorkflowStatusCategories.Id No The ID of the status category.
Name String False No The name of the status.
Description String False No The description of the status.
URL String False No The description of the status.
IconUrl String False No The URL of the icon used to represent the status.

Return to Top

WorklogDeleted

Name Type ReadOnly References FilterOnly Description
Id String False No The Id of the audit record.
Updated Datetime False No The date on when the change was made.
Properties String False No The properties of the deleted Worklog.

Return to Top

Worklogs

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No The Id of the worklog.
IssueId [KEY] Integer False Issues.Id No The issue Id of the worklog.
IssueKey String False Issues.Key No The key of the issue.
ProjectId Integer True Projects.Id No The project Id of the worklog's issue.
ProjectName String True No The project name of the worklog's issue.
IssueCreatedDate Datetime True No The date the worklogs's issue was created.
IssueUpdatedDate Datetime True No The date the worklogs's issue was last updated.
AuthorDisplayName String True Users.DisplayName No The display name of the author of the worklog.
UpdateAuthorDisplayName String True Users.DisplayName No The display name of the author who has updated the worklog.
Comment String False No The comment of the worklog.
Created Datetime True No The date the worklog was created.
Updated Datetime True No The update date of the worklog.
VisibilityType String False No The visibility type of the worklog.
VisibilityValue String False No The visibility value of the worklog.
Started Datetime False No The start date of the worklog.
TimeSpent String False No The spent time of the worklog.
TimeSpentSeconds Long False No The time spent in seconds for the worklog.
AuthorAccountId String True Users.AccountId No The name of the author of the worklog.
UpdateAuthorAccountId String True Users.AccountId No The name of the author who has updated the worklog.
AuthorAccountKey String True Users.Key No The key of the author of the worklog.
AuthorAccountName String True Users.Name No The name of the author of the worklog.
UpdateAuthorAccountKey String True Users.Key No The key of the author who has updated the worklog.
UpdateAuthorAccountName String True Users.Name No The name of the author who has updated the worklog.
ItemURL String True No A browsable link of the worklog.

Return to Top