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 FieldREST 'fields' parameter valueREST 'groupByFields' parameter value
Assigneeassigneeassignee
Reporterreporterreporter
Creatorcreatorcreator
Issue KeyNot Supported (Already in the report)Not Supported
SummaryNot Supported (Already in the report)Not Supported
Projectprojectproject
Project Keycalc:projectKeycalc:projectKey
Issue Typeissuetypeissuetype
Statusstatusstatus
Created DatecreatedSupported as date parts. See 'Date Fields for GroupByFields Parameter' below.
Updated DateupdatedSupported as date parts. See 'Date Fields for GroupByFields Parameter' below.
Due DateduedateSupported as date parts. See 'Date Fields for GroupByFields Parameter' below.
Resolution DateresolutiondateSupported as date parts. See 'Date Fields for GroupByFields Parameter' below.
Resolutionresolutionresolution
Component(s)componentscomponents
Priorityprioritypriority
Label(s)labelslabels
Time SpenttimespentNot Supported
Σ Time SpentaggregatetimespentNot Supported
Original EstimatetimeoriginalestimateNot Supported
Σ Original EstimateaggregatetimeoriginalestimateNot Supported
Remaining EstimatetimeestimateNot Supported
Σ Remaining EstimateaggregatetimeestimateNot Supported
Issue LinksissuelinksNot Supported
Sub TaskssubtasksNot Supported
DescriptiondescriptionNot Supported
EnvironmentenvironmentNot Supported
Affected Versionsversionsversions
Fix VersionsfixVersionsfixVersions
Security LevelsecurityNot Supported
Parent Issue Keycalc:parentKeycalc:parentKey

Parent Link 

(Jira Advanced Roadmaps)

Use the corresponding custom field key as defined below.Use the corresponding custom field key as defined below.



Last ViewedNot SupportedNot Supported
ThumbnailNot SupportedNot Supported
Work RatioNot SupportedNot Supported
VotesNot SupportedNot Supported
WatchersNot SupportedNot Supported
Progress BarNot SupportedNot Supported
Σ Progress BarNot SupportedNot Supported
Parent LinkNot SupportedNot Supported
Time To First ResponseNot SupportedNot Supported
IterationNot SupportedNot Supported
ApprovalsNot SupportedNot Supported
RankNot SupportedNot Supported
Epic ColorUse the corresponding custom field key as defined below.Not Supported
Epic LinkUse the corresponding custom field key as defined below.
Use the corresponding custom field key as defined below.
Epic LabelNot SupportedNot Supported
Epic StatusNot SupportedNot Supported
SLA FieldsNot SupportedNot 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 FieldREST 'fields' parameter valueREST 'groupByFields' parameter value
Custom field with ID 12345customfield_12345customfield_12345

For custom field types introduced by plugin, Time in Status tries to render the field as a text value but that might not always produce a sensible value.


Field IDs

Get Field information

GET /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 Time in Status service, it is on your Jira Cloud instance.

Request

<service_url>/rest/api/2/field


Parameters

This request requires no parameters.


Examples

https://myjirainstance/rest/api/2/field


Details about this endpoint can be found in Atlassian Jira 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 FieldREST 'fields' parameter valueREST 'groupByFields' parameter value
date::

Not Supported

Datepart can be

  • year
  • month
  • week
  • day

Datefield can be

  • created
  • updated
  • resolutiondate
  • duedate
  • any date or datetime custom field

Ex:

  • date:year:created
  • date:month:updated
  • date:week:resolutiondate
  • date:day:customfield_10120






  • No labels