Skip to content
Cloud APIs
/
/
/
OSDU AbstractDataset

OSDU AbstractDataset

Namestring

The name of dataset, e.g. a user friendly file or file collection name.

Descriptionstring

An optional, textual description of the dataset.

TotalSizestring^[0-9]+$

Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).

EncodingFormatTypeIDstring^srn:<namespace>:reference-data\\/EncodingFor...

EncodingFormatType ID reference value relationship. It can be of mime-type or media-type.

SchemaFormatTypeIDstring^srn:<namespace>:reference-data\\/SchemaForma...

Schema Format Type ID reference value relationship.

Endianstring

Endianness of binary value. Enumeration- \BIG\ \LITTLE. If absent applications will need to interpret from context indicators.

Enum:"BIG""LITTLE"
Example:"BIG"
DatasetPropertiesobjectrequired

Dataset Properties

{
  "Name": "string",
  "Description": "string",
  "TotalSize": "string",
  "EncodingFormatTypeID": "string",
  "SchemaFormatTypeID": "string",
  "Endian": "BIG",
  "DatasetProperties": {}
}