/annotation_layer/{pk}/annotation/

POST

Annotation Layers

Create an Annotation layer

Request

Path Params

integer

required

The annotation layer pk for this annotation

Body Params application/json

end_dttm

string <date-time>

optional

The annotation end date time

json_metadata

string | null

optional

JSON metadata

long_descr

string | null

optional

A long description

short_descr

string

optional

A short description

>= 1 characters<= 500 characters

start_dttm

string <date-time>

optional

The annotation start date time

Example

{
    "end_dttm": "2019-08-24T14:15:22Z",
    "json_metadata": "string",
    "long_descr": "string",
    "short_descr": "string",
    "start_dttm": "2019-08-24T14:15:22Z"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/annotation_layer//annotation/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "end_dttm": "2019-08-24T14:15:22Z",
    "json_metadata": "string",
    "long_descr": "string",
    "short_descr": "string",
    "start_dttm": "2019-08-24T14:15:22Z"
}'

Responses

🟢201Created

application/json

Annotation added

Body

number

optional

result

object (AnnotationRestApi.post)

optional

end_dttm

string <date-time>

optional

The annotation end date time

json_metadata

string | null

optional

JSON metadata

long_descr

string | null

optional

A long description

short_descr

string

optional

A short description

>= 1 characters<= 500 characters

start_dttm

string <date-time>

optional

The annotation start date time

Example

{
    "id": 0,
    "result": {
        "end_dttm": "2019-08-24T14:15:22Z",
        "json_metadata": "string",
        "long_descr": "string",
        "short_descr": "string",
        "start_dttm": "2019-08-24T14:15:22Z"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

/annotation_layer/{pk}/annotation/

/annotation_layer/{pk}/annotation/{annotation_id}