schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
paf-module.schema.json | A settings.paf file used by Qualisys Project Automation Framework (PAF) Modules | {"$schema": "https://json-schema.org/draft/2020-12/schema", "line_endings": "unix", "type": "object", "properties": {"Project ID": {"type": "string"}, "Root type": {"type": "string"}, "Date format": {"enum": ["Iso", "Little endian", "Middle endian"]}, "Date separator": {"enum": ["Dash", "Slash", "Dot", "None"]}, "Time format": {"enum": ["12-hour", "24-hour"]}, "Filename filter": {"type": "string"}, "Export c3d settings": {"type": "object", "properties": {"Point units": {"enum": ["mm", "cm", "m"]}}}, "Default fields": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Package Information": {"type": "object", "properties": {"Name": {"type": "string"}, "Version": {"type": "string", "pattern": "^\\d+\\.\\d+(\\.\\d+(\\+\\d+)?)?$"}, "Required QTM version": {"type": "string", "pattern": "^\\d+\\.\\d+(\\.\\d+)?$"}, "Previous names": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "required": ["Name", "Version", "Required QTM version"]}, "Types": {"type": "object", "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Children": {"type": "array", "items": {"type": "string"}}, "Measurements": {"type": "array", "items": {"type": "string"}}, "Analyses": {"type": "array", "items": {"type": "string"}}, "Display order": {"type": "array", "items": {"type": "string"}}, "Heading": {"type": "string"}, "PDF guide": {"type": "string"}, "Directory pattern": {"type": "string"}, "Icon": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "oneOf": [{"required": ["Children"]}, {"required": ["Measurements"]}]}}}}}, "Measurements": {"type": "object", "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Count": {"type": "integer", "minimum": 0}, "Minimum count": {"type": "integer", "minimum": 0}, "Maximum count": {"type": "integer", "minimum": 0}, "Measurement length": {"type": "number", "minimum": 0}, "Pretrigger length": {"type": "number", "minimum": 0}, "Frequency": {"type": "number", "minimum": 1}, "AIM models": {"type": "string"}, "Display fields dialog after creation": {}, "Heading": {"type": "string"}, "Display order": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Measurement pattern": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "null"}]}}}}}, "Analyses": {"type": "object", "patternProperties": {".+": {"properties": {"Type": {"enum": ["External program", "Visual3D", "Report", "Compound", "HTTPRequest", "Instantiate template", "Create skeleton", "Solve skeleton"]}, "Prerequisites": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Output file": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]}, "Program display name": {"type": "string"}, "Export session": {}, "Export measurements": {"anyOf": [{"type": "array", "items": {"type": "string", "enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}, "minItems": 1}, {"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}]}, "Template files": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]}, "Working directory": {"type": "string"}, "Arguments": {"type": "array", "items": {"type": "string"}}, "Show output file": {}, "Do not wait for Application": {}, "Pipeline template": {"type": "string"}, "Do not wait for Visual3D": {}, "Close Visual3D": {"deprecated": true, "enum": ["Never", "No Warnings"]}, "Components": {"type": "array", "items": {"type": "string"}}, "Template": {"type": "string"}, "Measurements": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "Exclude": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}}}}}, "Fields": {"type": "object", "patternProperties": {".+": {"properties": {"Type": {"enum": ["Integer", "Float", "String", "Date", "TimeOfDay", "Enum", "Boolean"]}, "Hidden": {}, "Readonly": {}, "Inherit": {"enum": ["Copy", "Connect"]}, "Default": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}, "Max": {"type": "number"}, "Min": {"type": "number"}, "Quantity": {"enum": ["Length", "Mass", "Voltage", "Current", "Force", "Moment", "Power", "Angle", "Time", "Frequency", "Temperature", "Speed", "Acceleration", "Magnetic field strength", "Rotational speed"]}, "Unit": {"enum": ["meters", "\u00e5ngstroms", "nanometers", "microns", "millimeters", "centimeters", "kilometers", "inches", "feet", "yards", "miles", "kilograms", "micrograms", "milligrams", "grams", "ounces", "pounds", "volts", "nanovolts", "microvolts", "millivolts", "kilovolts", "ampere", "nanoampere", "microampere", "milliampere", "kiloampere", "newtons", "millinewtons", "kilonewtons", "meganewtons", "kiloponds", "pounds force", "newtonmeter", "newtonmillimeter", "watt", "radians", "degrees", "seconds", "minutes", "hours", "hertz", "kilohertz", "megahertz", "revolutions per minute", "beats per minute", "kelvin", "degrees celsius", "degrees farenheit", "meters per second", "millimeters per second", "kilometers per hour", "feet per second", "miles per hour", "knots", "meters per second squared", "millimeters per second squared", "feet per second squared", "standard gravity", "tesla", "millitesla", "degrees per second", "Meters", "\u00c5ngstroms", "Nanometers", "Microns", "Millimeters", "Centimeters", "Kilometers", "Inches", "Feet", "Yards", "Miles", "Kilograms", "Micrograms", "Milligrams", "Grams", "Ounces", "Pounds", "Volts", "Nanovolts", "Microvolts", "Millivolts", "Kilovolts", "Ampere", "Nanoampere", "Microampere", "Milliampere", "Kiloampere", "Newtons", "Millinewtons", "Kilonewtons", "Meganewtons", "Kiloponds", "Pounds force", "Newtonmeter", "Newtonmillimeter", "Watt", "Radians", "Degrees", "Seconds", "Minutes", "Hours", "Hertz", "Kilohertz", "Megahertz", "Revolutions per minute", "Beats per minute", "Kelvin", "Degrees celsius", "Degrees farenheit", "Meters per second", "Millimeters per second", "Kilometers per hour", "Feet per second", "Miles per hour", "Knots", "Meters per second squared", "Millimeters per second squared", "Feet per second squared", "Standard gravity", "Tesla", "Millitesla", "Degrees per second", "m/s"]}, "Decimals": {"type": "integer"}, "Force": {}, "JSON": {}, "Values": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}}, "Display": {"enum": ["yesno", "checkbox", "truefalse", "YesNo", "Checkbox", "TrueFalse"]}}, "required": ["Type"]}}}, "Columns": {"type": "object", "patternProperties": {".+": {"patternProperties": {".+": {"properties": {"Width": {"type": "integer"}, "Field": {"type": "string"}, "Fields": {"type": "object", "properties": {"Default": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"Name": {"type": "string"}, "Editable": {}}}]}}}}}}}}}}, "required": ["Project ID", "Root type", "Types", "Columns"], "$defs": {"yaml-boolean": {"oneOf": [{"type": "boolean"}, {"type": "string", "enum": ["Yes", "yes", "No", "no"]}]}}} |
|
paf-module.schema.json | Project ID | A human readable name that identifies the project. This name is recorded in data files and should not be changed once data collection has started as doing so will render data files useless. | {"type": "string"} |
paf-module.schema.json | Root type | Reference to the class or type name to use at the highest level in the PAF item hierarchy. | {"type": "string"} |
paf-module.schema.json | Date format | Specifies what date format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are Iso, Little endian and Middle endian. | {"enum": ["Iso", "Little endian", "Middle endian"]} |
paf-module.schema.json | Date separator | Specifies which token to use to separate the parts of the dates when formatting them. Accepted values are Dash, Slash, Dot and None. | {"enum": ["Dash", "Slash", "Dot", "None"]} |
paf-module.schema.json | Time format | Specifies what time format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are 12-hour and 24-hour. | {"enum": ["12-hour", "24-hour"]} |
paf-module.schema.json | Filename filter | A regular expression that determines which files (in addition to the qtm files) that will be visible in the tree view. | {"type": "string"} |
paf-module.schema.json | Export c3d settings | This section is optional and is used when exporting to c3d file. | {"type": "object", "properties": {"Point units": {"enum": ["mm", "cm", "m"]}}} |
paf-module.schema.json | Point units | Possible units are: mm, cm or m. | {"enum": ["mm", "cm", "m"]} |
paf-module.schema.json | Default fields | A sequence of names of fields that will be added to all types. QTM also adds a number of default fields automatically. For a list of these, see the Default Fields section. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
paf-module.schema.json | Package Information | This section contains information that the package management system uses. It is used mainly when installing packages and when creating new projects based on a package. | {"type": "object", "properties": {"Name": {"type": "string"}, "Version": {"type": "string", "pattern": "^\\d+\\.\\d+(\\.\\d+(\\+\\d+)?)?$"}, "Required QTM version": {"type": "string", "pattern": "^\\d+\\.\\d+(\\.\\d+)?$"}, "Previous names": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "required": ["Name", "Version", "Required QTM version"]} |
paf-module.schema.json | Name | The name of the package. Shown when creating a new project and used to keep the connection between a project and the package it was created from to, for instance, know if there is a new version of a package. This means that this value should not be changed unless strictly necessary because that will break the connection between existing projects and new versions of the package. | {"type": "string"} |
paf-module.schema.json | Version | Two numbers separated by a period sign (e.g. 44.23), three numbers separated by period signs (e.g. 1.45.3214), or three numbers separated by a period sign and a build number separated by a plus sign (e.g. 1.3.0+188). The version of the package. Used to keep track of which version a project is based on. Visible in the about box when a project is open. Useful for debugging purposes and for knowing if the package can be upgraded. | {"type": "string", "pattern": "^\\d+\\.\\d+(\\.\\d+(\\+\\d+)?)?$"} |
paf-module.schema.json | Required QTM version | Two or three digits separated by a period sign. The QTM version that is required for this package to work properly. Checked on install time. Must include major and minor version number and can optionally include build number too. | {"type": "string", "pattern": "^\\d+\\.\\d+(\\.\\d+)?$"} |
paf-module.schema.json | Previous names | A sequence of names that this package has had earlier in development. This is used only when checking if a project should be upgraded and allows for packages to be renamed without losing the project upgrade path. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
paf-module.schema.json | Types | {"type": "object", "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Children": {"type": "array", "items": {"type": "string"}}, "Measurements": {"type": "array", "items": {"type": "string"}}, "Analyses": {"type": "array", "items": {"type": "string"}}, "Display order": {"type": "array", "items": {"type": "string"}}, "Heading": {"type": "string"}, "PDF guide": {"type": "string"}, "Directory pattern": {"type": "string"}, "Icon": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "oneOf": [{"required": ["Children"]}, {"required": ["Measurements"]}]}}}}} |
|
paf-module.schema.json | .+ | All type names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values. | {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Children": {"type": "array", "items": {"type": "string"}}, "Measurements": {"type": "array", "items": {"type": "string"}}, "Analyses": {"type": "array", "items": {"type": "string"}}, "Display order": {"type": "array", "items": {"type": "string"}}, "Heading": {"type": "string"}, "PDF guide": {"type": "string"}, "Directory pattern": {"type": "string"}, "Icon": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "oneOf": [{"required": ["Children"]}, {"required": ["Measurements"]}]}}} |
paf-module.schema.json | Fields | Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information. | {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]} |
paf-module.schema.json | .+ | All class names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values. | {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Children": {"type": "array", "items": {"type": "string"}}, "Measurements": {"type": "array", "items": {"type": "string"}}, "Analyses": {"type": "array", "items": {"type": "string"}}, "Display order": {"type": "array", "items": {"type": "string"}}, "Heading": {"type": "string"}, "PDF guide": {"type": "string"}, "Directory pattern": {"type": "string"}, "Icon": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]}}, "oneOf": [{"required": ["Children"]}, {"required": ["Measurements"]}]} |
paf-module.schema.json | Fields | Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class. | {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]} |
paf-module.schema.json | Children | A sequence of references to class or type names that can be created as children to items of this type. A type that has children cannot have measurements. | {"type": "array", "items": {"type": "string"}} |
paf-module.schema.json | Measurements | A sequence of measurement type names. If a type has the measurement property, it is considered to be a session-like type. It cannot have other children and it will have a wizard interface containing measurements (of the types specified by this parameter) and analyses. | {"type": "array", "items": {"type": "string"}} |
paf-module.schema.json | Analyses | A sequence of analysis names. These will be shown in the Analyze dropdown of the session wizard. The first analysis in the list will be the default analysis that is run when the button itself is clicked. | {"type": "array", "items": {"type": "string"}} |
paf-module.schema.json | Display order | A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order. | {"type": "array", "items": {"type": "string"}} |
paf-module.schema.json | Heading | An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane. | {"type": "string"} |
paf-module.schema.json | PDF guide | The path to a PDF file to show when the user clicks the Show guide button in the wizard pane. | {"type": "string"} |
paf-module.schema.json | Directory pattern | A naming pattern for the directory created for each item (except measurements, for which this property is useless).
The pattern can contain any text as well as names of items braced by $ signs, so for instance the directory pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.
An item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.
The default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique. | {"type": "string"} |
paf-module.schema.json | Icon | The path to an icon file (.ico) to show at the side of the item in the tree view. The path is relative to the `Templates` folder. | {"type": "string"} |
paf-module.schema.json | .+ | Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information. | {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "null"}]} |
paf-module.schema.json | Measurements | {"type": "object", "patternProperties": {".+": {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Count": {"type": "integer", "minimum": 0}, "Minimum count": {"type": "integer", "minimum": 0}, "Maximum count": {"type": "integer", "minimum": 0}, "Measurement length": {"type": "number", "minimum": 0}, "Pretrigger length": {"type": "number", "minimum": 0}, "Frequency": {"type": "number", "minimum": 1}, "AIM models": {"type": "string"}, "Display fields dialog after creation": {}, "Heading": {"type": "string"}, "Display order": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Measurement pattern": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "null"}]}}}}} |
|
paf-module.schema.json | .+ | A uniquely named measurement, defining its properties. | {"properties": {"Fields": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]}, "Count": {"type": "integer", "minimum": 0}, "Minimum count": {"type": "integer", "minimum": 0}, "Maximum count": {"type": "integer", "minimum": 0}, "Measurement length": {"type": "number", "minimum": 0}, "Pretrigger length": {"type": "number", "minimum": 0}, "Frequency": {"type": "number", "minimum": 1}, "AIM models": {"type": "string"}, "Display fields dialog after creation": {}, "Heading": {"type": "string"}, "Display order": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Measurement pattern": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "null"}]}}} |
paf-module.schema.json | Fields | Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class. | {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "object", "patternProperties": {".+": {"type": "string"}}}]} |
paf-module.schema.json | Count | The default number of measurement buttons that kind of measurement in a new session. | {"type": "integer", "minimum": 0} |
paf-module.schema.json | Minimum count | The minimum number of measurements of that kind in a session. The +/- buttons will not allow the count to go below this and if any analysis lists this kind of measurement as a prerequisite, the analysis will not be available until the minimum number of measurements have been performed. | {"type": "integer", "minimum": 0} |
paf-module.schema.json | Maximum count | The maximum number of measurements of that kind in a session. | {"type": "integer", "minimum": 0} |
paf-module.schema.json | Measurement length | The default length of this kind of measurement. | {"type": "number", "minimum": 0} |
paf-module.schema.json | Pretrigger length | The length of the pretrigger buffer. Setting this to zero disables pretrigger. Leaving this option out uses the project setting for pretrigger. | {"type": "number", "minimum": 0} |
paf-module.schema.json | Frequency | The frequency used for this kind of measurement. If omitted, the frequency is not changed when starting the measurement. | {"type": "number", "minimum": 1} |
paf-module.schema.json | AIM models | A semicolon separated list (not a YAML sequence) of AIM models that should be applied to measurements of this kind. | {"type": "string"} |
paf-module.schema.json | Display fields dialog after creation | If this value is set to true, the fields dialog will be displayed when a measurement has finished to allow the user to edit the fields of the measurement item in the same way that dialog is displayed when other (non-measurement) items are created. | {} |
paf-module.schema.json | Heading | An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane. | {"type": "string"} |
paf-module.schema.json | Display order | A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
paf-module.schema.json | Measurement pattern | A naming pattern for measurements created for each item. The pattern can contain any text as well as names of items braced by $ signs, so for instance the measurement pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.
An item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.
The default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique. The file extension .qtm will be added automatically. The default value is $TypeName$ $InstanceNumber$. | {"type": "string"} |
paf-module.schema.json | .+ | Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information. | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
paf-module.schema.json | Analyses | {"type": "object", "patternProperties": {".+": {"properties": {"Type": {"enum": ["External program", "Visual3D", "Report", "Compound", "HTTPRequest", "Instantiate template", "Create skeleton", "Solve skeleton"]}, "Prerequisites": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Output file": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]}, "Program display name": {"type": "string"}, "Export session": {}, "Export measurements": {"anyOf": [{"type": "array", "items": {"type": "string", "enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}, "minItems": 1}, {"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}]}, "Template files": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]}, "Working directory": {"type": "string"}, "Arguments": {"type": "array", "items": {"type": "string"}}, "Show output file": {}, "Do not wait for Application": {}, "Pipeline template": {"type": "string"}, "Do not wait for Visual3D": {}, "Close Visual3D": {"deprecated": true, "enum": ["Never", "No Warnings"]}, "Components": {"type": "array", "items": {"type": "string"}}, "Template": {"type": "string"}, "Measurements": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "Exclude": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}}}}} |
|
paf-module.schema.json | .+ | A uniquely named analysis, defining its properties. | {"properties": {"Type": {"enum": ["External program", "Visual3D", "Report", "Compound", "HTTPRequest", "Instantiate template", "Create skeleton", "Solve skeleton"]}, "Prerequisites": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "Output file": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]}, "Program display name": {"type": "string"}, "Export session": {}, "Export measurements": {"anyOf": [{"type": "array", "items": {"type": "string", "enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}, "minItems": 1}, {"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}]}, "Template files": {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]}, "Working directory": {"type": "string"}, "Arguments": {"type": "array", "items": {"type": "string"}}, "Show output file": {}, "Do not wait for Application": {}, "Pipeline template": {"type": "string"}, "Do not wait for Visual3D": {}, "Close Visual3D": {"deprecated": true, "enum": ["Never", "No Warnings"]}, "Components": {"type": "array", "items": {"type": "string"}}, "Template": {"type": "string"}, "Measurements": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "Exclude": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}}} |
paf-module.schema.json | Type | Names of the analysis type. Valid values are External program, Visual3D, Report, Compound, HTTPRequest, Instantiate template, Create skeleton, Solve skeleton.
Note: only External program and Compound are available to all users. Other types require the Project Automation Framework developer license which is used for internal Qualisys development and by development partners. | {"enum": ["External program", "Visual3D", "Report", "Compound", "HTTPRequest", "Instantiate template", "Create skeleton", "Solve skeleton"]} |
paf-module.schema.json | Prerequisites | A sequence of measurement type names and analysis names that has to be completed before this analysis can be run. Measurement types are considered complete for the current session when the user has made at least the number of measurements given by that measurement type’s Minimum count field. Analyses are considered complete when the file denoted by the Output file field exists. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
paf-module.schema.json | Output file | The name of a file that is created when this analysis is run. QTM uses this to check if the analysis has been completed. It is also used to issue a warning if this file has been changed since the analysis was last run for the current session. This property can contain patterns. | {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]} |
paf-module.schema.json | Program display name | External program only: The name to be displayed in the directories tab in project options where the user will have to locate the external executable. NB: Because this path varies between computers rather than between projects, it is not stored in the project, but in computer-global settings file.
Several analyses in different projects may share the same Program display name and QTM will automatically use the same executable path for all of them. | {"type": "string"} |
paf-module.schema.json | Export session | External program only: Optional. If present, the metadata of the session, all its ancestors and the measurements are exported into a file called session.xml. | {} |
paf-module.schema.json | Export measurements | External program only: Optional. A single string or an array containing any combination of the following values: “TSV”, “C3D”, “MAT”. Will make QTM export all the selected measurements to the corresponding formats before running the external program. Use “xml settings” to export a file with measurement settings (e.g. capture start time and analog channel names). The file will be named [file name].settings.xml. | {"anyOf": [{"type": "array", "items": {"type": "string", "enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}, "minItems": 1}, {"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]}]} |
paf-module.schema.json | Template files | External program only: Optional. A single string or an array containing names of files in the template directory. Each file will be run through the PHP engine and the result written to a file with the same name in the session directory. Standard Windows wildcards are supported, but note that if the asterisk is used to match a part of the filename, the pattern must be enclosed in single quotation marks to make sure it is not parsed as a YAML alias. | {"anyOf": [{"type": "array", "items": {"type": "string"}, "minItems": 1}, {"type": "string"}]} |
paf-module.schema.json | Working directory | External program only: Optional. The working directory set when the program is launched. Defaults to the session directory. | {"type": "string"} |
paf-module.schema.json | Arguments | Optional. An array of arguments to be sent to the program being started. Each argument will be subject to pattern expansion and if the result contains spaces, it will be enclosed in double quotation marks when the command line is built. | {"type": "array", "items": {"type": "string"}} |
paf-module.schema.json | Show output file | External program only: Optional. If set, and if the Output file property has been specified, and if the execution of the external program is successful (exit code 0), the output file will be shown in the systems standard program for that file type (as if it was double-clicked in the windows explorer). | {} |
paf-module.schema.json | Do not wait for Application | External program only: Optional. If analysis includes this property, QTM does not wait for external program to finish the processing. If property does not exit, to continue with subsequent analyses, external program must be closed manually (> QTM 2019.1). | {} |
paf-module.schema.json | Pipeline template | Visual3D analysis only: Required. The name of a template file in the Templates directory. This file will be instantiated and used as the pipeline script in visual 3d. | {"type": "string"} |
paf-module.schema.json | Do not wait for Visual3D | Visual3D analysis only: Optional. If analysis includes this property, QTM does not wait for Visual3D to finish the processing. If property does not exit, to continue with subsequent analyses, Visual3D must be closed manually or Exit_Workspace; command has to be added to the very end of Visual3D script. | {} |
paf-module.schema.json | Close Visual3D | Visual3D analysis only: Deprecated (> QTM 2.16). | {"deprecated": true, "enum": ["Never", "No Warnings"]} |
paf-module.schema.json | Components | Compound analysis only. Required. An array of analysis steps. | {"type": "array", "items": {"type": "string"}} |
paf-module.schema.json | Template | Instantiate template analysis only: Required. The name of the input file. If this name contains any path delimiter tokens, it will be considered to be relative to the project directory, otherwise QTM will assume that the input file is placed in the templates folder. | {"type": "string"} |
paf-module.schema.json | Measurements | Create / Solve skeleton analyses only: Required. A string or list of strings to specify the file names to solve the skeletons. Wildcard can be used in the name to specify multiple files at once. To specify all measurements, simply use the wildcard character. Only measurements that are marked as used in the PAF pane will be affected. | {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]} |
paf-module.schema.json | Exclude | Create / Solve skeleton analyses only: Optional. A string or list of strings to specify the file names to exclude. Wildcard can be used in the name to specify multiple files at once. Only measurements that are marked as used in the PAF pane will be affected. | {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]} |
paf-module.schema.json | Fields | {"type": "object", "patternProperties": {".+": {"properties": {"Type": {"enum": ["Integer", "Float", "String", "Date", "TimeOfDay", "Enum", "Boolean"]}, "Hidden": {}, "Readonly": {}, "Inherit": {"enum": ["Copy", "Connect"]}, "Default": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}, "Max": {"type": "number"}, "Min": {"type": "number"}, "Quantity": {"enum": ["Length", "Mass", "Voltage", "Current", "Force", "Moment", "Power", "Angle", "Time", "Frequency", "Temperature", "Speed", "Acceleration", "Magnetic field strength", "Rotational speed"]}, "Unit": {"enum": ["meters", "\u00e5ngstroms", "nanometers", "microns", "millimeters", "centimeters", "kilometers", "inches", "feet", "yards", "miles", "kilograms", "micrograms", "milligrams", "grams", "ounces", "pounds", "volts", "nanovolts", "microvolts", "millivolts", "kilovolts", "ampere", "nanoampere", "microampere", "milliampere", "kiloampere", "newtons", "millinewtons", "kilonewtons", "meganewtons", "kiloponds", "pounds force", "newtonmeter", "newtonmillimeter", "watt", "radians", "degrees", "seconds", "minutes", "hours", "hertz", "kilohertz", "megahertz", "revolutions per minute", "beats per minute", "kelvin", "degrees celsius", "degrees farenheit", "meters per second", "millimeters per second", "kilometers per hour", "feet per second", "miles per hour", "knots", "meters per second squared", "millimeters per second squared", "feet per second squared", "standard gravity", "tesla", "millitesla", "degrees per second", "Meters", "\u00c5ngstroms", "Nanometers", "Microns", "Millimeters", "Centimeters", "Kilometers", "Inches", "Feet", "Yards", "Miles", "Kilograms", "Micrograms", "Milligrams", "Grams", "Ounces", "Pounds", "Volts", "Nanovolts", "Microvolts", "Millivolts", "Kilovolts", "Ampere", "Nanoampere", "Microampere", "Milliampere", "Kiloampere", "Newtons", "Millinewtons", "Kilonewtons", "Meganewtons", "Kiloponds", "Pounds force", "Newtonmeter", "Newtonmillimeter", "Watt", "Radians", "Degrees", "Seconds", "Minutes", "Hours", "Hertz", "Kilohertz", "Megahertz", "Revolutions per minute", "Beats per minute", "Kelvin", "Degrees celsius", "Degrees farenheit", "Meters per second", "Millimeters per second", "Kilometers per hour", "Feet per second", "Miles per hour", "Knots", "Meters per second squared", "Millimeters per second squared", "Feet per second squared", "Standard gravity", "Tesla", "Millitesla", "Degrees per second", "m/s"]}, "Decimals": {"type": "integer"}, "Force": {}, "JSON": {}, "Values": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}}, "Display": {"enum": ["yesno", "checkbox", "truefalse", "YesNo", "Checkbox", "TrueFalse"]}}, "required": ["Type"]}}} |
|
paf-module.schema.json | .+ | A uniquely named field, defining its properties. | {"properties": {"Type": {"enum": ["Integer", "Float", "String", "Date", "TimeOfDay", "Enum", "Boolean"]}, "Hidden": {}, "Readonly": {}, "Inherit": {"enum": ["Copy", "Connect"]}, "Default": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}, "Max": {"type": "number"}, "Min": {"type": "number"}, "Quantity": {"enum": ["Length", "Mass", "Voltage", "Current", "Force", "Moment", "Power", "Angle", "Time", "Frequency", "Temperature", "Speed", "Acceleration", "Magnetic field strength", "Rotational speed"]}, "Unit": {"enum": ["meters", "\u00e5ngstroms", "nanometers", "microns", "millimeters", "centimeters", "kilometers", "inches", "feet", "yards", "miles", "kilograms", "micrograms", "milligrams", "grams", "ounces", "pounds", "volts", "nanovolts", "microvolts", "millivolts", "kilovolts", "ampere", "nanoampere", "microampere", "milliampere", "kiloampere", "newtons", "millinewtons", "kilonewtons", "meganewtons", "kiloponds", "pounds force", "newtonmeter", "newtonmillimeter", "watt", "radians", "degrees", "seconds", "minutes", "hours", "hertz", "kilohertz", "megahertz", "revolutions per minute", "beats per minute", "kelvin", "degrees celsius", "degrees farenheit", "meters per second", "millimeters per second", "kilometers per hour", "feet per second", "miles per hour", "knots", "meters per second squared", "millimeters per second squared", "feet per second squared", "standard gravity", "tesla", "millitesla", "degrees per second", "Meters", "\u00c5ngstroms", "Nanometers", "Microns", "Millimeters", "Centimeters", "Kilometers", "Inches", "Feet", "Yards", "Miles", "Kilograms", "Micrograms", "Milligrams", "Grams", "Ounces", "Pounds", "Volts", "Nanovolts", "Microvolts", "Millivolts", "Kilovolts", "Ampere", "Nanoampere", "Microampere", "Milliampere", "Kiloampere", "Newtons", "Millinewtons", "Kilonewtons", "Meganewtons", "Kiloponds", "Pounds force", "Newtonmeter", "Newtonmillimeter", "Watt", "Radians", "Degrees", "Seconds", "Minutes", "Hours", "Hertz", "Kilohertz", "Megahertz", "Revolutions per minute", "Beats per minute", "Kelvin", "Degrees celsius", "Degrees farenheit", "Meters per second", "Millimeters per second", "Kilometers per hour", "Feet per second", "Miles per hour", "Knots", "Meters per second squared", "Millimeters per second squared", "Feet per second squared", "Standard gravity", "Tesla", "Millitesla", "Degrees per second", "m/s"]}, "Decimals": {"type": "integer"}, "Force": {}, "JSON": {}, "Values": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}}, "Display": {"enum": ["yesno", "checkbox", "truefalse", "YesNo", "Checkbox", "TrueFalse"]}}, "required": ["Type"]} |
paf-module.schema.json | Type | Required. Defines the type of the field. Possible values are Integer, Float, String, Date, TimeOfDay, Enum or Boolean. | {"enum": ["Integer", "Float", "String", "Date", "TimeOfDay", "Enum", "Boolean"]} |
paf-module.schema.json | Hidden | If the value is Yes or True, this field will not be displayed in the GUI (and thus will not be editable by the user) but will be exported to files. It will keep its default value. | {} |
paf-module.schema.json | Readonly | If the value is Yes or True this field will be displayed, but the user will not be able to edit it. It will keep its default value. | {} |
paf-module.schema.json | Inherit | This field will be inherited by all subitems of the item that contains it. There are two modes of inheritance Copy and Connect and the value of this property has to be one of them.
Copy: Inheritance by copying means that when a child to an item that has an inheritable field is created, a field with the same name is created in the child and the value of the field in the parent is copied to that field.
Connect fields work the same way when an item is created, but if the field is changed in any of the items (any ancestor or heir) it is updated in all the items that have inherited this field from the same origin. If, for instance, a value is inherited by connection from a patient to a number of sessions and the measurements in those sessions and it is changed in one of the sessions it is changed in all those objects, but not in other patients and the sessions of those patients.
Fields are inherited all the down to the leaves from the item including the fields so if the root item would include an inherited field, it would be copied to all items in the tree. | {"enum": ["Copy", "Connect"]} |
paf-module.schema.json | Default | The default value that this field will get when an item that contains it is created. This can be overridden in the item type specification and by inheritance. The value of this property should have the same data type as the field. String fields can also specify a sequence as default value. The sequence will be converted into a string containing the elements of the sequence separated by semicolon. | {"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]} |
paf-module.schema.json | Max | Integer / Float types only: The maximum value that can be entered in this field. | {"type": "number"} |
paf-module.schema.json | Min | Integer / Float types only: The minimum value that can be entered in this field. | {"type": "number"} |
paf-module.schema.json | Quantity | Float type only: The physical quantity that this field represents. This list contains the basic physical quantities but also some derived quantities because there is no possibility to combine quantities. | {"enum": ["Length", "Mass", "Voltage", "Current", "Force", "Moment", "Power", "Angle", "Time", "Frequency", "Temperature", "Speed", "Acceleration", "Magnetic field strength", "Rotational speed"]} |
paf-module.schema.json | Unit | Float type only: The unit of this field. Can only be specified if a quantity has been specified. Different units apply to different quantities. Either the unit name or the abbreviation can be given. If a unit is not entered, the S/I unit is used. | {"enum": ["meters", "\u00e5ngstroms", "nanometers", "microns", "millimeters", "centimeters", "kilometers", "inches", "feet", "yards", "miles", "kilograms", "micrograms", "milligrams", "grams", "ounces", "pounds", "volts", "nanovolts", "microvolts", "millivolts", "kilovolts", "ampere", "nanoampere", "microampere", "milliampere", "kiloampere", "newtons", "millinewtons", "kilonewtons", "meganewtons", "kiloponds", "pounds force", "newtonmeter", "newtonmillimeter", "watt", "radians", "degrees", "seconds", "minutes", "hours", "hertz", "kilohertz", "megahertz", "revolutions per minute", "beats per minute", "kelvin", "degrees celsius", "degrees farenheit", "meters per second", "millimeters per second", "kilometers per hour", "feet per second", "miles per hour", "knots", "meters per second squared", "millimeters per second squared", "feet per second squared", "standard gravity", "tesla", "millitesla", "degrees per second", "Meters", "\u00c5ngstroms", "Nanometers", "Microns", "Millimeters", "Centimeters", "Kilometers", "Inches", "Feet", "Yards", "Miles", "Kilograms", "Micrograms", "Milligrams", "Grams", "Ounces", "Pounds", "Volts", "Nanovolts", "Microvolts", "Millivolts", "Kilovolts", "Ampere", "Nanoampere", "Microampere", "Milliampere", "Kiloampere", "Newtons", "Millinewtons", "Kilonewtons", "Meganewtons", "Kiloponds", "Pounds force", "Newtonmeter", "Newtonmillimeter", "Watt", "Radians", "Degrees", "Seconds", "Minutes", "Hours", "Hertz", "Kilohertz", "Megahertz", "Revolutions per minute", "Beats per minute", "Kelvin", "Degrees celsius", "Degrees farenheit", "Meters per second", "Millimeters per second", "Kilometers per hour", "Feet per second", "Miles per hour", "Knots", "Meters per second squared", "Millimeters per second squared", "Feet per second squared", "Standard gravity", "Tesla", "Millitesla", "Degrees per second", "m/s"]} |
paf-module.schema.json | Decimals | Float type only: The number of decimals to present to the user. | {"type": "integer"} |
paf-module.schema.json | Force | String type only: Force the string to be non-empty. | {} |
paf-module.schema.json | JSON | String type only: The string should be returned as JSON object when queried from the REST api. JSON fields are not exported to session.xml during the analysis step. (Available from QTM 2.14). | {} |
paf-module.schema.json | Values | Enum type only: The enum field defines an enumeration. To the user it will be presented as a multiple selection and internally it will be saved as a numeric value. The possible values that an enum can have has to be specified in the Values property. This property can be either a sequence or a map.
If it is a sequence it simply lists the choices of the enum and these will be assigned an integer value automatically.
If it is a map it is a map from the choices to the numeric value of each particular choice. | {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "null"}]}} |
paf-module.schema.json | Display | Boolean type only: Controls how this value will be displayed. Can be one of yesno, checkbox or truefalse. | {"enum": ["yesno", "checkbox", "truefalse", "YesNo", "Checkbox", "TrueFalse"]} |
paf-module.schema.json | Columns | The columns section specifies the columns of the tree view in the project view. It allows the PAF file to specify multiple column setups. The idea is that the users should be able to switch between different configurations and possibly also add their own but currently only the first setup is used. | {"type": "object", "patternProperties": {".+": {"patternProperties": {".+": {"properties": {"Width": {"type": "integer"}, "Field": {"type": "string"}, "Fields": {"type": "object", "properties": {"Default": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"Name": {"type": "string"}, "Editable": {}}}]}}}}}}}}} |
paf-module.schema.json | .+ | A uniquely named column setup. Each setup contains an arbitrary number of columns. | {"patternProperties": {".+": {"properties": {"Width": {"type": "integer"}, "Field": {"type": "string"}, "Fields": {"type": "object", "properties": {"Default": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"Name": {"type": "string"}, "Editable": {}}}]}}}}}}} |
paf-module.schema.json | .+ | A uniquely named column. Each column can specify a width (in pixels) and a way of determining the value displayed in the column. A key to understanding the column values is the understanding that each row in the tree view might contain a different type of item. | {"properties": {"Width": {"type": "integer"}, "Field": {"type": "string"}, "Fields": {"type": "object", "properties": {"Default": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"Name": {"type": "string"}, "Editable": {}}}]}}}}} |
paf-module.schema.json | Width | The width (in pixels) of this column. | {"type": "integer"} |
paf-module.schema.json | Field | The column will contain the value of the field named by this property regardless of the type of the item on the row. | {"type": "string"} |
paf-module.schema.json | Fields | A map from the item type name to the field to use. For each item type that is present as a key in the map the value of the field named will be used. For item types that are not named in the map the default field name will be used. | {"type": "object", "properties": {"Default": {"type": "string"}}, "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"Name": {"type": "string"}, "Editable": {}}}]}}} |
paf-module.schema.json | Default | Name used for item types not named in the map. | {"type": "string"} |
paf-module.schema.json | .+ | Name used for item types not named in the map. | {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"Name": {"type": "string"}, "Editable": {}}}]} |
paf-module.schema.json | Name | {"type": "string"} |
|
paf-module.schema.json | Editable | If yes or true, the value of the field can be edited directly in the tree. | {} |
ninjs-2.0.json | A news item as JSON object -- copyright 2021 IPTC - International Press Telecommunications Council - www.iptc.org - This document is published under the Creative Commons Attribution 4.0 license, see http://creativecommons.org/licenses/by/4.0/ | {"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "http://www.iptc.org/std/ninjs/ninjs-schema_2.0.json#", "name": "ninjs", "properties": {"uri": {"type": "string", "format": "uri"}, "type": {"type": "string", "enum": ["text", "audio", "video", "picture", "graphic", "composite", "component"]}, "representationtype": {"type": "string", "enum": ["full", "partial"]}, "profile": {"type": "string"}, "version": {"type": "string"}, "firstcreated": {"type": "string", "format": "date-time"}, "versioncreated": {"type": "string", "format": "date-time"}, "contentcreated": {"type": "string", "format": "date-time"}, "embargoed": {"type": "string", "format": "date-time"}, "pubstatus": {"type": "string", "enum": ["usable", "withheld", "canceled"]}, "urgency": {"type": "number"}, "copyrightholder": {"type": "string"}, "copyrightnotice": {"type": "string"}, "usageterms": {"type": "string"}, "ednote": {"type": "string"}, "language": {"type": "string"}, "descriptions": {"type": "array", "items": {"type": "object", "required": ["value"], "additionalProperties": false, "properties": {"role": {"type": "string"}, "contenttype": {"type": "string"}, "value": {"type": "string"}}}}, "bodies": {"type": "array", "items": {"type": "object", "required": ["value"], "additionalProperties": false, "properties": {"role": {"type": "string"}, "contenttype": {"type": "string"}, "charcount": {"type": "number"}, "wordcount": {"type": "number"}, "value": {"type": "string"}}}}, "headlines": {"type": "array", "items": {"type": "object", "required": ["value"], "additionalProperties": false, "properties": {"role": {"type": "string"}, "contenttype": {"type": "string"}, "value": {"type": "string"}}}}, "people": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "rel": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}}, "organisations": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "rel": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}, "symbols": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"ticker": {"type": "string"}, "exchange": {"type": "string"}}}}}}}, "places": {"additionalProperties": false, "type": "array", "items": {"type": "object", "anyOf": [{"properties": {"name": {"type": "string"}, "rel": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}, {}]}}, "subjects": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "rel": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}}, "events": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "rel": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}}, "objects": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "rel": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}}, "infosources": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "role": {"type": "string", "format": "uri"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}}, "by": {"type": "string"}, "slugline": {"type": "string"}, "located": {"type": "string"}, "renditions": {"type": "array", "additionalProperties": false, "items": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "href": {"type": "string", "format": "uri"}, "contenttype": {"type": "string"}, "height": {"type": "number"}, "width": {"type": "number"}, "sizeinbytes": {"type": "number"}, "duration": {"type": "number"}, "format": {"type": "string"}}}}, "associations": {"type": "array", "additionalProperties": false, "items": {"type": "object", "anyOf": [{"properties": {"name": {"type": "string"}}, "required": ["name"]}, {}]}}, "altids": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"role": {"type": "string"}, "value": {"type": "string"}}}}, "trustindicators": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"role": {"type": "string", "format": "uri"}, "href": {"type": "string", "format": "uri"}}}}, "standard": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "schema": {"type": "string", "format": "uri"}}}, "genres": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "literal": {"type": "string"}}}}, "rightsinfo": {"type": "object", "properties": {"langid": {"type": "string", "format": "uri"}, "linkedrights": {"type": "string", "format": "uri"}, "encodedrights": {"additionalProperties": false, "type": "string"}}, "oneOf": [{"required": ["linkedrights"]}, {"required": ["encodedrights"]}]}}, "required": ["uri"], "type": "object"} |
|
ninjs-2.0.json | uri | The global unique identifier for this news object. This is the only required property and should identify the ninjs object, not be used for links to external resources etc. nar:newsItem@guid | {"type": "string", "format": "uri"} |
ninjs-2.0.json | type | The generic news type of this news object. (Value 'component' added in version 1.2 as issue #21.). See: http://cv.iptc.org/newscodes/ninature/ nar:itemClass | {"type": "string", "enum": ["text", "audio", "video", "picture", "graphic", "composite", "component"]} |
ninjs-2.0.json | representationtype | Indicates how complete this representation of a news item is. No mapping to nar. Specific for ninjs. | {"type": "string", "enum": ["full", "partial"]} |
ninjs-2.0.json | profile | An identifier for the structure of the news object. This can be any string but we suggest something identifying the structure of the content such as 'text-only' or 'text-photo'. Profiles are typically provider-specific. nar:profile | {"type": "string"} |
ninjs-2.0.json | version | The version of the news object which is identified by the uri property. nar:newsItem@version | {"type": "string"} |
ninjs-2.0.json | firstcreated | Indicates when the first version of this ninjs object was created. (Added in version 1.2 from issue #5). nar:firstCreated | {"type": "string", "format": "date-time"} |
ninjs-2.0.json | versioncreated | The date and time when this version of this ninjs object was created. nar:versionCreated | {"type": "string", "format": "date-time"} |
ninjs-2.0.json | contentcreated | The date and time when the content of this ninjs object was originally created. For example and old photo that is now handled as a ninjs object. nar:contentCreated | {"type": "string", "format": "date-time"} |
ninjs-2.0.json | embargoed | The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed. nar:embargoed | {"type": "string", "format": "date-time"} |
End of preview. Expand
in Dataset Viewer.
No dataset card yet
New: Create and edit this dataset card directly on the website!
Contribute a Dataset Card- Downloads last month
- 31