Capacity scenarios API


GET /api/v1/capacity_scenarios

retrieve capacity scenarios

GET /api/v1/capacity_scenarios

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios" -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: 404 Not Found
  Content-Type: application/json; charset=utf-8
{
  "error": "Record not found."
}

GET /api/v1/capacity_scenarios/:id

retrieve capacity scenarios

Parameters

Name Description
id id

GET /api/v1/capacity_scenarios/997808419

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios/997808419" -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
{
  "capacity_scenario": {
    "id": 997808419,
    "name": "Default test scenario",
    "planning_interval": "month",
    "planning_start_date": "2019-01-01",
    "planning_end_date": "2019-01-01",
    "estimate_value_layout": "team_by_time",
    "data_entry_units": "headcount"
  }
}

GET /api/v1/capacity_scenarios/picker

retrieve capacity scenarios

Parameters

Name Description
id id

GET /api/v1/capacity_scenarios/picker?id=997808419

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios/picker?id=997808419" -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
{
  "options": [
    {
      "text": "Default test scenario",
      "value": 997808419
    },
    {
      "text": "Second test scenario",
      "value": 454855257
    }
  ]
}

GET /api/v1/capacity_scenarios/picker

retrieve capacity scenarios

Parameters

Name Description
id id

GET /api/v1/capacity_scenarios/picker?id=997808419

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios/picker?id=997808419" -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
{
  "options": [
    {
      "text": "Default test scenario",
      "value": 997808419
    },
    {
      "text": "Second test scenario",
      "value": 454855257
    }
  ]
}

Overview

API Resources