DatasetRequest Data Type

Abstract Type
Properties
name data type constraints description
dataSetId string  
name string  
pathSpecifications array of PathSpecification  
dataSetPathSpecs map of array of PathSpecification  
members array of Member  
fields array of ReportedField  
dataSetSchemaVersion number required
deleteMembers boolean required
virtualFolderKey string  
Properties inherited from Entity
timeOfLastChange number  
timeOfCreation number  
key string  
description string  
type string  
restricted array of string  
viewAble array of string  
updateable array of string  
richDescription string  
score number required
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.
{
  "dataSetId" : "...",
  "name" : "...",
  "pathSpecifications" : [ {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  }, {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  } ],
  "dataSetPathSpecs" : {
    "property1" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ],
    "property2" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ]
  },
  "members" : [ {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  }, {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  } ],
  "fields" : [ {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  }, {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  } ],
  "dataSetSchemaVersion" : 12345,
  "deleteMembers" : true,
  "virtualFolderKey" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}