ReleasePhases API


GET /api/v1/releases/:id/release_phases

Get all release phases for a release

Parameters

Name Description
id * Numeric ID, or key of the release
type Limit to either release milestones or release phases, options: 'milestone', 'phase'

GET /api/v1/releases/278327321/release_phases

Example CURL command

curl -g "https://company.aha.io/api/v1/releases/278327321/release_phases" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phases": [
    {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    {
      "id": "405824017",
      "name": "Beta",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "milestone",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "965145324",
        "body": "Description of release phase 2",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/release_phases/:id

Get specific release phase

Parameters

Name Description
id * Numeric ID, or key of the release phase to be retrieved

GET /api/v1/release_phases/20526005

Example CURL command

curl -g "https://company.aha.io/api/v1/release_phases/20526005" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phase": {
    "id": "20526005",
    "name": "Alpha",
    "start_on": "2019-01-01",
    "end_on": "2019-01-01",
    "type": "phase",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": null,
    "progress_source": "progress_manual",
    "description": {
      "id": "243384959",
      "body": "Description of release phase 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    }
  }
}

POST /api/v1/release_phases

Create a release phase

    When creating a release phase at least the <code>name</code> and
    <code>release_id</code> must be specified.

Parameters

Name Description
name * Name of the release phase
release_id * Id of the release this release phase belongs to
start_on Start date of the release phase in format YYYY-MM-DD
end_on End date of the release phase in format YYYY-MM-DD
phase_type Type of phase, either 'phase' or 'milestone'
description Description of the release phase and it can include HTML formatting.
progress_source Source for calculating progress on the release phase. Options are: progress_manual, progress_from_features, progress_from_todos, progress_from_features_completed.
progress Progress completed on the release phase. May only be set when the progress_source is manual.

POST /api/v1/release_phases

Example CURL command

curl "https://company.aha.io/api/v1/release_phases" -d '{"release_phase":{"name":"New release phase","phase_type":"phase","release_id":278327321,"start_on":"2019-01-01","end_on":"2019-01-01","description":"\u003cp\u003eThis is the description\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release_phase": {
    "name": "New release phase",
    "phase_type": "phase",
    "release_id": 278327321,
    "start_on": "2019-01-01",
    "end_on": "2019-01-01",
    "description": "<p>This is the description</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phase": {
    "id": "6733663292636865122",
    "name": "New release phase",
    "start_on": "2019-01-01",
    "end_on": "2019-01-01",
    "type": "phase",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": 0,
    "progress_source": "progress_from_todos",
    "description": {
      "id": "6733663292667531846",
      "body": "<p>This is the description</p>",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    }
  }
}

POST /api/v1/release_phases

Create a release milestone

    When creating a release phase at least the <code>name</code> and
    <code>release_id</code> must be specified.

Parameters

Name Description
name * Name of the release phase
release_id * Id of the release this release phase belongs to
start_on Start date of the release phase in format YYYY-MM-DD
end_on End date of the release phase in format YYYY-MM-DD
phase_type Type of phase, either 'phase' or 'milestone'
description Description of the release phase and it can include HTML formatting.
progress_source Source for calculating progress on the release phase. Options are: progress_manual, progress_from_features, progress_from_todos, progress_from_features_completed.
progress Progress completed on the release phase. May only be set when the progress_source is manual.

POST /api/v1/release_phases

Example CURL command

curl "https://company.aha.io/api/v1/release_phases" -d '{"release_phase":{"name":"New release milestone","phase_type":"milestone","release_id":278327321,"start_on":"2019-01-01","description":"\u003cp\u003eThis is the description\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release_phase": {
    "name": "New release milestone",
    "phase_type": "milestone",
    "release_id": 278327321,
    "start_on": "2019-01-01",
    "description": "<p>This is the description</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phase": {
    "id": "6733663293175729849",
    "name": "New release milestone",
    "start_on": "2019-01-01",
    "end_on": null,
    "type": "milestone",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": null,
    "progress_source": "progress_manual",
    "description": {
      "id": "6733663293211487613",
      "body": "<p>This is the description</p>",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    }
  }
}

