Skip to main content

assign-objects-to-label 

restish dci assign-objects-to-label id

Assigns or unassigns objects to the label specified by the Id.

Request​

Content-Type: application/json

Schema​

{
  "type": "object",
  "properties": {
    "add": {
      "type": "array",
      "items": {
        "required": [
          "objectId",
          "objectType"
        ],
        "type": "object",
        "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",
        "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"
    }
  }
}

Responses​

200​

OK - Objects assigned/unassigned successfully.

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: assign-objects-to-label, assignobjectstolabel