Skip to content
Cloud APIs
/
/
/
File Metadata

File Metadata

The file data container containing all necessary details of the file record

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

Checksumstring^[0-9a-fA-F]32}$

MD5 checksum of file bytes - a 32 byte hexadecimal number

ResourceHomeRegionIDstring^[\\w\\-\\.]+:reference-data\\-\\-OSDURegion:...

The name of the home [cloud environment] region for this OSDU resource object.

ResourceHostRegionIDsArray of strings

The name of the host [cloud environment] region(s) for this OSDU resource object.

ResourceCurationStatusstring^[\\w\\-\\.]+:reference-data\\-\\-ResourceCur...

Describes the current Curation status.

ResourceLifecycleStatusstring^[\\w\\-\\.]+:reference-data\\-\\-ResourceLif...

Describes the current Resource Lifecycle status.

ResourceSecurityClassificationstring^[\\w\\-\\.]+:reference-data\\-\\-ResourceSec...

Classifies the security level of the resource.

Sourcestring

The entity that produced the record, or from which it is received; could be an organization, agency, system, internal team, or individual. For informational purposes only, the list of sources is not governed.

ExistenceKindstring^[\\w\\-\\.]+:reference-data\\-\\-ExistenceKi...

Where does this data resource sit in the cradle-to-grave span of its existence?

ExtensionPropertiesobject(File DMS Extension Properties)
{
  "ExtensionProperties": {
    "Name": "File",
    "Classification": "Raw File",
    "Description": "An text further describing this file example.",
    "ExternalIds": [ … ],
    "FileDateCreated": "2013-03-22 11:16:03+00:00",
    "FileDateModified": "2013-03-22 11:16:03+00:00",
    "FileContentsDetails": { … },
    "relationships": { … }
  },
  "Name": "string",
  "Description": "string",
  "TotalSize": "string",
  "EncodingFormatTypeID": "string",
  "SchemaFormatTypeID": "string",
  "Endian": "BIG",
  "DatasetProperties": {
    "FileSourceInfo": { … }
  },
  "Checksum": "string",
  "ResourceHomeRegionID": "string",
  "ResourceHostRegionIDs": [
    "string"
  ],
  "ResourceCurationStatus": "string",
  "ResourceLifecycleStatus": "string",
  "ResourceSecurityClassification": "string",
  "Source": "string",
  "ExistenceKind": "string"
}