Saving annotation in canvas

Developing

POST

/project/{projectId}/model/{projectModelId}/annotation/save

Persist the current state of an annotation drawn or edited on an interactive canvas or graphical interface, ensuring changes are saved.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/project//model//annotation/save' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageNumber": 3,
    "canvasData": {
        "shapes": [
            {
                "type": "rectangle",
                "x": 50,
                "y": 100,
                "width": 120,
                "height": 80,
                "color": "blue"
            },
            {
                "type": "circle",
                "x": 200,
                "y": 150,
                "radius": 40,
                "color": "red"
            }
        ],
        "comments": "Initial markup complete for review."
    }
}'

Response Example

{}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

projectId

string

required

projectModelId

string

required

Body Params application/json

object {0}

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2025-06-06 14:57:18

Create the annotation

Updating the Annotation