Skip to main content

create-annotation 

restish dci create-annotation

Creates a new annotation.

Request​

Content-Type: application/json

Schema​

{
  "required": [
    "content",
    "timestamp"
  ],
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "description": "The content of the annotation"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The date associated with the annotation"
    },
    "reports": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of report IDs associated with the annotation"
    }
  }
}

Responses​

201 (application/json)​

Created - Annotation created successfully.

{
  "required": [
    "id",
    "content",
    "timestamp"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the annotation"
    },
    "content": {
      "type": "string",
      "description": "The content of the annotation"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The date associated with the annotation"
    },
    "reports": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of report IDs associated with the annotation"
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the annotation was created"
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the annotation was last updated"
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: create-annotation, createannotation