Issue Summary
Pre-requirement: Details Settings Panel -> Dependency -> Needed By (Required)
When consuming POST /rest/align/api/2/Dependencies, to add an Epic Dependency, and if they needed by is required, then the API response will trigger an error with the following message:
Cannot create Dependency. Following properties: 'neededBySprintId' are required.
However, if the user tries to add the "NeededBySprintId" in the payload, it will trigger another error:
Cannot create Dependency. neededBySprintId cannot be set for Epic dependency.
Steps to Reproduce
- Consume the endpoint POST /rest/align/api/2/Dependencies/
- The payload can the like the following:
{ "title": "LUIZ DEPENDENCY API 2", "description": "It is a test for API and required fields", "releaseId": 759, "typeId": 6, "dependencyType": 2, "epicId": 7798, "requestingProgramId": 516, "dependsOnProgramId": 561 }
-
- Note that the "typeId" must be set as 6, and "dependencyType" = 2
- Another payload that can be tested after the "neededBySprintId" triggers an error is the following:
{ "title": "LUIZ DEPENDENCY API 2", "description": "It is a test for API and required fields", "releaseId": 759, "typeId": 6, "dependencyType": 2, "epicId": 7798, "requestingProgramId": 516, "dependsOnProgramId": 561, "neededBySprintId":4104 }
-
- In the "neededBySprintId" it was tested using AnchorSprintId, and SprintId. Both cases triggered the same issue.
Expected Results
The API responds successfully, creating the Dependency.
Actual Results
The API returns the following error:
Cannot create Dependency. neededBySprintId cannot be set for Epic dependency.
Workaround
The workaround for it is to turn off the required "Needed By" toggle.
- relates to
-
JIRAALIGN-6372 Getting API Call on Dependencies returns inconsistency data for neededBySprintID field
- Closed
-
JIRAALIGN-6314 neededBySprintId field on Dependency API endpoint
- Gathering Interest
-
ALIGNSP-24086 Loading...
-
PS-166113 Loading...
- is action for
-
HOT-108852 Loading...
- resolves
-
PS-169708 Loading...