RecordVersion

Metadata record.

idstringread-only

Unique identifier generated by the system for the file metadata record.

kindstring

Kind of data being ingested. Must follow the naming convention:{schema-authority}:wks:dataset--File.Generic:{version}.

Example:"osdu:wks:dataset--File.Generic:1.0.0"

aclobject(OSDU Abstract Access Control List)

legalobject(Legal Meta Data)

Legal meta data like legal tags, relevant other countries, legal status.

dataobject(File Metadata)

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

ancestryobject(Parent List)

metaArray of objects(Frame of Reference Meta Data Item (FoR of File))

tagsobject

Data flow job id to track data flow.

Example:

{
  "dataflowId": "dataflowId"
}

versioninteger, (int64)(Version Number)

The version number of this OSDU resource; set by the framework.

Example:1831253916104085

{
  "id": "string",
  "kind": "osdu:wks:dataset--File.Generic:1.0.0",
  "acl": {
    "viewers": [ … ],
    "owners": [ … ]
  },
  "legal": {
    "legaltags": [ … ],
    "otherRelevantDataCountries": [ … ],
    "status": "compliant"
  },
  "data": {
    "ExtensionProperties": { … },
    "Name": "string",
    "Description": "string",
    "TotalSize": "string",
    "EncodingFormatTypeID": "string",
    "SchemaFormatTypeID": "string",
    "Endian": "BIG",
    "DatasetProperties": { … },
    "Checksum": "string",
    "ResourceHomeRegionID": "string",
    "ResourceHostRegionIDs": [ … ],
    "ResourceCurationStatus": "string",
    "ResourceLifecycleStatus": "string",
    "ResourceSecurityClassification": "string",
    "Source": "string",
    "ExistenceKind": "string"
  },
  "ancestry": {
    "parents": [ … ]
  },
  "meta": [
    { … }
  ],
  "tags": {
    "dataflowId": "dataflowId"
  },
  "version": 1831253916104085
}