Cloud
Data Center 8.15
Versions

Data Pipeline export schema

Data pipeline

On this page

Related content

  • No related content found

Still need help?

The Atlassian Community is here for you.

Ask the community

After exporting Jira's current state data, you'll need to display it in a meaningful manner. To do that, you'll need to understand its schema. This will allow you to configure how to display it properly in your existing existing data management platform or business intelligence tools. 

The output files are written in CSV format and are RFC4180 compliant. Both files also have the following characteristics:


  1. Each file has a header. This includes files from exports that resulted in no data.
  2. New lines are separated by CRLF characters \r\n.
  3. Fields containing line breaks (CRLF), double quotes, and commas are enclosed in double quote.
  4. If double-quotes are present inside fields, then a double-quote appearing inside a field are escaped by preceding it with another double quote. For example: "aaa", "b""bb", "ccc".
  5. Fields with no data (null values) are represented in the CSV export by two consecutive delimeters (as in, ,,).
  6. Embedded break lines are escaped by default and printed as \n. For instructions on configuring this, see Configuring the data export.


On this page:

Issues data schema

All data relating to issues will be exported to issues_job<job_id>_<timestamp>.csv. This file's schema appears as follows:

Field

Schema/Type

Sample Data

Description

id (Primary Key)

NUMBER

10002

Unique ID of this issue. Use as Primary Key.

instance_url

STRING

http://www.example.com/jira

Base url of the current instance.

url

STRING

http://www.example.com/jira/browse/TEST-1002

Link/URL to the issue.

key

STRING

TEST-1002

Unique Key for this issue.

project_key

STRING

TEST

Key of the project this issue is in.

project_name

STRING

Sample Test Project

Name of the project this issue is in.

project_type

STRING

Business / Software / Service Desk

Type of the project this issue is in.

project_category

STRING

Sample Project Category

Assigned category for the project this issue is in.

issue_type

STRING

Task

Type of this issue (for example: task, bug, or epic)

summary

STRING

Sample issue

Summary for the issue.

description

STRING

This is a sample issue for demo purposes.

Description of the issue. Field is truncated to 2000 characters.

creator_id

NUMBER

10000

Unique identifier of the creator, regardless of directory.

creator_name

STRING

Some Name

Name of the current creator.

reporter_id

NUMBER

10001

Unique identifier of the reporter, regardless of directory.

reporter_name

STRING

Other Name

Name of the reporter.

assignee_id

NUMBER

10002

Unique identifier of the assignee, regardless of directory.

assignee_name

STRING

Another Name

Name of assignee.

status

STRING

In Progress

Current status of this issue.

status_category

STRING

In Progress

Status category of the current status for this issue.

priority_sequence

NUMBER

3

Shows the priority order. However, admins can change this which will result in non-deterministic priority orders.

priority_name

STRING

Medium

Name of the priority for this issue.

resolution

STRING

Done

 The final status of an issue. Jira considers the workflow of an Issue complete once a value is present in the resolution field.

watcher_count

NUMBER

5

Number of watchers for this issue.

vote_count

NUMBER

4

Number of votes for this issue.

created_date

DATE

2020-11-05T14:44:57Z

UTC timezone creation date of this issue (ISO string).

resolution_date

DATE

2020-11-05T14:44:57Z

UTC timezone resolution date of this issue (ISO string).

updated_date

DATE

2020-11-05T14:44:57Z

UTC timezone date that the issue was last updated (ISO string).

due_date

DATE

2020-11-05T14:44:57Z

The issue's UTC timezone due date (ISO string).

estimate

NUMBER

5000 (in seconds)

Estimate time remaining from original estimate (requires time-tracking enabled).

original_estimate

NUMBER

2000  (in seconds)

Original estimate that was set (requires time-tracking enabled).

time_spent

NUMBER

4000  (in seconds)

Amount of logged work (requires time-tracking enabled). Field is null if there is no time spent.

labels

STRING[]

