Error: "Could not set release for the parent object directly" when setting Release via Web Services API

Products

• Rally On-Premise
• Rally SaaS

Issue/Introduction

User reports the following error in the json response when attempting to set Release on user story:

{"OperationResult": {
    "_rallyAPIMajor": "2",
    "_rallyAPIMinor": "0",
    "Errors": [
        "Could not set value for Release: Could not set release for the parent object directly"
    ],
    "Warnings": []
}}

 

Resolution

Parent/epic stories cannot be scheduled for release in UI or in WS API.

 

As long a release is being set on a leaf story it should work as follows.

For example, if the target release ObjectID is <STORY_OID>, and valid authentication key is zsessionid:<API Key - include the underscore before the key>

URL:

https://rally1.rallydev.com/slm/webservice/v3.0/hierarchicalrequirement/<STORY_OID>?zsessionid:<API Key - include the underscore before the key>

 

and Payload:

{"HierarchicalRequirement":{
"Release": "/release/<RELEASE_OID>"
}}