Record

Metadata record.

idstringread-only

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

kindstringrequired

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)required

legalobject(Legal Meta Data)required

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

dataobject(File Metadata)required

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"
}

{
  "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"
  }
}