assign-objects-to-label

dci assign-objects-to-label id

Assigns or un-assigns objects to the label specified by the ID.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "description": "Request to assign or remove objects from a label.",
  "properties": {
    "add": {
      "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 to assign to the label."
    },
    "remove": {
      "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 to unassign from the label."
    }
  }
}

Output

On success, this command produces no response data.

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.

Aliases: assignobjectstolabel