Release phases won't link properly to hierarchical requirements structure

We’re unable to establish proper parent-child links between release phases and our hierarchical requirements structure in Rally 2023. When we try to assign user stories to specific release phases through WSAPI, we get a ‘Relationship 400 error’ indicating the link can’t be created.

Our requirements hierarchy has Features at the top, with User Stories as children. We want to link these User Stories to Release Phases for planning visibility, but the Parent field seems incompatible with cross-workspace references.


POST /hierarchicalrequirement/{StoryOID}
{"Release": "/release/12345/phase/2"}
Error: Invalid relationship reference

The type definitions documentation suggests this should work, but we’re hitting validation errors. Is there a specific field or API endpoint for linking stories to release phases in a multi-workspace environment?

Thanks for the insights. I checked and we are indeed in a multi-workspace setup with Features and Releases in different workspaces. The type definitions show Release field only accepts Release objects, not Release Phases.

You’ve identified the core constraints. Here’s how to properly link release phases to hierarchical requirements in Rally 2023:

1. Understanding HierarchicalRequirement Structure: Rally’s HierarchicalRequirement type (User Stories, Features, Epics) has a ‘Release’ field that references Release objects only - not Release Phases. Release Phases are timeline subdivisions within a Release and don’t have direct foreign key relationships with stories. The data model is:

  • Release → has multiple Release Phases (timeline segments)
  • HierarchicalRequirement → references one Release (not phases)

2. Parent Field Limitations: The Parent field on HierarchicalRequirement is strictly for story hierarchy (Feature → Story → Task), not for release planning. It cannot reference Release or Release Phase objects. Your API call is failing because you’re trying to use an incompatible field type.

3. Cross-Workspace Constraints: Rally 2023 enforces workspace boundaries for object relationships. If your requirements hierarchy spans multiple workspaces:

  • Parent-child links only work within same workspace
  • Release references must be in same workspace as the story
  • Cross-workspace queries require explicit workspace scope in API calls

To check workspace alignment:


GET /hierarchicalrequirement/{StoryOID}?fetch=Workspace,Release

Compare Workspace OIDs - they must match.

4. Type Definitions and Allowed Relationships: Verify your type configuration allows Release association:

  • Navigate to Workspace Setup > Types > HierarchicalRequirement
  • Check ‘Allowed Relationships’ section
  • Release field should show type: ‘Release’ (not ReleasePhase)

If you need phase-level planning, Rally expects you to use Iteration planning instead, or align stories to Release Phases using date ranges.

5. Correct API Approach for Release Assignment: To link a User Story to a Release (not phase):


POST /hierarchicalrequirement/{StoryOID}
{
  "Release": "/release/{ReleaseOID}"
}

For phase-level tracking, use custom fields or date-based filtering:


POST /hierarchicalrequirement/{StoryOID}
{
  "Release": "/release/{ReleaseOID}",
  "c_ReleasePhase": "Phase 2",
  "PlannedStartDate": "2025-11-01",
  "PlannedEndDate": "2025-11-30"
}

6. Workaround for Phase-Level Planning: Since direct phase linking isn’t supported, use one of these approaches:

Option A - Date-Based Alignment: Query Release Phases for their date ranges, then filter stories by PlannedStartDate/PlannedEndDate to show which phase they fall into. Build custom reports using this logic.

Option B - Custom Field Reference: Create a custom dropdown field ‘Release Phase’ on HierarchicalRequirement with values matching your phase names. Update this manually or via WSAPI. This gives you phase visibility without enforcing referential integrity.

Option C - Iteration-Based Planning: Map each Release Phase to specific Iterations (sprints). Link stories to Iterations instead of directly to phases. This is Rally’s recommended approach for detailed timeline planning.

7. Multi-Workspace Solution: For cross-workspace scenarios, consolidate release planning into a single workspace, or use Portfolio Items (Features/Epics) as the linking layer. Portfolio Items can aggregate stories across workspaces while maintaining release associations in the parent workspace.

The key insight: Rally’s data model separates strategic release planning (Release object) from tactical timeline planning (Iterations/Sprints). Release Phases are UI constructs for visualization, not first-class objects with relationship fields. Use Iterations for detailed phase-level planning, or custom fields for phase tracking if Iterations don’t fit your process.

Check your type definitions configuration. HierarchicalRequirement has specific allowed types for the Release field, and Release Phase might not be in that list depending on your Rally edition. Go to Workspace Setup > Types > HierarchicalRequirement > Relationships and verify what object types are permitted for the Release association. You might need to enable Release Phase linking explicitly.

The error suggests you’re trying to reference a Release Phase using an invalid path format. Rally’s WSAPI doesn’t support nested resource paths like ‘/release/12345/phase/2’. Release Phases are separate objects with their own ObjectIDs. You need to query the Release Phase object first to get its OID, then reference it directly.