get-label-assignments

restish dci get-label-assignments id

Returns the list of objects currently assigned to the label specified by the ID.

Responses

200 (application/json)

OK - Label assignments returned.

{
  "type": "object",
  "description": "Response containing the list of objects assigned to a label.",
  "properties": {
    "assignments": {
      "type": "array",
      "items": {
        "required": [
          "objectId",
          "objectType"
        ],
        "type": "object",
        "description": "Object identifier and type used for label assignments.",
        "properties": {
          "objectId": {
            "type": "string",
            "description": "The ID of the object to assign/unassign."
          },
          "objectType": {
            "type": "string",
            "enum": [
              "alert",
              "allocation",
              "budget",
              "metric",
              "report",
              "annotation"
            ],
            "description": "The type of the object."
          }
        }
      },
      "description": "Array of objects currently assigned to the label."
    }
  }
}

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: get-label-assignments, getlabelassignments