ScoreConfigListJsonApiModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-score-config-list-json-api-model-schema.json",
  "title": "ScoreConfigListJsonApiModel",
  "description": "JSON API model for a paginated list of score configs.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gtm-data-quality-api-v1-api-openapi.yml#/components/schemas/ScoreConfigListJsonApiModel",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ScoreConfig"
      },
      "description": "The primary data of the document"
    },
    "meta": {
      "allOf": [
        {
          "$ref": "#/$defs/ScoreConfigListMeta"
        }
      ],
      "description": "Non-standard meta information about the document"
    },
    "links": {
      "allOf": [
        {
          "$ref": "#/$defs/ScoreConfigListLinks"
        }
      ],
      "description": "Links related to the primary data"
    }
  },
  "$defs": {
    "ScoreConfig": {
      "type": "object",
      "required": [
        "id",
        "type",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the resource"
        },
        "type": {
          "type": "string",
          "description": "The type of the resource",
          "default": "ScoreConfig",
          "pattern": "ScoreConfig"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/ScoreConfigAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        },
        "meta": {
          "allOf": [
            {
              "$ref": "#/$defs/ScoreConfigMeta"
            }
          ],
          "description": "Non-standard meta information about the resource",
          "readOnly": true
        }
      },
      "description": "A score configuration resource (identity, model type, and scoring elements)."
    },
    "ScoreConfigAttributes": {
      "type": "object",
      "required": [
        "name",
        "status",
        "modelType",
        "elements",
        "fieldsUsedInRules"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Display name for the score config."
        },
        "status": {
          "allOf": [
            {
              "$ref": "#/$defs/ScoreConfigStatus"
            }
          ],
          "description": "Lifecycle status of the score config.",
          "readOnly": true
        },
        "modelType": {
          "allOf": [
            {
              "$ref": "#/$defs/ScoreModelType"
            }
          ],
          "description": "Type of scoring model. Only `ATTRIBUTE` is currently supported.",
          "readOnly": true
        },
        "elements": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ScoreElement"
          },
          "description": "Ordered scoring elements that define how records are scored."
        },
        "fieldsUsedInRules": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Distinct input field names referenced by this config's elements, sorted\nalphabetically. Read-only; derived from `elements[].field`.",
          "readOnly": true
        }
      },
      "description": "Attributes of a score configuration."
    },
    "ScoreConfigListLinks": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "format": "uri",
          "description": "The link that generated the current response document"
        },
        "first": {
          "type": "string",
          "format": "uri",
          "description": "A link to the first page of data"
        },
        "last": {
          "type": "string",
          "format": "uri",
          "description": "A link to the last page of data"
        },
        "prev": {
          "type": "string",
          "format": "uri",
          "description": "A link to the previous page of data"
        },
        "next": {
          "type": "string",
          "format": "uri",
          "description": "A link to the next page of data"
        }
      },
      "description": "Paging links for score config list responses."
    },
    "ScoreConfigListMeta": {
      "type": "object",
      "required": [
        "page"
      ],
      "properties": {
        "page": {
          "allOf": [
            {
              "$ref": "#/$defs/ScoreConfigPageMeta"
            }
          ],
          "description": "Current page details and totals.",
          "readOnly": true
        }
      },
      "description": "Page meta-data for paginated score config list responses."
    },
    "ScoreConfigMeta": {
      "type": "object",
      "required": [
        "createdAt",
        "updatedAt"
      ],
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp at which this score config was created.",
          "readOnly": true
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp at which this score config was last updated.",
          "readOnly": true
        }
      },
      "description": "Non-standard metadata for a score config."
    },
    "ScoreConfigPageMeta": {
      "type": "object",
      "required": [
        "number",
        "size",
        "totalPages",
        "totalItems"
      ],
      "properties": {
        "number": {
          "type": "integer",
          "format": "uint32",
          "description": "Current page number (1-based).",
          "readOnly": true
        },
        "size": {
          "type": "integer",
          "format": "uint32",
          "description": "Number of items in the current page.",
          "readOnly": true
        },
        "totalPages": {
          "type": "integer",
          "format": "uint32",
          "description": "Total number of pages available.",
          "readOnly": true
        },
        "totalItems": {
          "type": "integer",
          "format": "uint32",
          "description": "Total number of items across all pages.",
          "readOnly": true
        }
      },
      "description": "Per-page metadata for paginated score config list responses."
    },
    "ScoreConfigStatus": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "ARCHIVED"
      ],
      "description": "Lifecycle status of a score configuration.",
      "x-enumDescriptions": {
        "ACTIVE": "The score config is active and available for scoring.",
        "ARCHIVED": "The score config has been archived (soft-deleted) and is no longer used for scoring."
      }
    },
    "ScoreCriterion": {
      "type": "object",
      "required": [
        "operator"
      ],
      "properties": {
        "operator": {
          "allOf": [
            {
              "$ref": "#/$defs/ScoreCriterionOperator"
            }
          ],
          "description": "Comparison operator. `DIVIDER` marks an OR boundary in a rule and carries no values."
        },
        "values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 100,
          "description": "Operand values for the operator. Omitted for nullary operators (boolean and\nnull checks) and for `DIVIDER`; a single entry for most text, number, and\ndate operators; exactly two for `NUM_BETWEEN`."
        }
      },
      "description": "A single comparison criterion within a score rule."
    },
    "ScoreCriterionOperator": {
      "type": "string",
      "enum": [
        "TEXT_EQUALS",
        "TEXT_NOT_EQUALS",
        "TEXT_CONTAINS",
        "TEXT_NOT_CONTAINS",
        "TEXT_STARTS",
        "TEXT_NOT_STARTS",
        "TEXT_ENDS",
        "TEXT_NOT_ENDS",
        "NUM_EQUALS",
        "NUM_MORE",
        "NUM_LESS",
        "NUM_BETWEEN",
        "BOOL_TRUE",
        "BOOL_FALSE",
        "IS_NULL",
        "IS_NOT_NULL",
        "DATE_EXACT",
        "DATE_AFTER",
        "DATE_BEFORE",
        "PICKLIST_EQUALS",
        "PICKLIST_NOT_EQUALS",
        "MULTIPICKLIST_EQUALS",
        "MULTIPICKLIST_NOT_EQUALS",
        "MULTIPICKLIST_HAS",
        "MULTIPICKLIST_HAS_NONE",
        "MULTIPICKLIST_HAS_ALL",
        "DIVIDER"
      ],
      "description": "Comparison operator for a score rule criterion.",
      "x-enumDescriptions": {
        "TEXT_EQUALS": "Field value equals the comparison value.",
        "TEXT_NOT_EQUALS": "Field value does not equal the comparison value.",
        "TEXT_CONTAINS": "Field value contains the comparison value as a substring.",
        "TEXT_NOT_CONTAINS": "Field value does not contain the comparison value as a substring.",
        "TEXT_STARTS": "Field value starts with the comparison value.",
        "TEXT_NOT_STARTS": "Field value does not start with the comparison value.",
        "TEXT_ENDS": "Field value ends with the comparison value.",
        "TEXT_NOT_ENDS": "Field value does not end with the comparison value.",
        "NUM_EQUALS": "Numeric field equals the comparison value.",
        "NUM_MORE": "Numeric field is greater than the comparison value.",
        "NUM_LESS": "Numeric field is less than the comparison value.",
        "NUM_BETWEEN": "Numeric field falls between the two comparison values.",
        "BOOL_TRUE": "Boolean field is true.",
        "BOOL_FALSE": "Boolean field is false.",
        "IS_NULL": "Field has no value.",
        "IS_NOT_NULL": "Field has a value.",
        "DATE_EXACT": "Date field equals the comparison date.",
        "DATE_AFTER": "Date field is after the comparison date.",
        "DATE_BEFORE": "Date field is before the comparison date.",
        "PICKLIST_EQUALS": "Single-select picklist value is the comparison value.",
        "PICKLIST_NOT_EQUALS": "Single-select picklist value is not the comparison value.",
        "MULTIPICKLIST_EQUALS": "Multi-select picklist exactly equals the comparison values.",
        "MULTIPICKLIST_NOT_EQUALS": "Multi-select picklist does not equal the comparison values.",
        "MULTIPICKLIST_HAS": "Multi-select picklist contains at least one comparison value.",
        "MULTIPICKLIST_HAS_NONE": "Multi-select picklist contains none of the comparison values.",
        "MULTIPICKLIST_HAS_ALL": "Multi-select picklist contains all of the comparison values.",
        "DIVIDER": "Starts an OR alternative in a rule; [A, B, DIVIDER, C] means (A AND B) OR C."
      }
    },
    "ScoreElement": {
      "type": "object",
      "required": [
        "field",
        "weight",
        "rules"
      ],
      "properties": {
        "field": {
          "type": "string",
          "description": "Name of the input field this element scores."
        },
        "weight": {
          "type": "number",
          "format": "double",
          "minimum": 0,
          "maximum": 100,
          "description": "Relative weight of this element in the weighted sum. Between `0` and `100`."
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ScoreRule"
          },
          "description": "Ordered rules evaluated for this element."
        }
      },
      "description": "A weighted scoring element bound to a single input field."
    },
    "ScoreModelType": {
      "type": "string",
      "enum": [
        "ATTRIBUTE"
      ],
      "description": "Type of scoring model.",
      "x-enumDescriptions": {
        "ATTRIBUTE": "Weighted attribute-scoring model: a weighted sum of per-field rule matches."
      }
    },
    "ScoreRule": {
      "type": "object",
      "required": [
        "name",
        "score",
        "criteria"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Display name for the rule."
        },
        "score": {
          "type": "number",
          "format": "double",
          "description": "Score contributed by this rule when its criteria match."
        },
        "criteria": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ScoreCriterion"
          },
          "description": "Ordered criteria evaluated for this rule. At least one is required."
        }
      },
      "description": "A scoring rule: criteria that, when matched, contribute `score` to the owning element."
    }
  }
}