Jira Work Management Fields Reference
Field Name | Field ID | Field Type | Field Explanation | Example |
Issues |
| |||
Issue ID | Id | Int64 | Issue ID is the internal ID of the Jira issue which is internally used in Jira database to refer to an issue. This is the unique ID for a Jira issue and does not change. The fastest way to view the issue id — is to mouse-over the Edit button on the Issue page, that you wanted to view the issue id, and you can view the issue id at the bottom of browser as shown in the screenshot. | |
Issue Key | ISSUE_KEY | String | Issue Key is a unique identifier which assigned to an issue when it is added or registered in Backlog. | |
Issue Type Id | ISSUE_TYPE_ID | Int64 | Issue types distinguish different types of work in unique ways, and help you identify, categorize, and report on your team’s work and to build more structure into your working process. Here's a list of the default issue types that come with each Jira product: Task, Subtask, Epic, Bug, Story. Issue Type Id is a numeric code which uniquely identifies an issue type. To view the issue type id — hover your mouse cursor over the Edit operation link of an issue type in the Issues section on the Issue Types page in the Administration menu. | |
Issue Type Name | ISSUE_CURRENT_TYPE_NAME | String | Issue Type Name is an identifying name of the Issue Type (Task, Subtask, Epic, Bug, Story). Besides default issue types you have an opportunity to create your own ones, by clicking on the Add Issue Type button in the Issues field of Administration menu. | |
Resolved | ISSUE_RESOLVED | DateTimeOffset | The resolved date equals to the date, when you set the Resolution field for the issue. You can not modify this field. | |
Resolution | ISSUE_RESOLUTION | String | The Resolution field is an indicator of that the lifecycle of an issue has come to an end. It specifies the reason an issue is closed. |
|
Due Date | ISSUE_DUE_DATE | DateTimeOffset | Due date is a desired date requested by initiator (e.g. project team requests to execute something by X due date). | |
Description | ISSUE_DESCRIPTION | String | Description is a field that contains, literally, the description of the issue. | |
Current Status Id | ISSUE_CURRENT_STATUS_ID | String | Current Status Id is a numeric code that uniquely identifies issue workflow status applicable to the issue right now.
| |
Current Status Name | ISSUE_CURRENT_STATUS_NAME | String | Issue Status Name(1) is an indicator of issue’s current place in the project's workflow(Open, In Progress, Reopened, Resolved, Closed, To Do, Done). Besides default issue types you have an opportunity to create your own ones, by clicking on the Add Issue Type button in the Issues field of Administration menu. |
|
Current Status Category Name | ISSUE_CURRENT_STATUS_CATEGORY_NAME | String | The Status Category Name(2) represented on a Status are reflective of the Status Category and allows for a team to have the most clear description of current issues statuses. You can find a Status panel on the Issues page in Administration menu. | |
Status Changed Date | ISSUE_STATUS_CHANGE_DATE | DateTimeOffset | The Status Changed Date is an indicator of the last time the issue moved from one status in one category to another.
| |
Current Assignee ID | ISSUE_CURRENT_ASSIGNEE_ID | Int64 | Current Assignee Id is a person who has the responsibility either to resolve the issue, or to take the next action. Id is a numeric character code which you can find in your BI account' oData tables. |
|
Current Assignee Name
| ISSUE_CURRENT_ASSIGNEE_NAME
| String | Current Assignee Name is a full name of assignee in Jira.
| |
Current Assignee Key | ISSUE_CURRENT_ASSIGNEE_KEY | String | Current Assignee Key is a username of assignee, via they log in to Jira. You can find it in user’s profile by hovering the mouse on the Assignee name and then choosing the Profile field in the popup menu. | |
Reporter ID | ISSUE_REPORTER_ID | Int64 | The Reporter is a field that you can set during the creation of the issue. Basically it is the one that wants something to be done. The default value will be the person who is creating the issue. Id is a numeric character code which you can find in your BI account' oData tables. | |
Reporter Name | ISSUE_REPORTER_NAME | String | The Reporter Name is a name of the person that is raising the issue. The reporter will be updated on all changes that happens to the issue they have reported. | |
Reporter Key | ISSUE_REPORTER_KEY | String | Reporter Key is a username of the person, via they log in to Jira. You can find it in user’s profile by hovering the mouse on the Reporter name and then choosing the Profile field in the popup menu. | |
Creator ID | ISSUE_CREATOR_ID | Int64 | The Creator is the person who created the issue. Id is a numeric character code which you can find in your BI account' oData tables. |
|
Creator Name | ISSUE_CREATOR_NAME | String | The Creator Name is a name of the person who created the issue. You can find it in Search for Issues page. | |
Creator Key | ISSUE_CREATOR_KEY | String | Creator Key is a username of the person, via they log in to Jira. You can find it in user’s profile by clicking on the Creator name. | |
Project Id | ISSUE_PROJECT_ID | Int64 | Project Id is an alphanumeric character code, based on the passed project and version name. You can find it in a few steps:
| |
Project Key | ISSUE_PROJECT_NAME | String | Project key is the prefix of the issue number, based on your project name, that describe to people across your Jira site that some issues are related to your project. | |
Priority | ISSUE_PRIORITY | String | Priority is a relative importance of an issue in relation to other issues for the team, so it helps your users determine which issues should be tackled first. Divided into: Highest, High, Medium, Low, Lowest. |
|
Security Level | ISSUE_SECURITY_LEVEL | Int64 | Issue Level Security allows for even more granular access to a projects issues. You can assign Roles, Custom Field Values, Project Roles, and Groups. This level is helpful for a Security, Business, or HR related project. Issue Security Level is set within the Issue security schemes in the Administration panel. | |
Created | ISSUE_CREATED | DateTimeOffset | Created is a field that shows the time of the issue creation. | |
Updated | ISSUE_UPDATED |
| Created is a field that shows the time when changes were made to the issue last time. | |
Last Viewed | ISSUE_LAST_VIEWED | DateTimeOffset | Search for issues that were last viewed on, before, or after a particular date (or date range). Note that the search results will be relative to your configured time zone (which is by default the Jira server's time zone). You can find it in Search for issues page. | |
Environment | ISSUE_ENVIRONMENT | String | The hardware or software environment to which the issue is related. | |
Summary | ISSUE_SUMMARY | String | A Summary is a short phrase to give you an idea of what the issue is about. | |
Time at Current Assignee in hours | ISSUE_TIME_WITH_CURRENT_ASSIGNEE_HOURS | Double | Time at Current Assignee are an indicators which represent, how much time/date an issue was present with the current assignee. Time in hours can be retrieved from the Time in Status section Time in days can be retrieved from the Time With Assignee section You can find them in your BI account' oData tables. | |
Time at Current Assignee in days, decimal | ISSUE_TIME_WITH_CURRENT_ASSIGNEE_DAYS | Double | ||
Time at Current Assignee in days, rounded | ISSUE_TIME_WITH_CURRENT_ASSIGNEE_DAYS_ROUNDED | Int64 | ||
Watchers | ISSUE_WATCHERS | Int64 | Watchers is a number, shown how many people have signed up for notifications of any updates relating to a particular issue. |
|
Votes | ISSUE_VOTES | Int64 | Votes is the number of "voicing", indicates how many users communicate that a particular issue is important. |
|
Work Ratio | ISSUE_WORK_RATIO | Double | Work Ratio is a percentage time tracking field which calculated Ratio of total work done to the total amount of work. You can find it in Search for issues page. If it is not there, select the Progress item in the Columns drop-down menu. | |
Issue Comment | ISSUE_COMMENT | String | Issue Comment is a field at the bottom of the issue page of updates, that let watchers know what's happening on the issue, to code snippets, images, tables, and more. The editor converts things like links, code, and markdown on-the-fly, so you can paste in your content and let the editor do the work. | |
Issue Effort |
| |||
Time Spent | ISSUE_TIME_SPENT | Double | Time Spent is a field that records the time you spend working on a current issue. You can enable this function by going to Administration Settings > Issues > Issue Features > Time tracking field. | |
Time Spent Including Sub-Tasks | ISSUE_TIME_SPENT_WITH_ST | Double | This is a possibility to view the time, person spent on a current issue, including sub tasks linked to it. Note that for this feature to work, the sub task must have its own estimate. | |
Original Estimate | ISSUE_ORIGINAL_ESTIMATE | Double | Original Estimate is a preliminary estimate of the total amount of time the person plans to complete a current issue in. It may include also an estimate for sub tasks. By default, this is specified in minutes, but you can use hours, days, or weeks, depending on your Jira system configuration. | |
Original Estimate Including Sub-Tasks | ISSUE_ORIGINAL_ESTIMATE_WITH_ST | Double | ||
Remaining Estimate | ISSUE_REMAINING_ESTIMATE | Double | Remaining Estimate is the remaining amount of time it would take to complete this issue. It may include also an estimate for sub tasks. | |
Remaining Estimate Including Sub-Tasks | ISSUE_REMAINING_ESTIMATE_WITH_ST | Double | ||
Issue Worklogs |
| |||
Worklog Issue Key / Issue Key | WORKLOG_KEY | String | Worklog Issue Key is an identifier of an issue the time was logged for. | |
Name | WORKLOG_NAME | String | Worklog Name is a name of a person who logged time on a current issue page. | |
User ID | WORKLOG_USER_ID | Int64 | Worklog User ID is a numeric character code of a person who logged time on a current issue page. You can find in your BI account' oData tables. | |
User Key | WORKLOG_USERKEY | String | Worklog User Key is a randomly generated identifier of the user, which doesn’t contain any personal information for on the one hand — to comply the GDPR, and on the other hand — to give an Administrator the opportunity to track the time that a particular user, who changed his username, has logged. In older versions of Jira, the key and username have the same value. You can find User Key in your BI account' oData tables. |
|
Date / Start Date | WORKLOG_WORKLOG_DATE | DateTimeOffset | Worklog Start Date is the point in time, when user started current unit of work. | |
Description | WORKLOG_DESCRIPTION | String | Worklog Description is a description related to the achieved work. | |
Creation Date / Created | WORKLOG_CREATION_DATE | DateTimeOffset | Worklog Creation Date is a time when achieved part of work was logged. | |
Logged Time | WORKLOG_LOGGED_TIME | Int64 | Logged Time is the amount of time spent on the issue. | |
Issue Id | WORKLOG_ISSUE_ID | Int64 | Worklog Issue Id is the internal ID of the logged issue which is internally used in Jira database to refer to the current log in the general worklog. The fastest way to view it — is to mouse-over the Edit icon on the Logged work field. | |
User is Active | WORKLOG_USER_IS_ACTIVE | Boolean | User is Active is an indicator which shows whether the current user has the "Jira Software Users"-, or the "Jira Administrators" permission. | |
Username / Author Name | WORKLOG_USERNAME | String | Worklog Username is a username of the person, who logged time on a current issue page. You can find it in user’s profile by clicking on the User Key name. | |
User Email | WORKLOG_USER_EMAIL | String | User Email is exactly the user's email in Jira. JIRA can be configured to automatically generate issues or comments on existing issues based on received emails. In addition, any attachments in emails can be automatically attached to the issue. This can be useful when communicating with a customer or for receiving notifications about changes in a task, or also for support work. Can be retrieved from the Users section after clicking the User’s Name. | |
User Timezone | WORKLOG_USER_TIMEZONE | String | User Timezone is a geographic region with the corresponding standard time in which the user works. Can be retrieved from the Users section after clicking the User’s Name. | |
Update Date / Updated | WORKLOG_UPDATE_DATE | DateTimeOffset | Worklog Update Date is a point in time when the description, date, time, hours worked, or remaining estimate of the issue were changed. You can check it by hovering the mouse on Edited field. | |
Billable Seconds | WORKLOG_BILLABLE_SECONDS | Int64 | Billable Seconds are those seconds worked directly related to the client’s projects that they get bill for and pay it directly. You can find them in your BI account' oData tables. |
|
Issue Statuses |
| |||
Name / Issue Status Name | ISSUE_STATUS_NAME | String | Issue Status Name is an indicator of issue's current place in the project's workflow. | |
Sequence | ISSUE_STATUS_SEQUENCE | Int64 | Issue Status Sequence is an issue number position in its wokflow. You can check statuses order by clicking on the View Workflow icon. If you have a large amount of statuses with a lot of connections between them, and need to know a number of each other — | |
Description | ISSUE_STATUS_DESCRIPTION | String | Issue Status Description is a description of status properties. The fastest way to view it — is to mouse-over the Status icon. | |
Icon URL | ISSUE_STATUS_ICON_URL | String | Issue Status Icon URL is the address of a given icon on the Web.
| |
Status Category / Category | ISSUE_STATUS_CATEGORY | Int64 | Issue Status Category is an identifier of a logical group to which current status could be sent into: To Do (grey), In Progress (blue) or Done (green). Status Categories placed into Issue Statuses menu on the Administration panel. | |
Issue Status ID | Id | String | Issue Status Id is an alphanumeric character code uniquely identifies issue workflow statuses. The fastest way to view the status id — is to mouse-over the View Workflow field on the Issue page, that you wanted to view the id, and you can view the status id at the bottom of browser as shown in the screenshot. | |
Issue Types |
| |||
Name / Issue Type Name | ISSUE_TYPE_NAME | String | Issue Type Name is an identifying name of the Issue Type (Task, Subtask, Epic, Bug, Story). Besides default issue types you have an opportunity to create your own ones, by clicking on the Add Issue Type button in the Issues field of Administration menu. | |
Sequence | ISSUE_TYPE_SEQUENCE | Int64 | Issue Type Sequence is a position number of available issue types in a current project. You can find Issue Type Sequence in your BI account' oData tables. | |
Description | ISSUE_TYPE_DESCRIPTION | String | Issue Type Description is a specification that distinguish different types of work in unique ways, and help you identify, categorize, and report on your team’s work across your Jira site. To get acquainted with them at the Administration menu' Issue types section. | |
Issue Links |
| |||
Linked Issues | LINKID_ISSUES_ISSUES | String | Linked Issue is the key of an issue to which the link was made. | |
Link Type / Type | LINKID_ISSUES_LINK_TYPE | String | Link Type is a type of an association between issues on either the same or different Jira servers. Default types of links:
You are able to add, edit or delete your own link types. |
|
Linked Issue Key | LINKID_ISSUES_ISSUE_KEY | String | Link Direction is the key of a linked issue. |
|
Link Direction/ Direction | LINKID_ISSUES_DIRECTION | String | Link Direction is a type of direction attribute: inward (describes the issue that was acted upon: blocked by, cloned by, duplicated by, related to, and resolved by etc.) or outward (meaning the source issue is taking action on the destination issue: block, clone, duplicate, relate, resolve etc.).
| |
Issue Attachments |
| |||
Attachment Issue Key / Issue Key | ATTACHMENT_ISSUE_KEY | String | Attachment Issue Key is a key of an issue which contains attachments. | |
Attachment Issue Id / Issue ID | ATTACHMENT_ISSUE_ID | Int64 | Attachment Issue ID is the internal ID of the Jira issue with attachments, which is internally used in Jira database to refer to an issue. |