nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

JIRA for Python does not pull all fields for subtask

William Briere

I would like to clone an issue and it's subtasks via python automation. In order to do this, I read in the story data and create a new story. Next, I read the subtasks and create new subtasks and then add them to the new story. Each subtask has a description of the task to be completed.

When pulling the data for a subtask, there is no description, labels, components or other fields.

When you pull the fields for a subtask, this is all I get. Removed some info and replaced with ***

subtask = jira.issue(subtask_key)
json_fields = subtask.raw['fields']
print(json.dumps(json_fields, indent=3))

"fields": {
   "summary": "Test Summary",
   "status": {
      "self": "***",
      "description": "New issue that needs to be triaged.",
      "iconUrl": "***",
      "name": "Screen",
      "id": "1",
      "statusCategory": {
         "self": "***",
         "id": 2,
         "key": "new",
         "colorName": "blue-gray",
         "name": "To Do"
      },
   "priority": {
      "self": "*",
      "iconUrl": "*",
      "name": "Major",
      "id": "3"
   },
   "issuetype": {
      "self": "*",
      "id": "5",
      "description": "The sub-task of the issue",
      "iconUrl": "*",
      "name": "Sub-Task",
      "subtask": true,
      "avatarId": 18416
   }
}

Accepted answers

All comments

unknown

Hello @William Briere

You haven't advised how you are 'reading the data' or 'pulling the data'. You have said you are using Python, so can it be assumed you're interacting with the REST API somehow? If so, which specific endpoints are you accessing and what is the actual request (code) you are sending to that endpoint. Are you using a native Python library / module, or a third party one?

Also, you haven't advised which type or version of Jira you're accessing. Server, Cloud or Data Centre? Software or Service Management? Please add that information as tags to your question.

Sub-tasks are just like Stories in that they are issues. If you query the appropriate issue endpoints, you should get back mostly identical results.

Stefan Salzl

Hi @William Briere ,

Do I assume correctly that you get the information via Rest API?

If so and you calling the issue endpoint it´s not delivering ALL fields by default. There is a query parameter to retreive all fields of the issue. See the link below to the documentation:

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get

Hope I could follow your requirement correctly and this was helpful.

Best
Stefan

William Briere

I'm using this JIRA python library. https://jira.readthedocs.io/examples.html#issues I'm not sure if there's any way to utilize the parameter through this library or if I'd need to formulate a new REST query in python just to pull that data.

unknown

Hello @Stefan Salzl

Are you sure? The v3 Get issue endpoint returns ALL fields, by default, and the fields parameter is just for being more specific about the list of fields to return.

Hello @William Briere

You are using a third party Python library whose functions and behaviours are specific to it. That library does support the use of a fields parameter with the issues object:

If you only want a few specific fields, save time by asking for them explicitly:

issue = jira.issue('JRA-1330', fields='summary,comment')

Just like the native REST API endpoint, ALL the issue's fields are returned by default, and the fields parameter is for specifying only specific fields be returned.

Have you confirmed that the Sub-task issue type hasn't been specifically configured to not have fields such as labels, components etc? I've worked in plenty of Jira environments where the Sub-tasks have been 'stripped down' exactly like that via a custom screen scheme for certain projects.

I'd suggest you first test your query, in a plain request to the specific REST API endpoint using a test tool like Postman to first confirm the endpoint is working as expected to rule that out.

Stefan Salzl

@[deleted]

Thanks for the hint. My bad....I just had the link in my bookmarks that was pointing to v2 🙈

john.felps@teladochealth.com

# This was helpful. For me, 

client.issue(key)

# works for any jira issue, but 

issue = client.issue(key)
for subtask in issue.fields.subtasks:
    print(json.dumps(subtask.raw, indent=2)) # this has limited fields
    subtask = client.issue(subtask.key)
    print(json.dumps(subtask.raw, indent=2)) # this has all issue fields

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

python