Releases API

Create a parking lot release

POST/api/v1/products/:product_id/releases

Parameters
NameDescription
product_id *

Numeric ID or key of the product

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 and it must be one of the valid status values for the selected product.

parent

The master release of the release if present

theme

Theme of the release and it can include HTML formatting.

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 feature in format YYYY-MM-DD

external_date_resolution

Rounds the external release date to the nearest resolution value, can be one of: sync, exact, week, month, quarter, half, year

capacity_units

The units for this release, either time or story_points

total_capacity_text

The total capacity for this release, For time: use min, h, d, w, m to represent time (e.g. "2d 1h") 8h = 1d, 5d = 1w, 22d = 1m. For story points: Use p to represent points (e.g. "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.

Example request

POST/api/v1/products/PRJ1/releases

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/releases" -d '{"release":{"owner":"no-reply@aha.io","initiatives":[],"name":"Release 3","status":"New","theme":"Our first big release","external_date_resolution":"week","parking_lot":true}}' -X POST \
	-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

© 2020 Aha! Labs Inc.All rights reserved