Skip to main content

DataSetVersionChangesViewModel

A set of changes made to a data set version that can optionally include any patch change sets associated with the data set version if it has patch version history.

Properties

Property Type Required Description
notes string false

Guideline notes that are associated with the data set version.

versionNumber string true

The version number. Follows semantic versioning e.g. 2.0 (major), 1.1 (minor), 2.1.1 (patch).

majorChanges ChangeSetViewModel true

Any major changes that were made to the data set.

minorChanges ChangeSetViewModel true

Any minor changes that were made to the data set.

patchHistory array (DataSetVersionChangeSet) false

Change logs for any patch versions associated with this change log

Example schema

{
  "notes": "string",
  "versionNumber": "1.0",
  "majorChanges": {
    "filters": [
      {
        "currentState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "previousState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        }
      }
    ],
    "filterOptions": [
      {
        "filter": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "options": [
          {
            "currentState": {
              "id": "q1g3J",
              "label": "State-funded primary"
            },
            "previousState": {
              "id": "q1g3J",
              "label": "State-funded primary"
            }
          }
        ]
      }
    ],
    "geographicLevels": [
      {
        "currentState": {
          "code": "NAT",
          "label": "National"
        },
        "previousState": {
          "code": "NAT",
          "label": "National"
        }
      }
    ],
    "indicators": [
      {
        "currentState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        },
        "previousState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        }
      }
    ],
    "locationGroups": [
      {
        "currentState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        },
        "previousState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        }
      }
    ],
    "locationOptions": [
      {
        "level": {
          "code": "NAT",
          "label": "National"
        },
        "options": [
          {
            "currentState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            },
            "previousState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            }
          }
        ]
      }
    ],
    "timePeriods": [
      {
        "currentState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        },
        "previousState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        }
      }
    ]
  },
  "minorChanges": {
    "filters": [
      {
        "currentState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "previousState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        }
      }
    ],
    "filterOptions": [
      {
        "filter": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "options": [
          {
            "currentState": {
              "id": "q1g3J",
              "label": "State-funded primary"
            },
            "previousState": {
              "id": "q1g3J",
              "label": "State-funded primary"
            }
          }
        ]
      }
    ],
    "geographicLevels": [
      {
        "currentState": {
          "code": "NAT",
          "label": "National"
        },
        "previousState": {
          "code": "NAT",
          "label": "National"
        }
      }
    ],
    "indicators": [
      {
        "currentState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        },
        "previousState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        }
      }
    ],
    "locationGroups": [
      {
        "currentState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        },
        "previousState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        }
      }
    ],
    "locationOptions": [
      {
        "level": {
          "code": "NAT",
          "label": "National"
        },
        "options": [
          {
            "currentState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            },
            "previousState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            }
          }
        ]
      }
    ],
    "timePeriods": [
      {
        "currentState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        },
        "previousState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        }
      }
    ]
  },
  "patchHistory": [
    {
      "notes": "string",
      "versionNumber": "1.0",
      "majorChanges": {
        "filters": [
          {
            "currentState": {
              "id": "BRlj4",
              "column": "school_type",
              "label": "School type",
              "hint": "Additional detail about the filter."
            },
            "previousState": {
              "id": "BRlj4",
              "column": "school_type",
              "label": "School type",
              "hint": "Additional detail about the filter."
            }
          }
        ],
        "filterOptions": [
          {
            "filter": {
              "id": "BRlj4",
              "column": "school_type",
              "label": "School type",
              "hint": "Additional detail about the filter."
            },
            "options": [
              {
                "currentState": {
                  "id": "q1g3J",
                  "label": "State-funded primary"
                },
                "previousState": {
                  "id": "q1g3J",
                  "label": "State-funded primary"
                }
              }
            ]
          }
        ],
        "geographicLevels": [
          {
            "currentState": {
              "code": "NAT",
              "label": "National"
            },
            "previousState": {
              "code": "NAT",
              "label": "National"
            }
          }
        ],
        "indicators": [
          {
            "currentState": {
              "id": "enW68",
              "column": "sess_authorised",
              "label": "Percentage of authorised sessions",
              "unit": "%",
              "decimalPlaces": 2
            },
            "previousState": {
              "id": "enW68",
              "column": "sess_authorised",
              "label": "Percentage of authorised sessions",
              "unit": "%",
              "decimalPlaces": 2
            }
          }
        ],
        "locationGroups": [
          {
            "currentState": {
              "level": {
                "code": "NAT",
                "label": "National"
              }
            },
            "previousState": {
              "level": {
                "code": "NAT",
                "label": "National"
              }
            }
          }
        ],
        "locationOptions": [
          {
            "level": {
              "code": "NAT",
              "label": "National"
            },
            "options": [
              {
                "currentState": {
                  "id": "bOmZ4",
                  "label": "Sheffield",
                  "code": "E12000003"
                },
                "previousState": {
                  "id": "bOmZ4",
                  "label": "Sheffield",
                  "code": "E12000003"
                }
              }
            ]
          }
        ],
        "timePeriods": [
          {
            "currentState": {
              "code": "AYQ1",
              "period": "2020/2021",
              "label": "2020/21 Q1"
            },
            "previousState": {
              "code": "AYQ1",
              "period": "2020/2021",
              "label": "2020/21 Q1"
            }
          }
        ]
      },
      "minorChanges": {
        "filters": [
          {
            "currentState": {
              "id": "BRlj4",
              "column": "school_type",
              "label": "School type",
              "hint": "Additional detail about the filter."
            },
            "previousState": {
              "id": "BRlj4",
              "column": "school_type",
              "label": "School type",
              "hint": "Additional detail about the filter."
            }
          }
        ],
        "filterOptions": [
          {
            "filter": {
              "id": "BRlj4",
              "column": "school_type",
              "label": "School type",
              "hint": "Additional detail about the filter."
            },
            "options": [
              {
                "currentState": {
                  "id": "q1g3J",
                  "label": "State-funded primary"
                },
                "previousState": {
                  "id": "q1g3J",
                  "label": "State-funded primary"
                }
              }
            ]
          }
        ],
        "geographicLevels": [
          {
            "currentState": {
              "code": "NAT",
              "label": "National"
            },
            "previousState": {
              "code": "NAT",
              "label": "National"
            }
          }
        ],
        "indicators": [
          {
            "currentState": {
              "id": "enW68",
              "column": "sess_authorised",
              "label": "Percentage of authorised sessions",
              "unit": "%",
              "decimalPlaces": 2
            },
            "previousState": {
              "id": "enW68",
              "column": "sess_authorised",
              "label": "Percentage of authorised sessions",
              "unit": "%",
              "decimalPlaces": 2
            }
          }
        ],
        "locationGroups": [
          {
            "currentState": {
              "level": {
                "code": "NAT",
                "label": "National"
              }
            },
            "previousState": {
              "level": {
                "code": "NAT",
                "label": "National"
              }
            }
          }
        ],
        "locationOptions": [
          {
            "level": {
              "code": "NAT",
              "label": "National"
            },
            "options": [
              {
                "currentState": {
                  "id": "bOmZ4",
                  "label": "Sheffield",
                  "code": "E12000003"
                },
                "previousState": {
                  "id": "bOmZ4",
                  "label": "Sheffield",
                  "code": "E12000003"
                }
              }
            ]
          }
        ],
        "timePeriods": [
          {
            "currentState": {
              "code": "AYQ1",
              "period": "2020/2021",
              "label": "2020/21 Q1"
            },
            "previousState": {
              "code": "AYQ1",
              "period": "2020/2021",
              "label": "2020/21 Q1"
            }
          }
        ]
      }
    }
  ]
}
This page was last reviewed on 17 July 2025.