PUT /api/v1/release_phases/:id

Update a release phase

Parameters

Name Description
id * Numeric ID, or key of the release phase to be edited
name * Name of the release phase
release_id * Id of the release this release phase belongs to
start_on Start date of the release phase in format YYYY-MM-DD
end_on End date of the release phase in format YYYY-MM-DD
phase_type Type of phase, either 'phase' or 'milestone'
description Description of the release phase and it can include HTML formatting.
progress_source Source for calculating progress on the release phase. Options are: progress_manual, progress_from_features, progress_from_todos, progress_from_features_completed.
progress Progress completed on the release phase. May only be set when the progress_source is manual.

PUT /api/v1/release_phases/20526005

Example CURL command

curl "https://company.aha.io/api/v1/release_phases/20526005" -d '{"release_phase":{"name":"Another name","description":"\u003cp\u003enew description\u003c/p\u003e","phase_type":"milestone"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release_phase": {
    "name": "Another name",
    "description": "<p>new description</p>",
    "phase_type": "milestone"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phase": {
    "id": "20526005",
    "name": "Another name",
    "start_on": "2019-01-01",
    "end_on": "2019-01-01",
    "type": "milestone",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": 0,
    "progress_source": "progress_from_todos",
    "description": {
      "id": "243384959",
      "body": "<p>new description</p>",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    }
  }
}

PUT /api/v1/release_phases/:id

Update a release phase's progress source

Parameters

Name Description
id * Numeric ID, or key of the release phase to be edited
name * Name of the release phase
release_id * Id of the release this release phase belongs to
start_on Start date of the release phase in format YYYY-MM-DD
end_on End date of the release phase in format YYYY-MM-DD
phase_type Type of phase, either 'phase' or 'milestone'
description Description of the release phase and it can include HTML formatting.
progress_source Source for calculating progress on the release phase. Options are: progress_manual, progress_from_features, progress_from_todos, progress_from_features_completed.
progress Progress completed on the release phase. May only be set when the progress_source is manual.

PUT /api/v1/release_phases/20526005

Example CURL command

curl "https://company.aha.io/api/v1/release_phases/20526005" -d '{"release_phase":{"progress_source":"progress_from_features"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release_phase": {
    "progress_source": "progress_from_features"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phase": {
    "id": "20526005",
    "name": "Alpha",
    "start_on": "2019-01-01",
    "end_on": "2019-01-01",
    "type": "phase",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": 0,
    "progress_source": "progress_from_features",
    "description": {
      "id": "243384959",
      "body": "Description of release phase 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    }
  }
}

PUT /api/v1/release_phases/:id

Update a release phase's progress

Parameters

Name Description
id * Numeric ID, or key of the release phase to be edited
name * Name of the release phase
release_id * Id of the release this release phase belongs to
start_on Start date of the release phase in format YYYY-MM-DD
end_on End date of the release phase in format YYYY-MM-DD
phase_type Type of phase, either 'phase' or 'milestone'
description Description of the release phase and it can include HTML formatting.
progress_source Source for calculating progress on the release phase. Options are: progress_manual, progress_from_features, progress_from_todos, progress_from_features_completed.
progress Progress completed on the release phase. May only be set when the progress_source is manual.

PUT /api/v1/release_phases/20526005

Example CURL command

curl "https://company.aha.io/api/v1/release_phases/20526005" -d '{"release_phase":{"progress":25}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release_phase": {
    "progress": 25
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release_phase": {
    "id": "20526005",
    "name": "Alpha",
    "start_on": "2019-01-01",
    "end_on": "2019-01-01",
    "type": "phase",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": 25,
    "progress_source": "progress_manual",
    "description": {
      "id": "243384959",
      "body": "Description of release phase 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    }
  }
}

DELETE /api/v1/release_phases/:id

Delete release phase

Parameters

Name Description
id * Numeric ID, or key of the release phase to be deleted

DELETE /api/v1/release_phases/20526005

Example CURL command

curl "https://company.aha.io/api/v1/release_phases/20526005" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Overview

API Resources