ClassificationPlanResponseDto

Endpoints · All schemas

Field	Required	Description
added	Yes	Items that would be added or suggested
assetIds	Yes	Every item applying would change, for the apply call or a bulk job
durable	Yes	True when applying must run as a durable bulk job
items	Yes	The first items that would be added
matched	Yes	Items the rule matches now
removed	Yes	Items the rule applied that no longer match
truncated	Yes	True when there were more changes than one apply can carry
visualSearchAvailable	Yes	boolean

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: ClassificationScoredAssetDto

{
  "properties": {
    "added": {
      "description": "Items that would be added or suggested",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "assetIds": {
      "description": "Every item applying would change, for the apply call or a bulk job",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "durable": {
      "description": "True when applying must run as a durable bulk job",
      "type": "boolean"
    },
    "items": {
      "description": "The first items that would be added",
      "items": {
        "$ref": "#/components/schemas/ClassificationScoredAssetDto"
      },
      "type": "array"
    },
    "matched": {
      "description": "Items the rule matches now",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "removed": {
      "description": "Items the rule applied that no longer match",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "truncated": {
      "description": "True when there were more changes than one apply can carry",
      "type": "boolean"
    },
    "visualSearchAvailable": {
      "type": "boolean"
    }
  },
  "required": [
    "added",
    "assetIds",
    "durable",
    "items",
    "matched",
    "removed",
    "truncated",
    "visualSearchAvailable"
  ],
  "type": "object"
}