Skip to main content

Output Schema Validation

By default, records belonging to a dataset are processed with that dataset's transformation rules and passed to its child datasets, or to any associated destinations, without any validation of the transformation results. This corresponds to the default setting of the output_schema_validation_enabled attribute of data_sets, which is false.

To enable per-data_set validation of transformed records against the expected output_schema, issue a PUT request to change the setting to true:

Output Schema Validation: Request
PUT /data_sets/{data_set_id}?expand=1
...
Example Request Payload
{
  "output_schema_validation_enable": true
}
Output Schema Validation: Response
{
  "id": 5043,
  "owner": {
    "id": 10,
    "full_name": "Finance Demos",
    "email": "demo_finance@nexla.com"
  },
  "org": {
    "id": 1,
    "name": "Nexla",
    "email_domain": "nexla.com"
  },
  "version": 1,
  "name": "Short Volume",
  "description": null,
  "access_roles": ["owner"],
  "source_path": {},
  "resource_id": 5006,
  "resource_type": "SOURCE",
  "sample_service_id": 1,
  "data_source": {
    "id": 5006,
    "owner": {
      "id": 10,
      "full_name": "Finance Demos",
      "email": "demo_finance@nexla.com"
    },
    "org": {
      "id": 1,
      "name": "Nexla",
      "email_domain": "nexla.com"
    },
    "access_roles": ["owner"],
    "name": "Example Financial Data Source",
    "description": null,
    "status": "ACTIVE",
    "updated_at": "2017-03-02T20:53:18.000Z",
    "created_at": "2017-03-02T20:53:18.000Z"
  },
  "source_schema_id": "869426765",
  "source_schema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "$schema-id": 869426765,
    "properties": {
      "Date": {
        "type": "string"
      },
      "ShortExemptVolume": {
        "type": "string"
      },
      "ShortVolume": {
        "type": "string"
      },
      "TotalVolume": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "parent_data_set": null,
  "has_custom_transform": false,
  "transform": {
    "version": 1,
    "data_maps": [],
    "transforms": []
  },
  "output_schema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "$schema-id": 869426765,
    "properties": {
      "Date": {
        "type": "string"
      },
      "ShortExemptVolume": {
        "type": "string"
      },
      "ShortVolume": {
        "type": "string"
      },
      "TotalVolume": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "output_schema_validation_enabled": true,
  "updated_at": "2017-03-04T22:11:16.000Z",
  "created_at": "2017-03-02T20:53:18.000Z"
}