["test-label", "test2-label”]

JSON array of label names. Field is null if there are no labels.

components

STRING[]

["component_a", "component_b"]

JSON array of component names. Field is null if there are no labels.

parent_id

NUMBER

10001

ID of the parent issue. Field is null if the issue is not a subtask.

environment

STRING

"linux”

A short description of the environment in which the issue occurred (for example, IE9 on Windows 7). This field has a limit of 2000 characters

affected_versions

STRING[]

["a_version_1", "a_version_2"]

JSON Array of Affected Version Names. Field is null if there are no labels.

fix_versions

STRING[]

["f_version_1", "f_version_2"]

JSON array of fix version names. Field is null if there are no labels.

security_level

STRING

test-security-level

Security level name. NOTE: This can change between data exports.

Data schema for Jira Software and Jira Service Management fields

Data from Jira Software and Jira Service Management fields will be exported to issue_fields_job<job_id>_<timestamp>.csv, and every custom field is displayed on a separate row. To map a custom field to its corresponding issue, use the issue_id from this file and find its matching ID from the Issues file. 

Any user-generated custom fields will not be exported.

Field

Type

Sample data

Description

issue_id

NUMBER

10002

ID to link to the corresponding issue in Issues data schema .

field_id

STRING

story_points

Pre-defined IDs of the Jira Software and Jira Service Management fields.

field_name

STRING

Story Points

Name of field.

field_value

NUMBER/STRING/JSON ARRAY

4 / [{"sprintName": "A"}, {"sprintName": "B"}]/5000

Value of field.

The following Jira Software fields are non-epic issue fields:

Field ID

Sample data

Description

sprint

[
  {
    "id": 2,
    "name": "Sample Sprint 1",
    "goal": "",
    "boardId": 1,
    "state": "FUTURE",
    "startDate": "2020-09-20T19:44:13Z",
    "endDate": "2020-10-04T18:44:13Z",
    "endDate": "2020-10-04T18:44:13Z"
  }
]

Sprints that the issue is currently in or has been in. All date and times are formatted as an ISO string with UTC timezone.

epic_link_id

10000

ID of the epic linked to this issue.

story_points

5

Number of story points associated with this issue.

The following Jira Software fields relate to epics:

Field ID

Sample data

Description

epic_color

ghx-label-3

Color of the epic.

epic_name

Test Epic

Name of the epic.

epic_status

To Do

Status of the epic.

The following fields relate to Jira Service Management:

Field ID

Sample data

Description

customer_request_type

Request new software

Customer Request Type for a JSM Customer Request.

organizations

["org1", "org2"]

List of organizations assigned to a given JSM Issue. Organizations are entities that admins can organize customers into.

request_participants
[
 {
  "id": 10100,
  "name": "User 1 display name"
 },
 {
  "id": 10101,
  "name": "user 2 display name"
 }
]

List of users assigned as request participants for a given JSM Issue.

satisfaction_comment

I got a prompt response. Thank you!

Comment given as part of a JSM Issue Satisfaction survey.

satisfaction_rating

4.0

Rating given as part of a JSM Issue Satisfaction survey.

satisfaction_scale

5.0

Scale (max rating) the given satisfaction rating is based upon.

satisfaction_date

2020-10-04T18:44:13Z

Date the Satisfaction survey was completed.

SLA Cycle data schema (for Jira Service Management only)

Data relating to SLA Cycle fields from Jira Service Management will be exported to sla_cycles_job<job_id>_<timestamp>.csv. Each issue can have multiple SLAs, where each SLA cycle (Ongoing and/or Completed) is displayed on a separate row. To map an SLA to its corresponding issue, use the issue_id from this file and find its matching ID from the Issues file.


Field ID

Schema/Type

Sample data

Description

issue_id

NUMBER

10002

ID to link to the corresponding issue in Issues data schema .

sla_id

NUMBER

15364

ID of the SLA of which the SLA cycle belongs to.

sla_name

STRING

Time to first response

Name of the SLA of which the cycle belongs to.

cycle_type

STRING

Ongoing / Completed

Whether current SLA cycle is Ongoing or Completed.

start_time

NUMBER

2020-01-10T12:50:30Z

Timestamp of when the SLA cycle started.

stop_time

NUMBER

2020-01-10T12:50:30Z / empty

Timestamp of when the SLA cycle transitioned from Ongoing to Completed. Only available for Ongoing cycles.

paused

BOOLEAN

true / false / empty

Notes whether the SLA cycle is paused or not. Only available for Ongoing cycles.

remaining_time

NUMBER

14400000 (in milliseconds)

Represents the time (in milliseconds) remaining before the expected SLA limit is breached.

Remaining times are calculated and updated every 30 minutes. Therefore, the outputted value may not represent the actual current remaining time.

elapsed_time

NUMBER

14400000 (in milliseconds)

Represents the time (in milliseconds) that has passed since the SLA cycle started.

goal_duration

NUMBER

14400000 / empty (in milliseconds)

Represents time (in milliseconds) taken to complete the current cycle. Only available for Completed cycles.

Last modified on Mar 22, 2021

Was this helpful?

Yes
No
Provide feedback about this article

Related content

  • No related content found
Powered by Confluence and Scroll Viewport.