Skip to content
Cloud APIs
/
/
/
Record

Record

aclobject(Acl)required
ancestryobject(RecordAncestry)
dataobject(File Metadata)

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

idstring^[\w\-\.]+:[\w-\.]+:[\w\-\.\:\%]+$required

Unique identifier in whole Data Ecosystem. When not provided, Data Ecosystem will create and assign an id to the record. Must follow the naming convention: {Data-Partition-Id}:{object-type}:{uuid}.

Example:"common:work-product-component--wellLog:123456"
kindstringrequired

Record kind for which the schema information is applied to.

Example:"common:wks:work-product-component--wellLog:1.0.0"
legalobject(Legal)
metaArray of objects
tagsobject
versioninteger, (int64)
{
  "acl": {
    "owners": [ … ],
    "viewers": [ … ]
  },
  "ancestry": {
    "parents": [ … ]
  },
  "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"
  },
  "id": "common:work-product-component--wellLog:123456",
  "kind": "common:wks:work-product-component--wellLog:1.0.0",
  "legal": {
    "legaltags": [ … ],
    "otherRelevantDataCountries": [ … ],
    "status": "compliant"
  },
  "meta": [
    { … }
  ],
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "version": 0
}