Releases API
Add a release to a roll up release
PUT /api/v1/products/:product_id/releases/:id
Name | Description |
---|---|
product_id * | Numeric ID or key of the product |
id * | Numeric ID or key of the release |
name | Name of the release |
owner | Email or ID of the user that will own this release |
initiatives | Array of names or ids of initiatives which this release is associated with. |
workflow_status | Status of the release — must be a valid status for the selected product. |
parent_id | Numeric ID of the roll-up release of the release if present |
theme | Theme of the release — may include HTML formatting. |
start_date | Start date of the release in format YYYY-MM-DD |
end_date | End date of the release in format YYYY-MM-DD |
release_date | Release date of the release in format YYYY-MM-DD |
development_started_on | Date development started in format YYYY-MM-DD |
parking_lot | Sets whether this release is a parking lot. Use true to represent a parking lot release |
external_release_date | The external release date for this release in format YYYY-MM-DD |
external_date_resolution | Rounds the external release date to the nearest resolution value. This must be specified along with an external release date and must be one of: sync, exact, week, month, quarter, half, year |
capacity_units | The units for this release — must be either "time" or "story_points". |
total_capacity_text | The total capacity in time or story points for this release. For time: use min, h, d, w, m. Example: "2d 1h”. 1d = 8h, 1w = 5d, 1m = 22d. For story points: Use p to represent points. Example: "4p”. |
progress_source | Source for calculating progress on the release. Options are: progress_manual, progress_from_features, progress_from_release_phases, progress_from_todos, progress_from_remaining_estimate, progress_from_features_completed, progress_from_epics. |
progress | Progress completed on the release — may only be set when the progress_source is manual. |
duration_source | Source for automatically calculating start and end dates. Options are: duration_manual, duration_from_release_phases_features, duration_from_sub_releases. |
Example request
PUT /api/v1/products/PRJ1/releases/278327321
Example CURL command
curl "https://company.aha.io/api/v1/products/PRJ1/releases/278327321" -d '{"release":{"initiatives":[],"parent_id":292454904}}' -X PUT \
-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json
Request body
Response
Status: 200 OK
contentType: application/json; charset=utf-8
Response body