Features API

Features belong to releases. This means that if you want to create one then you must scope it to a release.

You can list them all at once, or filter by release , product , or epic. All these means of listing features can be further filtered by specific critera like name, modification date, tag, or assignee.

Once you have the id of a specific feature, you can inspect, modify, or delete them on the root features resource.

Update a feature's custom fields with tag-like value

PUT/api/v1/features/:id

Parameters
NameDescription
id *

Numeric ID or key of the feature

name

Name of the feature

workflow_kind

Type of feature

workflow_status

Status of the feature and it must be one of the valid status values for the selected product.

release

Numeric ID or key of the release the feature should be created in.

description

Description of the feature and it can include HTML formatting.

created_by

Email address of user that created the feature.

assigned_to_user

Email address of user that is assigned the feature.

tags

Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.

original_estimate_text

Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.

remaining_estimate_text

Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.

original_estimate

Set the original estimated effort in minutes.

remaining_estimate

Set the remaining estimated effort in minutes.

start_date

Date that work will start on the feature in format YYYY-MM-DD

due_date

Date that work is due to be completed on the feature in format YYYY-MM-DD

release_phase

Name or id of release phase which the feature belongs to

initiative

Name or id of initiative which the feature belongs to

epic

Name or id of epic which the feature belongs to

progress_source

Source for calculating progress on the feature. Options are: progress_manual, progress_from_requirements, progress_from_remaining_estimate, progress_from_todos.

progress

Progress completed on the feature. May only be set when the progress_source is manual.

Example request

PUT/api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"custom_fields":{"tags":["tag2","tag,3"]}}}' -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

© 2020 Aha! Labs Inc.All rights reserved