Skip to main content

update-insight-status (deprecated)

Deprecated

This command is deprecated and may be removed in a future release.

dci update-insight-status sourceID insightKey

Updates the display status (e.g. actionable, acknowledged, dismissed) of a single insight. Only insights created via the public API can have their status changed. Deprecated: use the status field on the create/update insight endpoint instead.

Request​

Content-Type: application/json

Schema​

{
  "type": "object",
  "description": "Request body for updating an insight's display status.",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "actionable",
        "acknowledged",
        "optimized",
        "dismissed",
        "in progress",
        "upgrade needed",
        "permissions needed"
      ],
      "description": "The display status of the insight."
    },
    "dismissalDetails": {
      "type": "object",
      "description": "Details for why an insight was dismissed.",
      "properties": {
        "reason": {
          "type": "string",
          "description": "The reason for dismissal.",
          "enum": [
            "not relevant",
            "not enough information",
            "not worth the effort",
            "inaccurate optimization opportunities"
          ]
        },
        "comment": {
          "type": "string",
          "description": "An optional free-text comment providing additional context."
        }
      }
    }
  }
}

Responses​

204​

Status updated successfully

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."
    }
  }
}

500 (application/json)​

Internal Server Error - Something went wrong with the DoiT API server.

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

Aliases: update-insight-status, updateinsightstatus