DatasetRequest Data Type

Base type for Waterline Data metadata objects.

Abstract Type
Properties
name data type description
members array of Member
fields array of ReportedField
pathSpecifications array of PathSpecification
virtualFolderKey string
name string
dataSetPathSpecs map of array of PathSpecification
dataSetId string
dataSetSchemaVersion number
Properties inherited from Entity
key string
type string
description string
timeOfLastChange number
timeOfCreation number
restricted array of string
updateable array of string
viewAble array of string
customProperties array of CustomProperty

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "members" : [ {
    "resourcePath" : "...",
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "datasetKey" : "...",
    "dsetId" : "..."
  }, {
    "resourcePath" : "...",
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "datasetKey" : "...",
    "dsetId" : "..."
  } ],
  "fields" : [ {
    "dataType" : "...",
    "name" : "...",
    "label" : "...",
    "description" : "..."
  }, {
    "dataType" : "...",
    "name" : "...",
    "label" : "...",
    "description" : "..."
  } ],
  "pathSpecifications" : [ {
    "sourcePath" : "...",
    "includePattern" : "...",
    "excludePattern" : "..."
  }, {
    "sourcePath" : "...",
    "includePattern" : "...",
    "excludePattern" : "..."
  } ],
  "virtualFolderKey" : "...",
  "name" : "...",
  "dataSetPathSpecs" : {
    "property1" : [ {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    }, {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    } ],
    "property2" : [ {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    }, {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    } ]
  },
  "dataSetId" : "...",
  "dataSetSchemaVersion" : 12345,
  "key" : "...",
  "type" : "...",
  "description" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "restricted" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "customProperties" : [ {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  }, {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  } ]
}