Schema

Schemas are used for:
  • Defining Resources
  • Building queries
  • Request payload serialization
  • Response content deserialization
  • Validation
class snow.resource.schema.Schema(*args, **kwargs)[source]

Resource schema

__location__

API path

Example – Incident Schema

from snow.resource import Schema, fields


class Incident(Schema):
    __location__ = "/api/now/table/incident"

    sys_id = fields.Text(is_primary=True)
    number = fields.Text()
    description = fields.Text()
    short_description = fields.Text()
    priority = fields.Numeric()
    assignment_group = fields.Text(pluck=Joined.DISPLAY_VALUE)
    opened_at = fields.Datetime()

Fields

Schema Fields are classes used when defining a Schema, which is used in (de)serialization, validation, selection and more. Also, once instantiated, the field becomes compatible with the Snow query system.