afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/DatasetExport.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "field_reference"
  ],
  "title": "DatasetExport - Data API",
  "description": "Represents a dataset exported from CRM Analytics. When a dataset is exported, the data is converted into a .csv file and the schema is stored in a separate JSON file. These files are stored in two objects: DatasetExport and DatasetExportPart. DatasetExport acts as the header and includes the JSON schema.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "CompressedMetadataLength": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "This field is required when a record in an object contains a BLOB (binary large object) field. In the DataExport object, Metadata is the BLOB field."
    },
    "Metadata": {
      "type": "base64",
      "properties": "Nillable",
      "description": "Contains the JSON schema that describes the data in the CSV. This schema includes column metadata such as type, format, and defaultValue."
    },
    "MetadataLength": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "This field is required when a record in an object contains a BLOB (binary large object) field. In the DataExport object, Metadata is the BLOB field."
    },
    "Owner": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "User ID of the owner, as specified in the userId parameter in the export node of the dataflow that created the record. Only the specified owner can read the content of the record."
    },
    "PublisherInfo": {
      "type": "string",
      "properties": "Filter, idLookup, Sort",
      "description": "Identifies the export record to facilitate searching when a user has multiple export records. By default, this column is set to the ID of the dataflow that generated the export record, concatenated with the name of the specific export node. PublisherInfo is unique within your organization. Note: A dataflow can have multiple export nodes."
    },
    "PublisherType": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Target of the export, as specified in the target parameter in the export node of the dataflow that created the record. The value must be EinsteinDiscovery."
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Status of the export. The possible values are: New InProgress Completed Canceled Failed Note: The content of the Metadata field can be downloaded when the status is Completed."
    }
  },
  "usage": "This object is used with the DatasetExportPart object for exporting data from a dataset in CRM Analytics for use in Einstein Discovery. An export is initiated using the export node in an Analytics dataflow.\n\nThis object is used with the DatasetExportPart object for exporting\n      data from a dataset in CRM Analytics for use in Einstein Discovery. An export is initiated\n      using the export node in an Analytics dataflow.",
  "field_reference": {
    "CompressedMetadataLength": {
      "field_label": "Compressed Metadata Length",
      "type": "int",
      "digits": "9"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Dataset Export ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Metadata": {
      "field_label": "Metadata",
      "type": "base64"
    },
    "MetadataLength": {
      "field_label": "Metadata Length",
      "type": "int",
      "digits": "9"
    },
    "Owner": {
      "field_label": "Owner",
      "type": "string",
      "length": "18"
    },
    "PublisherInfo": {
      "field_label": "Publisher Info",
      "type": "string",
      "length": "1000"
    },
    "PublisherType": {
      "field_label": "Publisher Type",
      "type": "picklist",
      "length": "255"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "digits",
    "length"
  ]
}