How to copy Milestones, Releases, Iterations, Users and shared pages to a new project that is created through Rally WSAPI

Products

• Rally SaaS

Issue/Introduction

When creating a new Project through the Rally User Interface, there is the option to automatically copy Milestones, Iterations, Releases, Users and Shared Pages to the new project on creation.  These options were previously not available when creating new projects using the API so people wishing to automate their project onboarding process would need to make multiple calls to the API to copy the items to the current project.   

Resolution

New query parameter options have been added to the create Project endpoint (e.g. https://rally1.rallydev.com/slm/webservice/v2.0/project/create) to enable the option to copy Milestones, Releases, Iterations, User Permissions and/or Shared Page permissions when a project is created through the API. 

• copyMilestones - If true, all current Milestones visible in the parent project will be accessible to the newly created project.  

 POST https://rally1.rallydev.com/slm/webservice/v2.0/project/create?copyMilestones=true

 

• copyTimeboxes - If true, all current and future Iterations and Releases will be copied from the parent project to the newly created project.   

POST https://rally1.rallydev.com/slm/webservice/v2.0/project/create?copyTimeboxes=true

 

• copyUserPermissions - If true, all User permissions from the parent project will be applied to the newly created project.  

POST https://rally1.rallydev.com/slm/webservice/v2.0/project/create?copyUserPermissions=true

 

• copySharedPages - If true, all pages shared with the parent project will also be shared with the newly created project.  

POST https://rally1.rallydev.com/slm/webservice/v2.0/project/create?copySharedPages=true

Here is the query with all 4 parameters:

https://rally1.rallydev.com/slm/webservice/v2.0/project/create?copyMilestones=true&copyTimeboxes=true&copyUserPermissions=true&copySharedPages

 

These query parameters are optional and if they are not present, or false, the endpoint will continue to create a project as it does now.  

Note that in order for all the options to be used, the user executing the call to the create Project endpoint must have appropriate permissions (Workspace or Subscription).