v1

latestOpenAPI 3.0.02026-07-24900287.5 KB

Annotations

Update an annotation

patch/annotations/{id}

Path parameters

idstring required

Annotation Id

Request body

period_idstring

namestring

start_timenumber

Epoch Timestamp, seconds since 1970-01-01T00:00:00Z

start_centisecondsnumber

Centiseconds part of epoch timestamp (hundredths of a second, a number between 0 and 99)

end_timenumber

Epoch Timestamp, seconds since 1970-01-01T00:00:00Z

end_centisecondsnumber

Centiseconds part of epoch timestamp (hundredths of a second, a number between 0 and 99)

athlete_idsstring[]

Array of athlete IDs

parent_idstring

Parent annotation ID

draw_colorstring

rownumber

xnumber

ynumber

commentstring

imported_idstring nullable

Example request

{
  "name": "Kick",
  "start_time": 1642599395,
  "start_centiseconds": 45,
  "end_time": 1642599414,
  "end_centiseconds": 30,
  "athlete_ids": [
    "0a009851-6b47-432b-83dc-d589dac07148"
  ],
  "row": 1
}

Response

Updated Annotation Object

idstring

activity_idstring

parent_idstring

period_idstring

namestring

start_timenumber

Epoch Timestamp, seconds since 1970-01-01T00:00:00Z

start_centisecondsnumber

Centiseconds part of epoch timestamp (hundredths of a second, a number between 0 and 99)

end_timenumber

Epoch Timestamp, seconds since 1970-01-01T00:00:00Z

end_centisecondsnumber

Centiseconds part of epoch timestamp (hundredths of a second, a number between 0 and 99)

draw_colorstring

HTML color, e.g. #FF5500, the color to use when displaying this annotation on the timeline

rowinteger

Controls vertical position (row) when displaying this annotation on the timeline

created_atstring

modified_atstring

xnumber

ynumber

commentstring

imported_idstring nullable

athlete_idsstring[]

Array of athlete ids on annotation

Example response

{
  "created_at": "2023-10-31 23:59:59",
  "modified_at": "2023-10-31 23:59:59",
  "annotation_category": {
    "name": "Kick",
    "import_name": "play_type_kick",
    "start_offset": 15,
    "end_offset": 2,
    "default_color": "#A55F7B",
    "is_bakeable": 1,
    "created_at": "2023-10-31 23:59:59",
    "modified_at": "2023-10-31 23:59:59",
    "is_editable": 1
  },
  "annotation_metadata": [
    {
      "created_at": "2023-10-31 23:59:59",
      "modified_at": "2023-10-31 23:59:59"
    }
  ],
  "athlete_ids": [
    "4d1d947a-d795-4a24-85ed-919690c48283"
  ]
}