update-annotation

dci update-annotation id

Updates the annotation specified by the Id.

Request

Content-Type: application/json

Example

{
  "content": "Updated annotation content"
}

Schema

{
  "type": "object",
  "description": "Request body for updating an annotation.",
  "properties": {
    "content": {
      "type": "string",
      "description": "The content of the annotation.",
      "nullable": true
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The date associated with the annotation.",
      "nullable": true
    },
    "reports": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of report IDs associated with the annotation.",
      "nullable": true
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of label IDs to associate with the annotation. Labels must already exist.",
      "nullable": true
    }
  }
}

Responses

200 (application/json)

OK - Annotation updated.

{
  "required": [
    "id",
    "content",
    "timestamp"
  ],
  "type": "object",
  "description": "Summary information about an annotation.",
  "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."
    },
    "labels": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "name"
        ],
        "type": "object",
        "description": "Metadata for a label.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the label."
          },
          "name": {
            "type": "string",
            "description": "The name of the label."
          }
        }
      },
      "description": "List of labels associated with the annotation."
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The creation time of the annotation."
    },
    "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",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

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

403 (application/json)

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

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

404 (application/json)

Not Found - The requested resource does not exist.

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

Aliases: update-annotation, updateannotation