Returns a resource-by-cycle utilization heatmap for a board.

GET /api/plan/{boardId}/heatmap

Returns a resource-by-cycle utilization heatmap for a board.

cURL

curl --request GET \
  --url https://{install}/api/plan/{boardId}/heatmap \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{install}/api/plan/{boardId}/heatmap"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{install}/api/plan/{boardId}/heatmap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://{install}/api/plan/{boardId}/heatmap");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{install}/api/plan/{boardId}/heatmap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{install}/api/plan/{boardId}/heatmap"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{install}/api/plan/{boardId}/heatmap")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{install}/api/plan/{boardId}/heatmap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "resources": [
    {
      "userId": "<string>",
      "userName": "<string>",
      "resourceType": 123,
      "cycles": [
        {
          "cycleId": "<string>",
          "cycleName": "<string>",
          "plannedHours": 123,
          "capacityHours": 123,
          "utilizationPercent": 123
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

boardId · string · required

Response

200

application/json

OK

resources · object[]

Show child attributes