Commit 4be0c940 authored by Thomas Gehrmann [SLB]'s avatar Thomas Gehrmann [SLB]
Browse files

Sync with DD schema repo SHA 9218d461334082270de8e3745f7201d821d93dec 2021-07-08

parent 36b59345
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/abstract/AbstractActivityParameter.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AbstractActivityParameter",
"description": "General parameter value used in one instance of activity.\n[Without inheritance, combined specializations.]",
"type": "object",
"properties": {
"Title": {
"type": "string",
"title": "Title",
"description": "Name of the parameter, used to identify it in the activity. It must have an equivalent in the ActivityTemplate parameters."
},
"Index": {
"type": "integer",
"title": "Index",
"description": "When parameter is an array, used to indicate the index in the array."
},
"Selection": {
"type": "string",
"title": "Selection",
"description": "Textual description about how this parameter was selected."
},
"Keys": {
"type": "array",
"title": "Keys",
"description": "A nested array describing keys used to identify a parameter value. When multiple values are provided for a given parameter, the key provides a way to identify the parameter through its association with an object, a time index or a parameter array member via ParameterKey value.",
"items": {
"type": "object",
"title": "Parameter Key",
"description": "Abstract class describing a key used to identify a parameter value. When multiple values are provided for a given parameter, provides a way to identify the parameter through its association with an object, a time index... \n[Without inheritance, combined specializations.]",
"properties": {
"ObjectParameterKey": {
"type": "string",
"title": "Object Parameter Key",
"description": "Relationship to an object ID, which acts as the parameter.",
"pattern": "^[\\w\\-\\.]+:[\\w\\-\\.]+:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"TimeIndexParameterKey": {
"type": "string",
"title": "Time Index Parameter Key",
"format": "time"
},
"ParameterKey": {
"type": "string",
"title": "Internal Parameter Key",
"description": "The key name, which establishes an association between parameters."
}
}
}
},
"DataObjectParameter": {
"type": "string",
"title": "Data Object Parameter",
"description": "Parameter referencing to a top level object.",
"pattern": "^[\\w\\-\\.]+:[\\w\\-\\.]+:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"DataQuantityParameter": {
"type": "number",
"title": "Data Quantity Parameter",
"description": "Parameter containing a double value.",
"x-osdu-frame-of-reference": "UOM_via_property:DataQuantityParameterUOMID"
},
"IntegerQuantityParameter": {
"type": "integer",
"title": "Integer Quantity Parameter",
"description": "Parameter containing an integer value."
},
"StringParameter": {
"type": "string",
"title": "String Parameter",
"description": "Parameter containing a string value."
},
"TimeIndexParameter": {
"type": "string",
"title": "Time Index Parameter",
"description": "Parameter containing a time index value. It is assumed that all TimeIndexParameters within an Activity have the same date-time format, which is then described by the FrameOfReference mechanism.",
"format": "date-time",
"x-osdu-frame-of-reference": "DateTime"
},
"ParameterKindID": {
"type": "string",
"description": "[Added to cover lack of inheritance]",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-ParameterKind:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"ParameterRoleID": {
"type": "string",
"title": "Parameter Role",
"description": "Reference data describing how the parameter was used by the activity, such as input, output, control, constraint, agent, predecessor activity, successor activity.",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-ParameterRole:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"DataQuantityParameterUOMID": {
"type": "string",
"title": "Data Quantity Parameter UoM ID",
"description": "Identifies unit of measure for floating point value.",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-UnitOfMeasure:[\\w\\-\\.\\:\\%]+:[0-9]*$"
}
},
"required": [
"Title",
"ParameterKindID"
]
}
\ No newline at end of file
......@@ -29,7 +29,7 @@
"EncodingFormatTypeID": {
"type": "string",
"title": "Encoding Format Type ID",
"description": "EncodingFormatType ID reference value relationship. It can me a mime-type or media-type.",
"description": "EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.",
"example": "namespace:reference-data--EncodingFormatType:text%2Fcsv:",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-EncodingFormatType:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
......
......@@ -6,7 +6,8 @@
"type": "object",
"properties": {
"FacilityID": {
"description": "A system-specified unique identifier of a Facility.",
"title": "External Facility Identifier",
"description": "Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the \"Source\" property should identify that source system.",
"type": "string"
},
"FacilityTypeID": {
......
......@@ -6,7 +6,8 @@
"type": "object",
"properties": {
"ProjectID": {
"description": "A system-specified unique identifier of a Project.",
"title": "External Project Identifier",
"description": "Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the \"Source\" property should identify that source system.",
"type": "string"
},
"ProjectName": {
......
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/abstract/AbstractProjectActivity.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AbstractProjectActivity",
"description": "The activity abstraction for projects and surveys (master-data).",
"type": "object",
"properties": {
"ActivityTemplateID": {
"type": "string",
"title": "Activity Template ID",
"description": "The relation to the ActivityTemplate carrying expected parameter definitions and default values.",
"pattern": "^[\\w\\-\\.]+:master-data\\-\\-ActivityTemplate:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"ParentProjectID": {
"type": "string",
"title": "Parent Project ID",
"description": "The relationship to a parent project acting as a parent activity.",
"pattern": "^[\\w\\-\\.]+:(master-data\\-\\-[\\w\\-\\.]*Project[\\w\\-\\.]*|master-data\\-\\-[\\w\\-\\.]*Survey[\\w\\-\\.]*):[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"Parameters": {
"type": "array",
"title": "Parameters",
"description": "General parameter value used in one instance of activity. Includes reference to data objects which are inputs and outputs of the activity.",
"x-osdu-indexing": {
"type": "nested"
},
"items": {
"$ref": "../abstract/AbstractActivityParameter.1.0.0.json"
}
}
}
}
\ No newline at end of file
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/abstract/AbstractPropertyType.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AbstractPropertyType",
"description": "A nested object holding the relationship to a PropertyType by id (uuid) and a derived, human-readable name.",
"type": "object",
"properties": {
"PropertyTypeID": {
"type": "string",
"title": "Property Type ID",
"description": "The relationship to the PropertyType reference data item, typically containing an Energistics PWLS 3 uuid. For better traceability and usability the property name is to be populated in the Name property.",
"example": "namespace:reference-data--PropertyType:ace68d4c-7400-431d-9a33-0541b8bfc4b4:",
"x-osdu-existing-standard": "Energistics PWLS 3",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-PropertyType:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"Name": {
"type": "string",
"title": "Name",
"description": "The name of the PropertyType, de-normalized, derived from the record referenced in PropertyTypeID.",
"example": "dip azimuth",
"x-osdu-is-derived": {
"RelationshipPropertyName": "PropertyTypeID",
"TargetPropertyName": "Name"
},
"x-osdu-existing-standard": "Energistics PWLS 3"
}
}
}
\ No newline at end of file
{
"x-osdu-review-status": "Accepted",
"x-osdu-governance-authorities": [
"OSDU"
],
"$id": "https://schema.osdu.opengroup.org/json/abstract/AbstractReferencePropertyType.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AbstractReferencePropertyType",
"description": "The purpose of this schema is best understood in the context of a columnar dataset: the AbstractReferencePropertyType describes a column in a columnar dataset by declaring its value type (number, string), a UnitQuantity if the value type is a number, a kind if the string value is actually a relationship to a e.g. reference-data type.",
"type": "object",
"properties": {
"ValueType": {
"type": "string",
"title": "Value Type",
"description": "The type of value to expect for this reference property, either \"number\" (floating point number), \"integer\", \"string\", or \"boolean\".",
"example": "string"
},
"ValueCount": {
"type": "integer",
"title": "Value Count",
"description": "The number of values in a tuple, e.g. For coordinates. The default is 1.",
"example": 1,
"default": 1
},
"UnitQuantityID": {
"type": "string",
"title": "Unit Quantity ID",
"description": "Only populated of the ValueType is \"number\". It holds the UnitQuantity associated with this reference property type. It is a relationship to UnitQuantity record.",
"example": "namespace:reference-data--UnitQuantity:plane%20angle:",
"x-osdu-existing-standard": "Energistics Unit of Measure V1.0",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-UnitQuantity:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"PropertyType": {
"$ref": "../abstract/AbstractPropertyType.1.0.0.json",
"title": "Property Type",
"description": "It holds the PropertyType associated with this reference property type, further defining the semantics of the value. It contains a relationship to PropertyType record and its (de-normalized) name. String or number values can represent e.g. A date or a time by referring to the respective PropertyType record id.",
"example": {
"PropertyTypeID": "namespace:reference-data--PropertyType:ace68d4c-7400-431d-9a33-0541b8bfc4b4:",
"Name": "dip azimuth"
}
},
"RelationshipTargetKind": {
"type": "string",
"title": "Relationship Target Kind",
"description": "Only populated if ValueType==\"string\" and the values are expected to represent record ids, e.g. to a reference-data type, then this value holds the kind (optionally without the semantic version number).",
"example": "osdu:wks:reference-data--UnitOfMeasure:",
"pattern": "^[\\w\\-\\.]+:[\\w\\-\\.]+:[\\w\\-\\.]+:([0-9]+)?(\\.)?([0-9]+)?(\\.)?([0-9]+)?$"
}
}
}
\ No newline at end of file
......@@ -21,7 +21,8 @@
}
},
"ID": {
"description": "Surrogate key to uniquely identify an instance in a domain list.",
"title": "External Identifier",
"description": "Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the \"Source\" property should identify that source system.",
"type": "string"
},
"InactiveIndicator": {
......
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/abstract/AbstractWPCActivity.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AbstractWPCActivity",
"description": "The activity abstraction included by projects (master-data) and work-product-component group-type specialisations.",
"type": "object",
"properties": {
"ActivityTemplateID": {
"type": "string",
"title": "Activity Template ID",
"description": "The relation to the ActivityTemplate carrying expected parameter definitions and default values.",
"pattern": "^[\\w\\-\\.]+:master-data\\-\\-ActivityTemplate:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"ParentProjectID": {
"type": "string",
"title": "Parent Project ID",
"description": "The relationship to a parent project acting as a parent activity.",
"pattern": "^[\\w\\-\\.]+:(master-data\\-\\-[\\w\\-\\.]*Project[\\w\\-\\.]*|master-data\\-\\-[\\w\\-\\.]*Survey[\\w\\-\\.]*):[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"ParentActivityID": {
"type": "string",
"title": "Parent Activity ID",
"description": "The relationship to a parent activity.",
"pattern": "^[\\w\\-\\.]+:work-product-component\\-\\-[\\w\\-\\.]*Activity[\\w\\-\\.]*:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"Parameters": {
"type": "array",
"title": "Parameters",
"description": "General parameter value used in one instance of activity. Includes reference to data objects which are inputs and outputs of the activity.",
"x-osdu-indexing": {
"type": "nested"
},
"items": {
"$ref": "../abstract/AbstractActivityParameter.1.0.0.json"
}
},
"PriorActivityIDs": {
"type": "array",
"title": "Prior Activity IDs",
"description": "The activity or activities feeding results into this activity instance.",
"items": {
"type": "string",
"pattern": "^[\\w\\-\\.]+:work-product-component\\-\\-[\\w\\-\\.]*Activity[\\w\\-\\.]*:[\\w\\-\\.\\:\\%]+:[0-9]*$"
}
},
"SoftwareSpecifications": {
"type": "array",
"title": "Software Specifications",
"description": "Software names and versions used.",
"x-osdu-indexing": {
"type": "flattened"
},
"items": {
"type": "object",
"title": "Software",
"description": "The name and version of the software being executed in the context of this activity",
"properties": {
"SoftwareName": {
"type": "string",
"title": "Software Name",
"description": "The name of the software, application or plug-in used while performing this activity."
},
"Version": {
"type": "string",
"title": "Software Version",
"description": "The version of the software, application or plug-in used while performing this activity."
}
}
}
}
},
"required": [
"Parameters"
]
}
\ No newline at end of file
......@@ -120,7 +120,7 @@
"EncodingFormatTypeID": {
"type": "string",
"title": "Encoding Format Type ID",
"description": "EncodingFormatType ID reference value relationship. It can me a mime-type or media-type.",
"description": "EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.",
"example": "namespace:reference-data--EncodingFormatType:text%2Fcsv:",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-EncodingFormatType:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
......
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/master-data/ActivityTemplate.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Activity Template",
"description": "Description of one type of activity.",
"type": "object",
"allOf": [
{
"$ref": "../abstract/AbstractMaster.1.0.0.json"
},
{
"type": "object",
"properties": {
"Parameters": {
"type": "array",
"title": "Parameters",
"description": "Description of one parameter that participate in one type of activity.",
"x-osdu-indexing": {
"type": "nested"
},
"items": {
"type": "object",
"title": "Parameter Template",
"description": "Description of one parameter that participates in one type of activity.\n[Without inheritance, combined specializations.]",
"properties": {
"AllowedParameterKind": {
"type": "string",
"title": "Allowed Parameter Kind",
"description": "If no allowed kind is given, then all kind of data types are allowed.",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-ParameterKind:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"IsInput": {
"type": "boolean",
"title": "Is Input",
"description": "Indicates if the parameter is an input of the activity. If the parameter is a data object and is also an output of the activity, it is strongly advised to use two parameters : one for input and one for output. The reason is to be able to give two different versions strings for the input and output data object which has got obviously the same UUID."
},
"KeyConstraints": {
"type": "array",
"title": "Key Constraints",
"description": "Allows to indicate that, in the same activity, this parameter template must be associated to another parameter template identified by its title. The associated parameter value constrains this parameter.",
"items": {
"type": "string"
}
},
"IsOutput": {
"type": "boolean",
"title": "Is Output",
"description": "Indicates if the parameter is an output of the activity. If the parameter is a data object and is also an input of the activity, it is strongly advised to use two parameters : one for input and one for output. The reason is to be able to give two different versions strings for the input and output data object which has got obviously the same UUID."
},
"Title": {
"type": "string",
"title": "Title",
"description": "Name of the parameter in the activity. Key to identify parameter."
},
"DataObjectContentType": {
"type": "array",
"title": "Data Object Content Type",
"description": "When parameter is limited to data object of given types, describe the allowed types. Used only when ParameterType is dataObject. String is an OSDU kind of work product component.",
"items": {
"type": "string"
}
},
"MaxOccurs": {
"type": "integer",
"title": "Max Occurs",
"description": "Maximum number of parameters of this type allowed in the activity. If the maximum number of parameters is infinite, use -1 value."
},
"MinOccurs": {
"type": "integer",
"title": "Min Occurs",
"description": "Minimum number of parameter of this type required by the activity. If the minimum number of parameters is infinite, use -1 value."
},
"Constraint": {
"type": "string",
"title": "Constraint",
"description": "Textual description of additional constraint associated with the parameter. (note that it will be better to have a formal description of the constraint)"
},
"DefaultValue": {
"$ref": "../abstract/AbstractActivityParameter.1.0.0.json",
"title": "Default Value",
"description": "Activity Parameter value to use if one not supplied."
},
"PropertyType": {
"$ref": "../abstract/AbstractPropertyType.1.0.0.json",
"title": "Property Type",
"description": "The property type ID and Name, which determines eventually the UnitQuantity of the parameter value. Used to provide a more scoped context than UnitQuantityID. If PropertyType is provided, UnitQuantityID is expected to be omitted."
},
"UnitQuantityID": {
"type": "string",
"title": "Unit Quantity ID",
"description": "The expected UnitQuantity for the parameter value. A more precise context can be provided by PropertyType. If UnitQuantityID is provided, PropertyType is expected to be omitted.",
"pattern": "^[\\w\\-\\.]+:reference-data\\-\\-UnitQuantity:[\\w\\-\\.\\:\\%]+:[0-9]*$"
}
},
"required": [
"IsInput",
"IsOutput",
"Title",
"MaxOccurs",
"MinOccurs"
]
}
}
},
"required": [
"Parameters"
]
}
]
}
\ No newline at end of file
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/master-data/ActivityTemplateArc.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ActivityTemplateArc",
"description": "An 'arc' establishing a link between ActivityTemplate input and output parameters.",
"type": "object",
"allOf": [
{
"$ref": "../abstract/AbstractMaster.1.0.0.json"
},
{
"type": "object",
"properties": {
"Name": {
"type": "string",
"title": "Name",
"description": "The name of this input/output parameter definition set."
},
"OutputInputArcs": {
"type": "array",
"title": "Output Input Arcs",
"description": "The array of arcs, which associate ActivityTemplate outputs to ActivityTemplate inputs.",
"items": {
"type": "object",
"title": "Arc",
"description": "An 'arc' establishing a link between a single pair of ActivityTemplate input and output parameters.",
"properties": {
"ProducingActivityTemplateID": {
"type": "string",
"title": "Producing Activity Template ID",
"description": "The relationship to the producing ActivityTemplate.",
"pattern": "^[\\w\\-\\.]+:master-data\\-\\-ActivityTemplate:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"ProducingParameterTitle": {
"type": "string",
"title": "Producing Parameter Title",
"description": "The Title of the producing ActivityTemplate Parameter array element."
},
"ConsumingActivityTemplateID": {
"type": "string",
"title": "Consuming Activity Template ID",
"description": "The relationship to the consuming ActivityTemplate.",
"pattern": "^[\\w\\-\\.]+:master-data\\-\\-ActivityTemplate:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"ConsumingParameterTitle": {
"type": "string",
"title": "Consuming Parameter Title",
"description": "The Title of the consuming ActivityTemplate Parameter array element."
}
},
"required": [
"ProducingActivityTemplateID",
"ProducingParameterTitle",
"ConsumingActivityTemplateID",
"ConsumingParameterTitle"
]
}
},
"ActivityArcs": {
"type": "array",
"title": "Activity Arcs",
"description": "The array of arcs, which link pairs of ActivityTemplate as predecessor and successor.",
"items": {
"type": "object",
"title": "Arc",
"description": "An 'arc' establishing a link between a single pair of ActivityTemplate input and output parameters.",
"properties": {
"PrecedingActivityTemplateID": {
"type": "string",
"title": "Preceding Activity Template ID",
"description": "The relationship to the ActivityTemplate first in a pair of ActivityTemplates in the context of a workflow.",
"pattern": "^[\\w\\-\\.]+:master-data\\-\\-ActivityTemplate:[\\w\\-\\.\\:\\%]+:[0-9]*$"
},
"SucceedingActivityTemplateID": {
"type": "string",
"title": "Succeeding Activity Template ID",
"description": "The relationship to the ActivityTemplate succeeding the first ActivityTemplate in the workflow.",
"pattern": "^[\\w\\-\\.]+:master-data\\-\\-ActivityTemplate:[\\w\\-\\.\\:\\%]+:[0-9]*$"
}
},
"required": [
"PrecedingActivityTemplateID",
"SucceedingActivityTemplateID"
]
}
}
}
}
]
}
\ No newline at end of file
......@@ -12,7 +12,8 @@
"type": "object",
"properties": {
"BasinID": {
"description": "A system generated unique identifier.",
"title": "External Basin Identifier",
"description": "Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the \"Source\" property should identify that source system.",
"type": "string"
},
"BasinName": {
......
{
"x-osdu-review-status": "Accepted",
"$id": "https://schema.osdu.opengroup.org/json/master-data/Collection.1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Collection",
"description": "Collection of objects ingested in the data platform. The collection is persisted and can group objects of different nature, including master data, work-product-components and reference data. A Collection can also contain