System Fields
The system fields or built-in custom fields introduced with Atlassian applications can be used with the indicated name for accessing REST reports.
| System Field | REST 'fields' parameter value | REST 'groupByFields' parameter value |
|---|---|---|
| Assignee | assignee | assignee |
| Reporter | reporter | reporter |
| Creator | creator | creator |
| issue ID | calc:issueid | Not Supported |
| Issue Key | Not Supported (Already in the report) | Not Supported |
| Summary | Not Supported (Already in the report) | Not Supported |
| Project | project | project |
| Issue Type | issuetype | issuetype |
| Status | status | status |
| Created Date | created | Supported as date parts. See 'Date Fields for GroupByFields Parameter' below. |
| Updated Date | updated | Supported as date parts. See 'Date Fields for GroupByFields Parameter' below. |
| Due Date | duedate | Supported as date parts. See 'Date Fields for GroupByFields Parameter' below. |
| Resolution Date | resolutiondate | Supported as date parts. See 'Date Fields for GroupByFields Parameter' below. |
| Resolution | resolution | resolution |
| Component(s) | components | components |
| Priority | priority | priority |
| Label(s) | labels | labels |
| Time Spent | timespent | Not Supported |
| Σ Time Spent | aggregatetimespent | Not Supported |
| Time Spent (Formatted) | calc:timespentFormatted | Not Supported |
| Σ Time Spent (Formatted) | calc:aggregatetimespentFormatted | Not Supported |
| Original Estimate | timeoriginalestimate | Not Supported |
| Σ Original Estimate | aggregatetimeoriginalestimate | Not Supported |
| Original Estimate (Formatted) | calc:timeoriginalestimateFormatted | Not Supported |
| Σ Original Estimate (Formatted) | calc:aggregatetimeoriginalestimateFormatted | Not Supported |
| Remaining Estimate | timeestimate | Not Supported |
| Σ Remaining Estimate | aggregatetimeestimate | Not Supported |
| Remaining Estimate (Formatted) | calc:timeestimateFormatted | Not Supported |
| Σ Remaining Estimate (Formatted) | calc:aggregatetimeestimateFormatted | Not Supported |
| Issue Links | issuelinks | Not Supported |
| Issue Links with Types | calc:issueLinksWithType | Not Supported |
| Sub Tasks | subtasks | Not Supported |
| Description | description | Not Supported |
| Environment | environment | Not Supported |
| Affected Versions | versions | versions |
| Fix Versions | fixVersions | fixVersions |
| Security Level | security | Not Supported |
| Parent Issue Key | calc:parentKey | Not Supported |
| Sprint | Use the corresponding custom field key as defined below. | Use the corresponding custom field key as defined below. |
| Sprint (Current) | calc:currentSprint | calc:currentSprint |
| Sprint (Latest) | calc:latestSprint | calc:latestSprint |
| Last Viewed | Not Supported | Not Supported |
| Thumbnail | Not Supported | Not Supported |
| Work Ratio | Not Supported | Not Supported |
| Votes | Not Supported | Not Supported |
| Watchers | Not Supported | Not Supported |
| Progress Bar | Not Supported | Not Supported |
| Σ Progress Bar | Not Supported | Not Supported |
| Parent Link | Not Supported | Not Supported |
| Time To First Response | Not Supported | Not Supported |
| Iteration | Not Supported | Not Supported |
| Approvals | Not Supported | Not Supported |
| Rank | Not Supported | Not Supported |
| Epic Color | Use the corresponding custom field key as defined below. | Not Supported |
| Epic Link | Use the corresponding custom field key as defined below. | Not Supported |
| Epic Link Name | calc:epicLinkName | calc:epicLinkName |
| Epic Link Summary | calc:epicLinkSummary | calc:epicLinkSummary |
| Epic Label | Not Supported | Not Supported |
| Epic Status | Not Supported | Not Supported |
| SLA Fields | Not Supported | Not Supported |
Custom Fields
Any custom field can be referenced with its field ID in a format like "customfield_xxxxx"
All built in custom field types are supported.
Custom fields introduced by plugin will be listed but can produce unexpected output.
| Custom Field | REST 'fields' parameter value | REST 'groupByFields' parameter value |
| Custom field with ID 12345 | customfield_12345 | customfield_12345 |
For custom field types introduced by plugin, Timepiece tries to render the field as a text value but that might not always produce a sensible value.
Field IDs
Get Field information
GET <your_jiracloud_url>/rest/api/3/field
You can use this endpoint to get the list of fields (and their IDs) defined on your Jira cloud instance.
Please note that this endpoint is not on Timepiece service, it is on your Jira Cloud instance.
Request
<your_jiracloud_url>/rest/api/3/field
Parameters
This request requires no parameters.
Examples
Details about this endpoint can be found in Atlassian Jira Cloud Documentation.
Date Fields for GroupByFields Parameter
Date fields can be used in parts for GroupByFields parameter. You can use the year, month, week, or day part of the date for grouping issues.
| System or Custom Field | REST 'fields' parameter value | REST 'groupByFields' parameter value |
| date:<datepart>:<datefield> | Not Supported | Datepart can be
Datefield can be
Ex:
|