Create Annotations

Create an Annotation. Requires a role of at least Analyst.

POST /projects/{projectId}/annotations

Create Annotations

cURL

curl --request POST \
  --url https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2022-02-15 12:00:00",
  "description": "Something interesting happened!",
  "tags": [
    123
  ]
}
'

import requests

url = "https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations"

payload = {
    "date": "2022-02-15 12:00:00",
    "description": "Something interesting happened!",
    "tags": [123]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2022-02-15 12:00:00',
    description: 'Something interesting happened!',
    tags: [123]
  })
};

fetch('https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'date' => '2022-02-15 12:00:00',
    'description' => 'Something interesting happened!',
    'tags' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations"

	payload := strings.NewReader("{\n  \"date\": \"2022-02-15 12:00:00\",\n  \"description\": \"Something interesting happened!\",\n  \"tags\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2022-02-15 12:00:00\",\n  \"description\": \"Something interesting happened!\",\n  \"tags\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2022-02-15 12:00:00\",\n  \"description\": \"Something interesting happened!\",\n  \"tags\": [\n    123\n  ]\n}"

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

201

{
  "status": "ok",
  "results": {
    "date": "2022-02-15 12:00:00",
    "description": "Something interesting happened!",
    "id": 123,
    "user": {
      "id": 123,
      "first_name": "John",
      "last_name": "Smith"
    },
    "tags": [
      {
        "id": 123,
        "name": "<string>"
      }
    ]
  }
}

{
  "error": "<string>",
  "status": "error"
}

{
  "error": "<string>",
  "status": "error"
}

Authorizations

Authorization · string · header · required

Service Account

Path Parameters

projectId · integer · required

Your project id (eg: 12345)

Body

application/json

date · string

A string representation of a date in "YYYY-MM-DD HH:mm:ss" format

Example:

"2022-02-15 12:00:00"

description · string

The text that will be shown when looking at the annotation

Example:

"Something interesting happened!"

tags · number[]

The ids of the tags to be added to the annotation

Response

201

application/json

Success

A JSON response object containing an annotation'

status · string · required

The status of the response

Example:

"ok"

results · AnnotationsEntry · object · required

Representation of a single annotation

Show child attributes