microsoft / microsoft/azure-devops-python-api
How to add new iteration to ADS project
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 684
- Forks
- 218
- Avg merge
- 8d 10h
- Merged PRs (30d)
- 1
Description
Hello, I have an Azure DevOps project with multiple iteration paths:

If I use this Azure Python API to create a new work item and set /fields/System.IterationPath to have a value that already exists like RTC-ADS\PI28\Sprint 28-3 it will create the work item with no issue.
But if I try to create a work item with an iteration that does not yet exist such as RTC-ADS\PI27 it will fail with an error
ERROR:root:Error creating ADS work item: TF401347: Invalid tree name given for work item -1, field 'System.IterationPath'.
I could create PI27 manually in my Azure Project settings, but is there a way I can use this Azure Python API to create a new iteration value for PI27 by making a POST request or something?
I have found documentation supporting how to do so I believe:
https://docs.microsoft.com/en-us/rest/api/azure/devops/work/iterations/post-team-iteration?view=azure-devops-rest-6.0
But is it possible to add a new iteration value using this API? Thanks
jpo_path=str("/fields/System.IterationPath"),
jpo_value=str("RTC-ADS\PI27")Hello, I have an Azure DevOps project with multiple iteration paths:

If I use this Azure Python API to create a new work item and set /fields/System.IterationPath to have a value that already exists like RTC-ADS\PI28\Sprint 28-3 it will create the work item with no issue.
But if I try to create a work item with an iteration that does not yet exist such as RTC-ADS\PI27 it will fail with an error
ERROR:root:Error creating ADS work item: TF401347: Invalid tree name given for work item -1, field 'System.IterationPath'.
I could create PI27 manually in my Azure Project settings, but is there a way I can use this Azure Python API to create a new iteration value for PI27 by making a POST request or something?
I have found documentation supporting how to do so I believe:
https://docs.microsoft.com/en-us/rest/api/azure/devops/work/iterations/post-team-iteration?view=azure-devops-rest-6.0
But is it possible to add a new iteration value using this API? Thanks
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Azure DevOps REST endpoint linked in the issue, then check whether the Python API exposes a corresponding team-iteration client method. Compare its request and path parameters with the existing work-item creation call. Done means confirming whether PI27 can be created through this API and documenting or demonstrating the supported request if it can.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, python
- Domain
- api, devops
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100