List All Data Set

Select

SaaS

Customer Managed

This operation returns all datasets

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

dataSet object[]
dataSet object
dataSetId integer
dataSetName string
dataSetGuid string
endpoint string
shared boolean
dataSources object[]
dataSource object
dataSourceName string
connectionType string
commCell object
commCellName string
databaseName string
endpoint string
allColumns boolean
fields object[]
name string
dataField string
type string
GetOperation object
parameters object[]
name string
dataType string
values string[]
isList boolean
required boolean
sqlText string
timeout integer
postQueryFilter boolean
rDataSetQuery string
rPlotQuery string
description string
databaseName string
deployed boolean
queryPlan object
offline boolean
collectionType string
retentionDays integer
versions string[]
dynamicCollection boolean
frequency integer
direct boolean
version integer
guid string
hidden boolean
readOnly boolean
revision string
visibleAll boolean
computedColumns object
scriptName string
script string
visibleToTenantAdmins boolean
builtIn boolean
systemDataSet boolean
signature string
definition string

{
  "dataSet": [
    {
      "dataSet": {
        "dataSetId": 0,
        "dataSetName": "string",
        "dataSetGuid": "string"
      },
      "endpoint": "string",
      "shared": true,
      "dataSources": [
        {
          "dataSource": {
            "dataSourceName": "string"
          },
          "connectionType": "string",
          "commCell": {
            "commCellName": "string"
          },
          "databaseName": "string",
          "endpoint": "string"
        }
      ],
      "allColumns": true,
      "fields": [
        {
          "name": "string",
          "dataField": "string",
          "type": "string"
        }
      ],
      "GetOperation": {
        "parameters": [
          {
            "name": "string",
            "dataType": "string",
            "values": [
              "string"
            ],
            "isList": true,
            "required": true
          }
        ],
        "sqlText": "string",
        "timeout": 0,
        "postQueryFilter": true,
        "rDataSetQuery": "string",
        "rPlotQuery": "string"
      },
      "description": "string",
      "databaseName": "string",
      "deployed": true,
      "queryPlan": {
        "offline": true,
        "collectionType": "string",
        "retentionDays": 0,
        "versions": [
          "string"
        ],
        "dynamicCollection": true,
        "frequency": 0,
        "direct": true
      },
      "version": 0,
      "guid": "string",
      "hidden": true,
      "readOnly": true,
      "revision": "string",
      "visibleAll": true,
      "computedColumns": {
        "scriptName": "string",
        "script": "string"
      },
      "visibleToTenantAdmins": true,
      "builtIn": true,
      "systemDataSet": true,
      "signature": "string",
      "definition": "string"
    }
  ]
}

