ClassificationHintResponse

Fields

10 fields

category · required: string
created_at: string or null
created_by_name: string or null
enabled · required: boolean
id · required: string
match_field · required: string
note: string or null
pattern · required: string
project_id · required: string
updated_at: string or null

Raw schema (JSON)

{
  "properties": {
    "category": {
      "title": "Category",
      "type": "string"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "match_field": {
      "title": "Match Field",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Note"
    },
    "pattern": {
      "title": "Pattern",
      "type": "string"
    },
    "project_id": {
      "title": "Project Id",
      "type": "string"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "id",
    "project_id",
    "match_field",
    "pattern",
    "category",
    "enabled"
  ],
  "title": "ClassificationHintResponse",
  "type": "object"
}

Used by endpoints

3 endpoints send or return this schema, on its own or inside another schema.

POST /api/v1/projects/{project_id}/classification-hints — Create Classification Hint
PATCH /api/v1/projects/{project_id}/classification-hints/{hint_id} — Update Classification Hint
GET /api/v1/projects/{project_id}/classification-hints — List Classification Hints

Used by schemas

ClassificationHintList

More details

Specification: OpenAPI JSON