Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.75 KB

example.md

File metadata and controls

31 lines (21 loc) · 1.75 KB
Raw

Examples

This page provides examples to help you understand and implement OC4IDS. There are two examples:

Worked example

The worked example is a JSON file that conforms to the project package schema. It contains a single project that conforms to the project schema. You can view the complete worked example below or download the JSON file. You can also view excerpts from the worked example alongside each sub-schema in the schema reference documentation.

The worked example describes a fictional infrastructure project to upgrade a motorway in the UK with three related contracting processes. An example value is provided for each field in the schema, including:

  • forecasts and metrics that describe planned and actual physical progress
  • modifications that describe changes to the duration, scope and value of contracting processes
  • completion data, describing the final end date, value and scope of the project.
:jsonpointer:
:title: Worked example

Blank example

The blank example is a JSON file that conforms to the structure of the project schema. You can view the blank example below or download the JSON file. Field values are replaced with either:

  • Empty strings ("") or empty arrays ([])
  • The type of the field, e.g. "string" or "array"
  • The name of the codelist referenced by the field, e.g. "string from currency codelist"
:jsonpointer:
:title: Blank example