{
  "dataSet": [
    {
      "dataSet": {
        "dataSetId": 2944,
        "dataSetName": "AuditTrailDataset",
        "dataSetGuid": "2b3e43c0-21fe-401d-ebf8-c485309262a7"
      },
      "endpoint": "DATABASE",
      "shared": true,
      "dataSources": [
        {
          "dataSource": {
            "dataSourceName": ""
          },
          "connectionType": "COMMCELL",
          "commCell": {
            "commCellName": "$LocalCommCell$"
          },
          "databaseName": ""
        }
      ],
      "allColumns": false,
      "fields": [
        {
          "name": "sys_rowid",
          "dataField": "$row_number$",
          "type": "String"
        },
        {
          "name": "Data Source",
          "dataField": "Data Source",
          "type": "String"
        },
        {
          "name": "ID",
          "dataField": "ID",
          "type": "Integer"
        },
        {
          "name": "Severity Level",
          "dataField": "Severity Level",
          "type": "String"
        },
        {
          "name": "SeverityInt",
          "dataField": "SeverityInt",
          "type": "Integer"
        },
        {
          "name": "User",
          "dataField": "User",
          "type": "String"
        },
        {
          "name": "Time",
          "dataField": "Time",
          "type": "TimeStamp"
        },
        {
          "name": "Operation",
          "dataField": "Operation",
          "type": "String"
        },
        {
          "name": "Details",
          "dataField": "Details",
          "type": "String"
        }
      ],
      "GetOperation": {
        "parameters": [
          {
            "name": "serachString",
            "dataType": "String",
            "values": [
              "=input.SearchString"
            ]
          },
          {
            "name": "playbackLevel",
            "dataType": "Integer",
            "values": [
              "4"
            ],
            "required": true
          },
          {
            "name": "TimeRange",
            "dataType": "DateRange",
            "isList": false,
            "values": [
              "=input.TimeRange"
            ]
          },
          {
            "name": "userlist",
            "dataType": "Integer",
            "isList": true,
            "values": [
              "=input.userlist"
            ]
          },
          {
            "name": "usergrouplist",
            "dataType": "Integer",
            "isList": true,
            "values": [
              "=input.usergrouplist"
            ]
          }
        ],
        "sqlText": "--declare @sys_userid int =1\n--declare @sys_locale varchar(max) ",
        "timeout": 5,
        "postQueryFilter": true,
        "rDataSetQuery": "",
        "rPlotQuery": ""
      },
      "description": "will show the audit details by honoring user security and selected filters",
      "databaseName": "CommServ",
      "deployed": true,
      "queryPlan": {
        "offline": false,
        "collectionType": "HTTP",
        "retentionDays": 1,
        "versions": [
          "VERSION_11"
        ],
        "dynamicCollection": false,
        "frequency": 60,
        "direct": false
      },
      "version": 6,
      "guid": "2b3e43c0-21fe-401d-ebf8-c485309262a7",
      "hidden": false,
      "readOnly": false,
      "revision": "$Revision: 1.1.2.3 $",
      "visibleAll": false,
      "computedColumns": {
        "scriptName": "R",
        "script": ""
      },
      "visibleToTenantAdmins": true,
      "builtIn": true,
      "systemDataSet": false,
      "signature": "IyBTSEEtNTEyIFJTQSBFTVNBLVBLQ1MxL"
    },
    {
      "dataSet": {
        "dataSetId": 3602,
        "dataSetName": "TenantNOCMM",
        "dataSetGuid": "68ff721c-965a-4fce-e588-00b2a51662b9"
      },
      "endpoint": "DATABASE",
      "shared": true,
      "dataSources": [
        {
          "dataSource": {
            "dataSourceName": ""
          },
          "connectionType": "COMMCELL",
          "commCell": {
            "commCellName": "$LocalCommCell$"
          },
          "databaseName": ""
        }
      ],
      "allColumns": false,
      "fields": [
        {
          "name": "sys_rowid",
          "dataField": "$row_number$",
          "type": "String"
        },
        {
          "name": "Data Source",
          "dataField": "Data Source",
          "type": "String"
        },
        {
          "name": "CompanyId",
          "dataField": "CompanyId",
          "type": "Integer"
        },
        {
          "name": "CompanyGUID",
          "dataField": "CompanyGUID",
          "type": "String"
        },
        {
          "name": "Company",
          "dataField": "Company",
          "type": "String"
        },
        {
          "name": "Ring",
          "dataField": "Ring",
          "type": "String"
        },
        {
          "name": "LibLowStorage",
          "dataField": "LibLowStorage",
          "type": "Integer"
        },
        {
          "name": "MAOffline",
          "dataField": "MAOffline",
          "type": "Integer"
        },
        {
          "name": "LibOffline",
          "dataField": "LibOffline",
          "type": "Integer"
        },
        {
          "name": "MADiskSpaceLow",
          "dataField": "MADiskSpaceLow",
          "type": "Integer"
        },
        {
          "name": "DDBDiskSpaceLow",
          "dataField": "DDBDiskSpaceLow",
          "type": "Integer"
        }
      ],
      "GetOperation": {
        "parameters": [
          {
            "name": "i_UserId",
            "dataType": "Integer",
            "values": [
              "=@sys_userid"
            ]
          }
        ],
        "sqlText": "IF OBJECT_ID('tempdb.dbo.#tmpTenantNOC') IS NOT NULL",
        "timeout": 5,
        "postQueryFilter": true,
        "rDataSetQuery": "",
        "rPlotQuery": ""
      },
      "description": "",
      "databaseName": "CVCloud",
      "deployed": true,
      "queryPlan": {
        "offline": false,
        "collectionType": "HTTP",
        "retentionDays": 1,
        "versions": [
          "VERSION_11"
        ],
        "dynamicCollection": false,
        "frequency": 60,
        "direct": false
      },
      "version": 160,
      "guid": "68ff721c-965a-4fce-e588-00b2a51662b9",
      "hidden": false,
      "readOnly": false,
      "revision": "$Revision: 1.1.2.2 $",
      "visibleAll": false,
      "computedColumns": {
        "scriptName": "R",
        "script": ""
      },
      "visibleToTenantAdmins": false,
      "builtIn": true,
      "systemDataSet": false,
      "signature": ""
    }
  ]
}

List All Data Set​

List All Data Set