API Reference

Additional Objects

BaseResponseOfCollectionOfFolderableDto

Properties

NameTypeDescriptionRestrictions
body[FolderableDto]
codeinteger(int32)

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "metadata": {},
      "modified": "2019-08-24T14:15:22Z",
      "modifiedBy": "string",
      "name": "string",
      "parentId": "string",
      "type": 0,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "code": 0
}

BaseResponseOfConnectionDto

Properties

NameTypeDescriptionRestrictions
bodyConnectionDto
codeinteger(int32)

Example

{
  "body": {
    "connectionId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "destinationId": "string",
    "destinationType": "spreadsheet",
    "destinationWorkspaceId": "string",
    "lastRunBy": "string",
    "lastRunDate": "2019-08-24T14:15:22Z",
    "lastRunDestinationParameters": {
      "property1": {},
      "property2": {}
    },
    "lastRunJobId": "string",
    "lastRunSourceParameters": {
      "property1": {},
      "property2": {}
    },
    "metadata": {
      "property1": {},
      "property2": {}
    },
    "name": "string",
    "sourceId": "string",
    "sourceType": "spreadsheet",
    "sourceWorkspaceId": "string"
  },
  "code": 0
}

BaseResponseOfConnectionRunDto

Properties

NameTypeDescriptionRestrictions
bodyConnectionRunDto
codeinteger(int32)

Example

{
  "body": {
    "connectionId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "destinationParameters": {},
    "destinationStatus": "not_started",
    "destinationWorkspaceId": "string",
    "error": "string",
    "jobId": "string",
    "sourceParameters": {},
    "sourceStatus": "not_started",
    "sourceWorkspaceId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "workspaceId": "string"
  },
  "code": 0
}

BaseResponseOfFileMetaDto

Properties

NameTypeDescriptionRestrictions
bodyFileMetaDto
codeinteger(int32)

Example

{
  "body": {
    "columnMappings": {
      "property1": "string",
      "property2": "string"
    },
    "created": "2019-08-24T14:15:22Z",
    "delimiter": "string",
    "id": "string",
    "key": "string",
    "metadata": {
      "property1": {
        "property1": {},
        "property2": {}
      },
      "property2": {
        "property1": {},
        "property2": {}
      }
    },
    "name": "string",
    "numErrors": 0,
    "numRecords": 0,
    "originalFileSize": 0,
    "source": "string",
    "status": "STAGING",
    "tableId": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfFolderDto

Properties

NameTypeDescriptionRestrictions
bodyFolderDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "description": "string",
    "id": "string",
    "name": "string",
    "parentId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfGlobalParameterDto

Properties

NameTypeDescriptionRestrictions
bodyGlobalParameterDto
codeinteger(int32)

Example

{
  "body": {
    "choices": [
      {}
    ],
    "created": "2019-08-24T14:15:22Z",
    "databaseId": "string",
    "description": "string",
    "id": "string",
    "label": "string",
    "mode": "scalar",
    "name": "string",
    "overridable": false,
    "selectListId": "string",
    "type": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "value": {},
    "version": 0
  },
  "code": 0
}

BaseResponseOfImportInfoDto

Properties

NameTypeDescriptionRestrictions
bodyImportInfoDto
codeinteger(int32)

Example

{
  "body": {
    "numFiles": 0,
    "numRecords": 0,
    "tableId": "string"
  },
  "code": 0
}

BaseResponseOfMapOfstringAndstring

Properties

NameTypeDescriptionRestrictions
bodyobject
body.additionalPropertiesstring
codeinteger(int32)

Example

{
  "body": {
    "property1": "string",
    "property2": "string"
  },
  "code": 0
}

BaseResponseOfPivotViewDto

Properties

NameTypeDescriptionRestrictions
bodyPivotViewDto
codeinteger(int32)

Example

{
  "body": {
    "additionalMeta": {
      "property1": {},
      "property2": {}
    },
    "created": "2019-08-24T14:15:22Z",
    "description": "string",
    "id": "string",
    "name": "string",
    "parentId": "string",
    "queryId": "string",
    "queryResultId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfQueryColumnDataDto

Properties

NameTypeDescriptionRestrictions
bodyQueryColumnDataDto
codeinteger(int32)

Example

{
  "body": {
    "columns": [
      {
        "alias": "string",
        "description": "string",
        "metadata": {
          "property1": {},
          "property2": {}
        },
        "mode": "nullable",
        "name": "string",
        "type": "string"
      }
    ]
  },
  "code": 0
}

BaseResponseOfQueryDto

Properties

NameTypeDescriptionRestrictions
bodyQueryDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "definition": {
      "columns": [
        {
          "columnType": "integer",
          "name": "string"
        }
      ],
      "decimalPlaces": 16,
      "filters": [
        {
          "betweenValue": "string",
          "columnType": "integer",
          "exclude": false,
          "filter": "EQUAL",
          "filterValues": [
            "string"
          ],
          "name": "string",
          "value": "string"
        }
      ],
      "grandTotalEnabled": "ENABLED",
      "id": "string",
      "multipleHeaders": false,
      "pivotViewType": "CLASSIC",
      "rows": [
        {
          "name": "string",
          "type": "integer"
        }
      ],
      "sortColumns": [
        "string"
      ],
      "subtotalEnabled": "ENABLED",
      "values": [
        {
          "active": true,
          "aggregation": "sum",
          "columnType": "integer",
          "name": "string"
        }
      ]
    },
    "dependencies": [
      {
        "databaseId": "string",
        "system": "prep",
        "tableId": "string"
      }
    ],
    "description": "string",
    "historyRevision": 0,
    "id": "string",
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunBy": "string",
    "name": "string",
    "parameters": [
      {
        "alias": "string",
        "choices": [
          {}
        ],
        "id": "string",
        "label": "string",
        "mode": "scalar",
        "name": "string",
        "overridable": false,
        "reference": {},
        "selectListId": "string",
        "type": "string",
        "value": {}
      }
    ],
    "parentId": "string",
    "primaryQueryResultId": "string",
    "queryText": "string",
    "temporary": false,
    "type": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfQueryResultDto

Properties

NameTypeDescriptionRestrictions
bodyQueryResultDto
codeinteger(int32)

Example

{
  "body": {
    "bytesScanned": 0,
    "columns": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "duration": 0,
    "error": "string",
    "id": "string",
    "isExplain": false,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "pivotStatus": "NOT_STARTED",
    "queryDto": {
      "created": "2019-08-24T14:15:22Z",
      "definition": {
        "columns": [
          {
            "columnType": "integer",
            "name": "string"
          }
        ],
        "decimalPlaces": 16,
        "filters": [
          {
            "betweenValue": "string",
            "columnType": "integer",
            "exclude": false,
            "filter": "EQUAL",
            "filterValues": [
              "string"
            ],
            "name": "string",
            "value": "string"
          }
        ],
        "grandTotalEnabled": "ENABLED",
        "id": "string",
        "multipleHeaders": false,
        "pivotViewType": "CLASSIC",
        "rows": [
          {
            "name": "string",
            "type": "integer"
          }
        ],
        "sortColumns": [
          "string"
        ],
        "subtotalEnabled": "ENABLED",
        "values": [
          {
            "active": true,
            "aggregation": "sum",
            "columnType": "integer",
            "name": "string"
          }
        ]
      },
      "dependencies": [
        {
          "databaseId": "string",
          "system": "prep",
          "tableId": "string"
        }
      ],
      "description": "string",
      "historyRevision": 0,
      "id": "string",
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunBy": "string",
      "name": "string",
      "parameters": [
        {
          "alias": "string",
          "choices": [
            {}
          ],
          "id": "string",
          "label": "string",
          "mode": "scalar",
          "name": "string",
          "overridable": false,
          "reference": {},
          "selectListId": "string",
          "type": "string",
          "value": {}
        }
      ],
      "parentId": "string",
      "primaryQueryResultId": "string",
      "queryText": "string",
      "temporary": false,
      "type": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    },
    "queryId": "string",
    "queryParameters": [
      {
        "alias": "string",
        "choices": [
          {}
        ],
        "id": "string",
        "label": "string",
        "mode": "scalar",
        "name": "string",
        "overridable": false,
        "reference": {},
        "selectListId": "string",
        "type": "string",
        "value": {}
      }
    ],
    "queryText": "string",
    "rowsReturned": 0,
    "size": 0,
    "status": "NOT_STARTED",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfRefreshBatchDto

Properties

NameTypeDescriptionRestrictions
bodyRefreshBatchDto
codeinteger(int32)

Example

{
  "body": {
    "batchRefreshId": "string",
    "childRefreshes": [
      {
        "connectionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "destinationParameters": {},
        "destinationStatus": "not_started",
        "destinationWorkspaceId": "string",
        "error": "string",
        "jobId": "string",
        "sourceParameters": {},
        "sourceStatus": "not_started",
        "sourceWorkspaceId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "workspaceId": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "destinationStatus": "not_started",
    "error": "string",
    "sourceStatus": "not_started",
    "updated": "2019-08-24T14:15:22Z"
  },
  "code": 0
}

BaseResponseOfSelectListDto

Properties

NameTypeDescriptionRestrictions
bodySelectListDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "description": "string",
    "id": "string",
    "name": "string",
    "type": "static",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "valueType": "string",
    "values": [
      {}
    ],
    "version": 0
  },
  "code": 0
}

BaseResponseOfSharedTableDto

Properties

NameTypeDescriptionRestrictions
bodySharedTableDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "destinationWorkspaceId": "string",
    "id": "string",
    "parentId": "string",
    "sourceTableId": "string",
    "table": {
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "datasetUpdated": "2019-08-24T14:15:22Z",
      "deleted": false,
      "description": "string",
      "id": "string",
      "isShared": false,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": false,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": {},
              "property2": {}
            },
            "mode": "nullable",
            "name": "string",
            "type": "string"
          }
        ]
      },
      "type": "data",
      "uniqueTableConstraints": [
        {
          "description": "string",
          "id": "string",
          "name": "key_columns",
          "tableId": "string",
          "values": [
            "string"
          ]
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    },
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfSpreadsheetInfoDto

Properties

NameTypeDescriptionRestrictions
bodySpreadsheetInfoDto
codeinteger(int32)

Example

{
  "body": {
    "sheetId": "string",
    "workbookId": "string"
  },
  "code": 0
}

BaseResponseOfTableDto

Properties

NameTypeDescriptionRestrictions
bodyTableDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "databaseId": "string",
    "datasetUpdated": "2019-08-24T14:15:22Z",
    "deleted": false,
    "description": "string",
    "id": "string",
    "isShared": false,
    "lastUploaded": "2019-08-24T14:15:22Z",
    "name": "string",
    "parentId": "string",
    "readOnly": false,
    "tableSchema": {
      "columns": [
        {
          "alias": "string",
          "description": "string",
          "metadata": {
            "property1": {},
            "property2": {}
          },
          "mode": "nullable",
          "name": "string",
          "type": "string"
        }
      ]
    },
    "type": "data",
    "uniqueTableConstraints": [
      {
        "description": "string",
        "id": "string",
        "name": "key_columns",
        "tableId": "string",
        "values": [
          "string"
        ]
      }
    ],
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfTagDto

Properties

NameTypeDescriptionRestrictions
bodyTagDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "id": "string",
    "key": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "values": [
      "string"
    ],
    "version": 0
  },
  "code": 0
}

BaseResponseOfTokenDto

Properties

NameTypeDescriptionRestrictions
bodyTokenDto
codeinteger(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "id": "string",
    "objectId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "useFlatKey": false,
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseOfValidateFilesDto

Properties

NameTypeDescriptionRestrictions
bodyValidateFilesDto
codeinteger(int32)

Example

{
  "body": {
    "deletedFiles": [
      {
        "columnMappings": {
          "property1": "string",
          "property2": "string"
        },
        "created": "2019-08-24T14:15:22Z",
        "delimiter": "string",
        "id": "string",
        "key": "string",
        "metadata": {
          "property1": {
            "property1": {},
            "property2": {}
          },
          "property2": {
            "property1": {},
            "property2": {}
          }
        },
        "name": "string",
        "numErrors": 0,
        "numRecords": 0,
        "originalFileSize": 0,
        "source": "string",
        "status": "STAGING",
        "tableId": "string",
        "tags": {
          "property1": "string",
          "property2": "string"
        },
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      }
    ],
    "repairedFiles": [
      {
        "columnMappings": {
          "property1": "string",
          "property2": "string"
        },
        "created": "2019-08-24T14:15:22Z",
        "delimiter": "string",
        "id": "string",
        "key": "string",
        "metadata": {
          "property1": {
            "property1": {},
            "property2": {}
          },
          "property2": {
            "property1": {},
            "property2": {}
          }
        },
        "name": "string",
        "numErrors": 0,
        "numRecords": 0,
        "originalFileSize": 0,
        "source": "string",
        "status": "STAGING",
        "tableId": "string",
        "tags": {
          "property1": "string",
          "property2": "string"
        },
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      }
    ]
  },
  "code": 0
}

BaseResponseOfValidateTablesDto

Properties

NameTypeDescriptionRestrictions
bodyValidateTablesDto
codeinteger(int32)

Example

{
  "body": {
    "deletedTables": [
      {
        "created": "2019-08-24T14:15:22Z",
        "databaseId": "string",
        "datasetUpdated": "2019-08-24T14:15:22Z",
        "deleted": false,
        "description": "string",
        "id": "string",
        "isShared": false,
        "lastUploaded": "2019-08-24T14:15:22Z",
        "name": "string",
        "parentId": "string",
        "readOnly": false,
        "tableSchema": {
          "columns": [
            {
              "alias": "string",
              "description": "string",
              "metadata": {
                "property1": {},
                "property2": {}
              },
              "mode": "nullable",
              "name": "string",
              "type": "string"
            }
          ]
        },
        "type": "data",
        "uniqueTableConstraints": [
          {
            "description": "string",
            "id": "string",
            "name": "key_columns",
            "tableId": "string",
            "values": [
              "string"
            ]
          }
        ],
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      }
    ],
    "repairedTables": [
      {
        "created": "2019-08-24T14:15:22Z",
        "databaseId": "string",
        "datasetUpdated": "2019-08-24T14:15:22Z",
        "deleted": false,
        "description": "string",
        "id": "string",
        "isShared": false,
        "lastUploaded": "2019-08-24T14:15:22Z",
        "name": "string",
        "parentId": "string",
        "readOnly": false,
        "tableSchema": {
          "columns": [
            {
              "alias": "string",
              "description": "string",
              "metadata": {
                "property1": {},
                "property2": {}
              },
              "mode": "nullable",
              "name": "string",
              "type": "string"
            }
          ]
        },
        "type": "data",
        "uniqueTableConstraints": [
          {
            "description": "string",
            "id": "string",
            "name": "key_columns",
            "tableId": "string",
            "values": [
              "string"
            ]
          }
        ],
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      }
    ]
  },
  "code": 0
}

BaseResponseOflong

Properties

NameTypeDescriptionRestrictions
bodyinteger(int64)
codeinteger(int32)

Example

{
  "body": 0,
  "code": 0
}

BaseResponseOfstring

Properties

NameTypeDescriptionRestrictions
bodystring
codeinteger(int32)

Example

{
  "body": "string",
  "code": 0
}

Column

Properties

NameTypeDescriptionRestrictions
aliasstring
descriptionstring
metadataobject
metadata.additionalPropertiesobject
modestring
namestring
typestring

Enumerated Values

PropertyValue
modenullable
moderequired
moderepeated
typestring
typebytes
typeinteger
typefloat
typeboolean
typetimestamp
typedate
typetime
typedatetime
typeglobal_parameter
typenested_query_parameter

Example

{
  "alias": "string",
  "description": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "mode": "nullable",
  "name": "string",
  "type": "string"
}

ColumnDto

Properties

NameTypeDescriptionRestrictions
aliasstringOptional alias, may be at most 255 characters in length
descriptionstringMay be at most 255 characters in length
metadataobjectOptional type metadata. Current allowed parameters are: 'formatString' allows users to define their own Java8 datetime format string.'numberFormat' allows parsing of alternative decimal formats such as 1.000,00
metadata.additionalPropertiesobject
modestringThis property is for future use, currently always set to nullable
namestringMay be at most 100 characters in length
typestringThe type of column

Enumerated Values

PropertyValue
modenullable
moderequired
moderepeated
typestring
typebytes
typeinteger
typefloat
typeboolean
typetimestamp
typedate
typetime
typedatetime
typeglobal_parameter
typenested_query_parameter

Example

{
  "alias": "string",
  "description": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "mode": "nullable",
  "name": "string",
  "type": "string"
}

ColumnInfoDto

Properties

NameTypeDescriptionRestrictions
namestringThe name of the columnread-only
typestringThe column's typeread-only

Enumerated Values

PropertyValue
typestring
typebytes
typeinteger
typefloat
typeboolean
typetimestamp
typedate
typetime
typedatetime
typeglobal_parameter
typenested_query_parameter

Example

{
  "name": "string",
  "type": "string"
}

ConnectionDto

Properties

NameTypeDescriptionRestrictions
connectionIdstringThe unique ID of the connectionread-only
createdstring(date-time)When the connection was created, as a datetimeread-only
createdBystringThe ID of the user that created the connectionread-only
descriptionstringThe description of the connection, if specifiedread-only
destinationIdstringThe ID of the file or item the connection sends data toread-only
destinationTypestringThe type of file or item the connection sends data toread-only
destinationWorkspaceIdstringThe workspace of the file or item the connection pulls data toread-only
lastRunBystringThe ID of the user that last ran the connectionread-only
lastRunDatestring(date-time)When the connection last ran, as a datetimeread-only
lastRunDestinationParametersobjectA map of the parameters used with the destination when the connection last ranread-only
lastRunDestinationParameters.additionalPropertiesobject
lastRunJobIdstringThe ID of the connection's last runread-only
lastRunSourceParametersobjectA map of the parameters used with the source when the connection last ranread-only
lastRunSourceParameters.additionalPropertiesobject
metadataobjectAny additional information about the connectionread-only
metadata.additionalPropertiesobject
namestringThe name of the connection, if specifiedread-only
sourceIdstringThe ID of the file or item the connection pulls data fromread-only
sourceTypestringThe type of file or item the connection pulls data fromread-only
sourceWorkspaceIdstringThe workspace of the file or item the connection pulls data fromread-only

Enumerated Values

PropertyValue
destinationTypespreadsheet
destinationTypespreadsheet_section
destinationTypepresentation
destinationTypepresentation_chart
destinationTypepresentation_embedded_table
destinationTypedocument
destinationTypedocument_chart
destinationTypedocument_embedded_table
destinationTypewdata_query
destinationTypewdata_table
destinationTypewdata_table_dataset
destinationTypereport
destinationTypeunknown_record_type
sourceTypespreadsheet
sourceTypespreadsheet_section
sourceTypepresentation
sourceTypepresentation_chart
sourceTypepresentation_embedded_table
sourceTypedocument
sourceTypedocument_chart
sourceTypedocument_embedded_table
sourceTypewdata_query
sourceTypewdata_table
sourceTypewdata_table_dataset
sourceTypereport
sourceTypeunknown_record_type

Example

{
  "connectionId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "destinationId": "string",
  "destinationType": "spreadsheet",
  "destinationWorkspaceId": "string",
  "lastRunBy": "string",
  "lastRunDate": "2019-08-24T14:15:22Z",
  "lastRunDestinationParameters": {
    "property1": {},
    "property2": {}
  },
  "lastRunJobId": "string",
  "lastRunSourceParameters": {
    "property1": {},
    "property2": {}
  },
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "name": "string",
  "sourceId": "string",
  "sourceType": "spreadsheet",
  "sourceWorkspaceId": "string"
}

ConnectionRunDto

Properties

NameTypeDescriptionRestrictions
connectionIdstringThe unique ID of the connectionread-only
createdstring(date-time)When the connection was created, as a datetimeread-only
createdBystringThe ID of the user that created the connectionread-only
destinationParametersobjectAny parameters provided to the destinationread-only
destinationStatusstringThe run status of the destinationread-only
destinationWorkspaceIdstringThe workspace of the the run destinationread-only
errorstringAn error, if encountered, while initiating the jobread-only
jobIdstringThe unique ID of the jobread-only
sourceParametersobjectAny parameters provided to the sourceread-only
sourceStatusstringThe run status of the sourceread-only
sourceWorkspaceIdstringThe workspace of the run sourceread-only
updatedstring(date-time)When the connection was updated, as a datetimeread-only
workspaceIdstringThe workspace id for this connectionread-only

Enumerated Values

PropertyValue
destinationStatusnot_started
destinationStatusrunning
destinationStatuscomplete
destinationStatuserror
destinationStatuscancelled
sourceStatusnot_started
sourceStatusrunning
sourceStatuscomplete
sourceStatuserror
sourceStatuscancelled

Example

{
  "connectionId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationParameters": {},
  "destinationStatus": "not_started",
  "destinationWorkspaceId": "string",
  "error": "string",
  "jobId": "string",
  "sourceParameters": {},
  "sourceStatus": "not_started",
  "sourceWorkspaceId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "workspaceId": "string"
}

DatetimeDto

Properties

NameTypeDescriptionRestrictions
candidatestringCandidate to parse with the provided dateformat.
dateFormatstringThe dateformat of the candidate to test.

Example

{
  "candidate": "string",
  "dateFormat": "string"
}

ExportFileDto

Properties

NameTypeDescriptionRestrictions
urlstringURL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.

Example

{
  "url": "string"
}

ExportQueryResultDto

Properties

NameTypeDescriptionRestrictions
exportAsDatasetbooleanIf set to true, the data will be exported as a connected dataset to spreadsheets.
urlstringURL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.
useFlatKeybooleanExport flat query results in the context of crosstab queries; Ignored unless true.

Example

{
  "exportAsDataset": false,
  "url": "string",
  "useFlatKey": false
}

FileMetaDto

Properties

NameTypeDescriptionRestrictions
columnMappingsobjectMaps the columns in the physical file (CSV or JSON) to the columns in fact table = {"physical_col1":"table_col1", "physical_col2":"table_col2"}read-only
columnMappings.additionalPropertiesstring
createdstring(date-time)When the entity was createdread-only
delimiterstringThe character to use as a delimiter within the file to separate one field from another. The default is commaread-only
idstringThe entity's unique identifierread-only
keystringThe key is here for backwards compatibility only and will always be an empty string.read-only
metadataobjectThe file's meta dataread-only
metadata.additionalPropertiesobject
metadata.additionalProperties.additionalPropertiesobject
namestringThe name of the fileread-only
numErrorsinteger(int64)Number of errors found in the fileread-only
numRecordsinteger(int64)Number of records imported from this file. This will only be non-zero if the file is in the IMPORTED status.read-only
originalFileSizeinteger(int64)Size of the original file that was uploaded.read-only
sourcestringURI that describes the source location of this file if imported from another system. For instance, this will have a spreadsheet URL if this file was imported from spreadsheets. This will be null if the file was uploaded using the data prep API.read-only
statusstringThe files's current statusread-only
tableIdstringThe unique identifier for the tableread-only
tagsobjectThe tags associated with the fileread-only
tags.additionalPropertiesstring
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Enumerated Values

PropertyValue
statusSTAGING
statusSTAGED
statusIMPORTING
statusIMPORTED
statusERROR

Example

{
  "columnMappings": {
    "property1": "string",
    "property2": "string"
  },
  "created": "2019-08-24T14:15:22Z",
  "delimiter": "string",
  "id": "string",
  "key": "string",
  "metadata": {
    "property1": {
      "property1": {},
      "property2": {}
    },
    "property2": {
      "property1": {},
      "property2": {}
    }
  },
  "name": "string",
  "numErrors": 0,
  "numRecords": 0,
  "originalFileSize": 0,
  "source": "string",
  "status": "STAGING",
  "tableId": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

FolderDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
descriptionstringA description of the folder
idstringThe entity's unique identifierread-only
namestringThe name of the folder
parentIdstringThe ID of the folder to which this folder belongs. This can be null if the folder is not in another folder.
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

FolderableDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
descriptionstringA description of the folderable entityread-only
idstringThe UUID unique identifier for the entity.
metadataobjectContains additional metadata about the entity returned. For example, a table entity might have a type attribute.read-only
modifiedstring(date-time)When a significant event happened on the data object. For example, for queries, this is when the last run occurred; for tables, this is when the last upload occurred.read-only
modifiedBystringThe identifier of the user who last modified the entityread-only
namestringThe name of the folderable entityread-only
parentIdstringThe ID of the folder to which this entity belongs. This can be null if the entity is not in a folder.read-only
typeinteger(int32)The numerical identifier for the entity's type: Query=100, Table=200, Pivot View=500, Folder=600, Shared Table=700
updatedstring(date-time)When the data object was last updatedread-only
updatedBystringThe identifier of the user who last updated the entityread-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "metadata": {},
  "modified": "2019-08-24T14:15:22Z",
  "modifiedBy": "string",
  "name": "string",
  "parentId": "string",
  "type": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

GlobalParameterDto

Properties

NameTypeDescriptionRestrictions
choices[object]If the parameter is of type select, this is a list of possible choices. This is read only and is for listing and viewing reports to help the user.read-only
createdstring(date-time)When the entity was createdread-only
databaseIdstringThe unique identifier of the database where this parameter can be used to filter query resultsread-only
descriptionstringThe description of the parameter
idstringThe entity's unique identifierread-only
labelstringThe label for the query parameter
modestringThe mode of the parameter
namestringThe name of the parameter
overridablebooleanDenotes if this parameter can be overridden later in the process, either when the query is created or executed. The default is true; it can be overridden.
selectListIdstringIf mode is select, this must be populated and is a reference to a select list from which choices will be derived.
typestringThe type of the parameter
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
valueobjectThe default value of the parameter
versioninteger(int64)The version of the current representation of the entityread-only

Enumerated Values

PropertyValue
modescalar
modesingleSelect
modemultiSelect
typestring
typebytes
typeinteger
typefloat
typeboolean
typetimestamp
typedate
typetime
typedatetime
typeglobal_parameter
typenested_query_parameter

Example

{
  "choices": [
    {}
  ],
  "created": "2019-08-24T14:15:22Z",
  "databaseId": "string",
  "description": "string",
  "id": "string",
  "label": "string",
  "mode": "scalar",
  "name": "string",
  "overridable": false,
  "selectListId": "string",
  "type": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "value": {},
  "version": 0
}

ImportDto

Properties

NameTypeDescriptionRestrictions
columnMappingsobjecta map of import column names to table column ids
columnMappings.additionalPropertiesstring
delimiterstringFor overriding the file metadata's delimiter. The file delimiter is the character to use within the file to separate one field from another. If this value is not set, the import will use the file's set delimiter. If this value is set, the file metadata's delimiter will be updated on the file object.
fileIdstringid of the file to import to the table
metadataobjectFor overriding column metadata specifically for this import. The keys in this object are column identifiers with the values being metadata objects.
metadata.additionalPropertiesobject
metadata.additionalProperties.additionalPropertiesobject
tagsobjectan object containing keys and values, which becomes the tag map
tags.additionalPropertiesstring

Example

{
  "columnMappings": "{\"import column id\":\"table column id\"}",
  "delimiter": "string",
  "fileId": "string",
  "metadata": {
    "property1": {
      "property1": {},
      "property2": {}
    },
    "property2": {
      "property1": {},
      "property2": {}
    }
  },
  "tags": "{\"key\": \"value\"}"
}

ImportErrorDto

Properties

NameTypeDescriptionRestrictions
codeinteger(int64)The error coderead-only
createdstring(date-time)When the entity was createdread-only
idstringThe entity's unique identifierread-only
lineNumberinteger(int64)Contains the line number the error occurred on if the error can be reduced to a single line (ie, date formatting error)read-only
messagestringThe error messageread-only
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "code": 0,
  "created": "2019-08-24T14:15:22Z",
  "id": "string",
  "lineNumber": 0,
  "message": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

ImportFromSpreadsheetDto

Properties

NameTypeDescriptionRestrictions
fileIdstring
namestring
tagsobject
tags.additionalPropertiesstring
urlstring

Example

{
  "fileId": "string",
  "name": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "url": "string"
}

ImportInfoDto

Properties

NameTypeDescriptionRestrictions
numFilesinteger(int64)The total number of individual files imported to the table.
numRecordsinteger(int64)The total number of records/rows of data imported to the table.
tableIdstringThe id for the table that the import info applies to.

Example

{
  "numFiles": 0,
  "numRecords": 0,
  "tableId": "string"
}

MapOfstringAndobject

Properties

NameTypeDescriptionRestrictions
additionalPropertiesobject

Example

{
  "property1": {},
  "property2": {}
}

MapOfstringAndstring

Properties

NameTypeDescriptionRestrictions
additionalPropertiesstring

Example

{
  "property1": "string",
  "property2": "string"
}

MultiError

Properties

NameTypeDescriptionRestrictions
body[string]
codeinteger(int32)

Example

{
  "body": [
    "string"
  ],
  "code": 0
}

PagedResponseOfConnectionDto

Properties

NameTypeDescriptionRestrictions
body[ConnectionDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "connectionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "destinationId": "string",
      "destinationType": "spreadsheet",
      "destinationWorkspaceId": "string",
      "lastRunBy": "string",
      "lastRunDate": "2019-08-24T14:15:22Z",
      "lastRunDestinationParameters": {
        "property1": {},
        "property2": {}
      },
      "lastRunJobId": "string",
      "lastRunSourceParameters": {
        "property1": {},
        "property2": {}
      },
      "metadata": {
        "property1": {},
        "property2": {}
      },
      "name": "string",
      "sourceId": "string",
      "sourceType": "spreadsheet",
      "sourceWorkspaceId": "string"
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfFileMetaDto

Properties

NameTypeDescriptionRestrictions
body[FileMetaDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "columnMappings": {
        "property1": "string",
        "property2": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "delimiter": "string",
      "id": "string",
      "key": "string",
      "metadata": {
        "property1": {
          "property1": {},
          "property2": {}
        },
        "property2": {
          "property1": {},
          "property2": {}
        }
      },
      "name": "string",
      "numErrors": 0,
      "numRecords": 0,
      "originalFileSize": 0,
      "source": "string",
      "status": "STAGING",
      "tableId": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfFolderDto

Properties

NameTypeDescriptionRestrictions
body[FolderDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "name": "string",
      "parentId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfFolderableDto

Properties

NameTypeDescriptionRestrictions
body[FolderableDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "metadata": {},
      "modified": "2019-08-24T14:15:22Z",
      "modifiedBy": "string",
      "name": "string",
      "parentId": "string",
      "type": 0,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfGlobalParameterDto

Properties

NameTypeDescriptionRestrictions
body[GlobalParameterDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "choices": [
        {}
      ],
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "description": "string",
      "id": "string",
      "label": "string",
      "mode": "scalar",
      "name": "string",
      "overridable": false,
      "selectListId": "string",
      "type": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "value": {},
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfImportErrorDto

Properties

NameTypeDescriptionRestrictions
body[ImportErrorDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "code": 0,
      "created": "2019-08-24T14:15:22Z",
      "id": "string",
      "lineNumber": 0,
      "message": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfPivotViewDto

Properties

NameTypeDescriptionRestrictions
body[PivotViewDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "additionalMeta": {
        "property1": {},
        "property2": {}
      },
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "name": "string",
      "parentId": "string",
      "queryId": "string",
      "queryResultId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfQueryDto

Properties

NameTypeDescriptionRestrictions
body[QueryDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "definition": {
        "columns": [
          {
            "columnType": "integer",
            "name": "string"
          }
        ],
        "decimalPlaces": 16,
        "filters": [
          {
            "betweenValue": "string",
            "columnType": "integer",
            "exclude": false,
            "filter": "EQUAL",
            "filterValues": [
              "string"
            ],
            "name": "string",
            "value": "string"
          }
        ],
        "grandTotalEnabled": "ENABLED",
        "id": "string",
        "multipleHeaders": false,
        "pivotViewType": "CLASSIC",
        "rows": [
          {
            "name": "string",
            "type": "integer"
          }
        ],
        "sortColumns": [
          "string"
        ],
        "subtotalEnabled": "ENABLED",
        "values": [
          {
            "active": true,
            "aggregation": "sum",
            "columnType": "integer",
            "name": "string"
          }
        ]
      },
      "dependencies": [
        {
          "databaseId": "string",
          "system": "prep",
          "tableId": "string"
        }
      ],
      "description": "string",
      "historyRevision": 0,
      "id": "string",
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunBy": "string",
      "name": "string",
      "parameters": [
        {
          "alias": "string",
          "choices": [
            {}
          ],
          "id": "string",
          "label": "string",
          "mode": "scalar",
          "name": "string",
          "overridable": false,
          "reference": {},
          "selectListId": "string",
          "type": "string",
          "value": {}
        }
      ],
      "parentId": "string",
      "primaryQueryResultId": "string",
      "queryText": "string",
      "temporary": false,
      "type": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfQueryResultDto

Properties

NameTypeDescriptionRestrictions
body[QueryResultDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "bytesScanned": 0,
      "columns": [
        {
          "name": "string",
          "type": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "duration": 0,
      "error": "string",
      "id": "string",
      "isExplain": false,
      "parameters": {
        "property1": {},
        "property2": {}
      },
      "pivotStatus": "NOT_STARTED",
      "queryDto": {
        "created": "2019-08-24T14:15:22Z",
        "definition": {
          "columns": [
            {
              "columnType": "integer",
              "name": "string"
            }
          ],
          "decimalPlaces": 16,
          "filters": [
            {
              "betweenValue": "string",
              "columnType": "integer",
              "exclude": false,
              "filter": "EQUAL",
              "filterValues": [
                "string"
              ],
              "name": "string",
              "value": "string"
            }
          ],
          "grandTotalEnabled": "ENABLED",
          "id": "string",
          "multipleHeaders": false,
          "pivotViewType": "CLASSIC",
          "rows": [
            {
              "name": "string",
              "type": "integer"
            }
          ],
          "sortColumns": [
            "string"
          ],
          "subtotalEnabled": "ENABLED",
          "values": [
            {
              "active": true,
              "aggregation": "sum",
              "columnType": "integer",
              "name": "string"
            }
          ]
        },
        "dependencies": [
          {
            "databaseId": "string",
            "system": "prep",
            "tableId": "string"
          }
        ],
        "description": "string",
        "historyRevision": 0,
        "id": "string",
        "lastRun": "2019-08-24T14:15:22Z",
        "lastRunBy": "string",
        "name": "string",
        "parameters": [
          {
            "alias": "string",
            "choices": [
              {}
            ],
            "id": "string",
            "label": "string",
            "mode": "scalar",
            "name": "string",
            "overridable": false,
            "reference": {},
            "selectListId": "string",
            "type": "string",
            "value": {}
          }
        ],
        "parentId": "string",
        "primaryQueryResultId": "string",
        "queryText": "string",
        "temporary": false,
        "type": "string",
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      },
      "queryId": "string",
      "queryParameters": [
        {
          "alias": "string",
          "choices": [
            {}
          ],
          "id": "string",
          "label": "string",
          "mode": "scalar",
          "name": "string",
          "overridable": false,
          "reference": {},
          "selectListId": "string",
          "type": "string",
          "value": {}
        }
      ],
      "queryText": "string",
      "rowsReturned": 0,
      "size": 0,
      "status": "NOT_STARTED",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfSelectListDto

Properties

NameTypeDescriptionRestrictions
body[SelectListDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "name": "string",
      "type": "static",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "valueType": "string",
      "values": [
        {}
      ],
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfSharedTableDto

Properties

NameTypeDescriptionRestrictions
body[SharedTableDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "destinationWorkspaceId": "string",
      "id": "string",
      "parentId": "string",
      "sourceTableId": "string",
      "table": {
        "created": "2019-08-24T14:15:22Z",
        "databaseId": "string",
        "datasetUpdated": "2019-08-24T14:15:22Z",
        "deleted": false,
        "description": "string",
        "id": "string",
        "isShared": false,
        "lastUploaded": "2019-08-24T14:15:22Z",
        "name": "string",
        "parentId": "string",
        "readOnly": false,
        "tableSchema": {
          "columns": [
            {
              "alias": "string",
              "description": "string",
              "metadata": {
                "property1": {},
                "property2": {}
              },
              "mode": "nullable",
              "name": "string",
              "type": "string"
            }
          ]
        },
        "type": "data",
        "uniqueTableConstraints": [
          {
            "description": "string",
            "id": "string",
            "name": "key_columns",
            "tableId": "string",
            "values": [
              "string"
            ]
          }
        ],
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      },
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfTableDto

Properties

NameTypeDescriptionRestrictions
body[TableDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "datasetUpdated": "2019-08-24T14:15:22Z",
      "deleted": false,
      "description": "string",
      "id": "string",
      "isShared": false,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": false,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": {},
              "property2": {}
            },
            "mode": "nullable",
            "name": "string",
            "type": "string"
          }
        ]
      },
      "type": "data",
      "uniqueTableConstraints": [
        {
          "description": "string",
          "id": "string",
          "name": "key_columns",
          "tableId": "string",
          "values": [
            "string"
          ]
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseOfTagDto

Properties

NameTypeDescriptionRestrictions
body[TagDto]
codeinteger(int32)
cursorstring

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "id": "string",
      "key": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "values": [
        "string"
      ],
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PivotDefinitionDto

Properties

NameTypeDescriptionRestrictions
columns[PivotViewDefinitionColumnDto]The colmnnns associated with the pivot view
decimalPlacesinteger(int32)Numeric data values are rounded to the number of decimal places. The default number to round to and show is 2 decimal places, and the maximum number is capped at 16.
filters[PivotViewDefinitionFilterDto]The filters associated with the pivot view
grandTotalEnabledstringThe level to which Grand Totals are enabled. It is defaulted to DISABLED.
idstringThe pivot view's definition's id
multipleHeadersbooleanDenotes whether a pivot is created in multi-line header mode. Default is false.
pivotViewTypestringThe type of pivot view. Options are currently Classic and Compact.
rows[PivotViewDefinitionRowDto]The rows associated with the pivot view
sortColumns[string]Columns with which to sort the crosstab query
subtotalEnabledstringThe level to which Subtotals are enabled. It is defaulted to DISABLED.
values[PivotViewDefinitionValueDto]The values associated with the pivot view

Enumerated Values

PropertyValue
grandTotalEnabledENABLED
grandTotalEnabledROW
grandTotalEnabledCOLUMN
grandTotalEnabledDISABLED
pivotViewTypeCLASSIC
pivotViewTypeCOMPACT
pivotViewTypeFLAT
subtotalEnabledENABLED
subtotalEnabledROW
subtotalEnabledCOLUMN
subtotalEnabledDISABLED

Example

{
  "columns": [
    {
      "columnType": "integer",
      "name": "string"
    }
  ],
  "decimalPlaces": 16,
  "filters": [
    {
      "betweenValue": "string",
      "columnType": "integer",
      "exclude": false,
      "filter": "EQUAL",
      "filterValues": [
        "string"
      ],
      "name": "string",
      "value": "string"
    }
  ],
  "grandTotalEnabled": "ENABLED",
  "id": "string",
  "multipleHeaders": false,
  "pivotViewType": "CLASSIC",
  "rows": [
    {
      "name": "string",
      "type": "integer"
    }
  ],
  "sortColumns": [
    "string"
  ],
  "subtotalEnabled": "ENABLED",
  "values": [
    {
      "active": true,
      "aggregation": "sum",
      "columnType": "integer",
      "name": "string"
    }
  ]
}

PivotViewDefinitionColumnDto

Properties

NameTypeDescriptionRestrictions
columnTypestringThe column type.
namestringName of the pivot view column. The maximum size is 255 characters.

Enumerated Values

PropertyValue
columnTypeinteger
columnTypenumber
columnTypeboolean
columnTypetimestamp
columnTypedate
columnTypestring
columnTypefloat

Example

{
  "columnType": "integer",
  "name": "string"
}

PivotViewDefinitionFilterDto

Properties

NameTypeDescriptionRestrictions
betweenValuestringA second value for 'between' filters
columnTypestringThe column type.
excludebooleanTrue if value list is exclude, false if value list is include. Defaults to true.
filterstringThe filter to perform.
filterValues[string]The values obtained after applying the filter
namestringThe column for the pivot view filter. The maximum size is 255 characters.
valuestringThe value to filter on.

Enumerated Values

PropertyValue
columnTypeinteger
columnTypenumber
columnTypeboolean
columnTypetimestamp
columnTypedate
columnTypestring
columnTypefloat
filterEQUAL
filterNOT_EQUAL
filterGREATER
filterGREATER_OR_EQUAL
filterLESS
filterLESS_OR_EQUAL
filterBETWEEN
filterNOT_BETWEEN

Example

{
  "betweenValue": "string",
  "columnType": "integer",
  "exclude": false,
  "filter": "EQUAL",
  "filterValues": [
    "string"
  ],
  "name": "string",
  "value": "string"
}

PivotViewDefinitionRowDto

Properties

NameTypeDescriptionRestrictions
namestringName of the pivot view row. The maximum size is 255 characters.
typestringThe column type.

Enumerated Values

PropertyValue
typeinteger
typenumber
typeboolean
typetimestamp
typedate
typestring
typefloat

Example

{
  "name": "string",
  "type": "integer"
}

PivotViewDefinitionValueDto

Properties

NameTypeDescriptionRestrictions
activeboolean
aggregationstringThe aggregation type to apply to the pivot view value
columnTypestringThe column type.
namestringName of the pivot view value. The maximum size is 255 characters.

Enumerated Values

PropertyValue
aggregationsum
aggregationcount
aggregationdistinctcount
aggregationaverage
aggregationmedian
aggregationproduct
aggregationmin
aggregationmax
aggregationpercent
aggregationpercentofcolumn
aggregationpercentofrow
aggregationdifference
aggregationpercentdifference
aggregationrunningtotals
aggregationstdevp
aggregationstdevs
columnTypeinteger
columnTypenumber
columnTypeboolean
columnTypetimestamp
columnTypedate
columnTypestring
columnTypefloat

Example

{
  "active": true,
  "aggregation": "sum",
  "columnType": "integer",
  "name": "string"
}

PivotViewDto

Properties

NameTypeDescriptionRestrictions
additionalMetaobjectUser-defined metadata to attach to the pivot view. This is any arbitrary JSON object and is not required.
additionalMeta.additionalPropertiesobject
createdstring(date-time)When the entity was createdread-only
descriptionstringThe description of the pivot view
idstringThe entity's unique identifierread-only
namestringName of the pivot view. The maximum size is 255 characters.
parentIdstringIf non-null, indicates the parent of this entity. Must be modified through the folder api.read-only
queryIdstringThe query to associate with this pivot view. This value is required and cannot be updated after the pivot is created. Any attempt to update the query ID is ignored.
queryResultIdstringAn optional query result id to associate with this pivot view. If associated, saving a pivot view will cause an existence check on the related query result. This value is not required. The query id on the query result must match this pivot's query ID.
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "additionalMeta": {
    "property1": {},
    "property2": {}
  },
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentId": "string",
  "queryId": "string",
  "queryResultId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

QueryColumnDataDto

Properties

NameTypeDescriptionRestrictions
columns[Column]

Example

{
  "columns": [
    {
      "alias": "string",
      "description": "string",
      "metadata": {
        "property1": {},
        "property2": {}
      },
      "mode": "nullable",
      "name": "string",
      "type": "string"
    }
  ]
}

QueryDependencyDto

Properties

NameTypeDescriptionRestrictions
databaseIdstringThe database in which this dependency exists.read-only
systemstringThe name of the system holding this reference.read-only
tableIdstringThe id of the table this dependency represents.read-only

Enumerated Values

PropertyValue
systemprep
systemspreadsheets
systemqueries
systemprogram
systemcom
systemiam
systemgraph
systemexplorer
systemprogram_v2
systemexplorer_v2

Example

{
  "databaseId": "string",
  "system": "prep",
  "tableId": "string"
}

QueryDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
definitionPivotDefinitionDto
dependencies[QueryDependencyDto]A structured list of dependencies that this query relies upon. This list is populated by the server from the query text. Each dependency model contains enough information to find the source object.read-only
descriptionstringThe description of the query
historyRevisioninteger(int64)Historical revision number of this entity
idstringThe entity's unique identifierread-only
lastRunstring(date-time)If non-null, indicates the last time this query was run.read-only
lastRunBystringIf non-null, indicates the last user that ran the query.read-only
namestringThe name of the query
parameters[QueryParameterDto]The query parameters
parentIdstringIf non-null, indicates the parent of this entity. Must be modified through the folder api.read-only
primaryQueryResultIdstringThe identifier of the primary query result
queryTextstringMax size is 30000 characters. Is required. Must be a valid DML statement.
temporarybooleanDenotes if this query is meant to be temporary. Default is false.
typestringThis field exists for backwards compatibility only and will always be an empty string.
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "definition": {
    "columns": [
      {
        "columnType": "integer",
        "name": "string"
      }
    ],
    "decimalPlaces": 16,
    "filters": [
      {
        "betweenValue": "string",
        "columnType": "integer",
        "exclude": false,
        "filter": "EQUAL",
        "filterValues": [
          "string"
        ],
        "name": "string",
        "value": "string"
      }
    ],
    "grandTotalEnabled": "ENABLED",
    "id": "string",
    "multipleHeaders": false,
    "pivotViewType": "CLASSIC",
    "rows": [
      {
        "name": "string",
        "type": "integer"
      }
    ],
    "sortColumns": [
      "string"
    ],
    "subtotalEnabled": "ENABLED",
    "values": [
      {
        "active": true,
        "aggregation": "sum",
        "columnType": "integer",
        "name": "string"
      }
    ]
  },
  "dependencies": [
    {
      "databaseId": "string",
      "system": "prep",
      "tableId": "string"
    }
  ],
  "description": "string",
  "historyRevision": 0,
  "id": "string",
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunBy": "string",
  "name": "string",
  "parameters": [
    {
      "alias": "string",
      "choices": [
        {}
      ],
      "id": "string",
      "label": "string",
      "mode": "scalar",
      "name": "string",
      "overridable": false,
      "reference": {},
      "selectListId": "string",
      "type": "string",
      "value": {}
    }
  ],
  "parentId": "string",
  "primaryQueryResultId": "string",
  "queryText": "string",
  "temporary": false,
  "type": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

QueryParameterDto

Properties

NameTypeDescriptionRestrictions
aliasstringThe alias of the query parameter, used to avoid name collisions for nested query parameter references
choices[object]If the query parameter is of type select, this is a list of possible choices. This is read only and is for listing and viewing reports to help the user.read-only
idstringThe entity's unique identifier, set if it is a reference kind.
labelstringThe label for the query parameter
modestringThe mode of the query parameter
namestringThe name of the query parameter
overridablebooleanWhether the parameter can be overridden, defaults to true.read-only
referenceobjectThe hydrated reference objectread-only
selectListIdstringIf mode is select, this must be populated and is a reference to a select list from which choices will be derived.
typestringThe type of the query parameter
valueobjectThe value of the query parameter

Enumerated Values

PropertyValue
modescalar
modesingleSelect
modemultiSelect
modereference
typestring
typebytes
typeinteger
typefloat
typeboolean
typetimestamp
typedate
typetime
typedatetime
typeglobal_parameter
typenested_query_parameter

Example

{
  "alias": "string",
  "choices": [
    {}
  ],
  "id": "string",
  "label": "string",
  "mode": "scalar",
  "name": "string",
  "overridable": false,
  "reference": {},
  "selectListId": "string",
  "type": "string",
  "value": {}
}

QueryResultDto

Properties

NameTypeDescriptionRestrictions
bytesScannedinteger(int64)The number of bytes scannedread-only
columns[ColumnInfoDto]If the query has successfully completed, contains a list of columns and their associated computed types from the query.read-only
createdstring(date-time)When the entity was createdread-only
durationinteger(int64)The duration of time it took to execute the queryread-only
errorstringIf an error was encountered during the query, this field will be populated with error text.read-only
idstringThe entity's unique identifierread-only
isExplainbooleanDetermines if this query is to be explained and not executed
parametersobjectThe query parameter map
parameters.additionalPropertiesobject
pivotStatusstringThe current status of the pivot executionread-only
queryDtoQueryDto
queryIdstringThe identifier of the original query
queryParameters[QueryParameterDto]Contains the parameters available to the query at the time it was run. This allows consumers to go back in time and view the state of the query at runtime. For older query runs, this value may not be populated.read-only
queryTextstringread-only
rowsReturnedinteger(int64)Contains the number of rows returned from the query.read-only
sizeinteger(int64)Contains the size of the query results in bytes. This can be used to determine how best to download the file and if it's reasonable to open it in a browser or other application. This may be 0 if there are no results or the query results were gathered before we started collecting this metric.read-only
statusstringThe current status of the query executionread-only
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Enumerated Values

PropertyValue
pivotStatusNOT_STARTED
pivotStatusRUNNING
pivotStatusCOMPLETE
pivotStatusERROR
pivotStatusCANCELLED
pivotStatusRUNNING_QUERY
pivotStatusPIVOT_QUEUED
pivotStatusRUNNING_PIVOT
pivotStatusQUERY_COMPLETE
pivotStatusNOT_APPLICABLE
pivotStatusPIVOT_ERROR
statusNOT_STARTED
statusRUNNING
statusCOMPLETE
statusERROR
statusCANCELLED

Example

{
  "bytesScanned": 0,
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "duration": 0,
  "error": "string",
  "id": "string",
  "isExplain": false,
  "parameters": {
    "property1": {},
    "property2": {}
  },
  "pivotStatus": "NOT_STARTED",
  "queryDto": {
    "created": "2019-08-24T14:15:22Z",
    "definition": {
      "columns": [
        {
          "columnType": "integer",
          "name": "string"
        }
      ],
      "decimalPlaces": 16,
      "filters": [
        {
          "betweenValue": "string",
          "columnType": "integer",
          "exclude": false,
          "filter": "EQUAL",
          "filterValues": [
            "string"
          ],
          "name": "string",
          "value": "string"
        }
      ],
      "grandTotalEnabled": "ENABLED",
      "id": "string",
      "multipleHeaders": false,
      "pivotViewType": "CLASSIC",
      "rows": [
        {
          "name": "string",
          "type": "integer"
        }
      ],
      "sortColumns": [
        "string"
      ],
      "subtotalEnabled": "ENABLED",
      "values": [
        {
          "active": true,
          "aggregation": "sum",
          "columnType": "integer",
          "name": "string"
        }
      ]
    },
    "dependencies": [
      {
        "databaseId": "string",
        "system": "prep",
        "tableId": "string"
      }
    ],
    "description": "string",
    "historyRevision": 0,
    "id": "string",
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunBy": "string",
    "name": "string",
    "parameters": [
      {
        "alias": "string",
        "choices": [
          {}
        ],
        "id": "string",
        "label": "string",
        "mode": "scalar",
        "name": "string",
        "overridable": false,
        "reference": {},
        "selectListId": "string",
        "type": "string",
        "value": {}
      }
    ],
    "parentId": "string",
    "primaryQueryResultId": "string",
    "queryText": "string",
    "temporary": false,
    "type": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "queryId": "string",
  "queryParameters": [
    {
      "alias": "string",
      "choices": [
        {}
      ],
      "id": "string",
      "label": "string",
      "mode": "scalar",
      "name": "string",
      "overridable": false,
      "reference": {},
      "selectListId": "string",
      "type": "string",
      "value": {}
    }
  ],
  "queryText": "string",
  "rowsReturned": 0,
  "size": 0,
  "status": "NOT_STARTED",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

QueryTextDto

Properties

NameTypeDescriptionRestrictions
queryTextstringqueryText to be parsed, if present and valid.

Example

{
  "queryText": "string"
}

RefreshBatchDto

Properties

NameTypeDescriptionRestrictions
batchRefreshIdstringThe unique ID of the batchread-only
childRefreshes[ConnectionRunDto]The list of jobs initiated by the batchread-only
createdstring(date-time)When the batch was created, as a datetimeread-only
createdBystringThe ID of the user that created the batchread-only
destinationStatusstringThe run status of the destinationread-only
errorstringAny error encountered while initiating the batchread-only
sourceStatusstringThe run status of the sourceread-only
updatedstring(date-time)When the batch was updated, as a datetimeread-only

Enumerated Values

PropertyValue
destinationStatusnot_started
destinationStatusrunning
destinationStatuscomplete
destinationStatuserror
destinationStatuscancelled
sourceStatusnot_started
sourceStatusrunning
sourceStatuscomplete
sourceStatuserror
sourceStatuscancelled

Example

{
  "batchRefreshId": "string",
  "childRefreshes": [
    {
      "connectionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "destinationParameters": {},
      "destinationStatus": "not_started",
      "destinationWorkspaceId": "string",
      "error": "string",
      "jobId": "string",
      "sourceParameters": {},
      "sourceStatus": "not_started",
      "sourceWorkspaceId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "workspaceId": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "destinationStatus": "not_started",
  "error": "string",
  "sourceStatus": "not_started",
  "updated": "2019-08-24T14:15:22Z"
}

RefreshConnectionDto

Properties

NameTypeDescriptionRestrictions
connectionIdstringThe unique ID of the connection
destinationParametersobjectParameters to send to the destination, on refresh
sourceParametersobjectParameters to send to the source, on refresh
usePreviousDestinationParametersbooleanUse the destination parameters from the previous run. This overrides any specified destination parameters. Ignored by "Refresh batch of connections" endpoint
usePreviousSourceParametersbooleanUse the source parameters from the previous run. This overrides any specified source parameters. Ignored by "Refresh batch of connections" endpoint
workspaceIdstringThe workspace ID of the connection

Example

{
  "connectionId": "string",
  "destinationParameters": {},
  "sourceParameters": {},
  "usePreviousDestinationParameters": false,
  "usePreviousSourceParameters": false,
  "workspaceId": "string"
}

SelectListDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
descriptionstringDescription of this select list. Max length: 1024
idstringThe entity's unique identifierread-only
namestringName of this select list. Max length: 100
typestringThis is currently not used and its value will always be 'static'. In the future, more types will be added.read-only
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
valueTypestringDefines the type of the items in the list.
values[object]List of possible values for the list. These values will be validated against the valueType provided.
versioninteger(int64)The version of the current representation of the entityread-only

Enumerated Values

PropertyValue
typestatic
valueTypestring
valueTypebytes
valueTypeinteger
valueTypefloat
valueTypeboolean
valueTypetimestamp
valueTypedate
valueTypetime
valueTypedatetime
valueTypeglobal_parameter
valueTypenested_query_parameter

Example

{
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "type": "static",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "valueType": "string",
  "values": [
    {}
  ],
  "version": 0
}

SharedTableDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
destinationWorkspaceIdstringThe id of the workspace being shared to.
idstringThe entity's unique identifierread-only
parentIdstringIf non-null, indicates the parent of this entity. Must be modified through the folder api.read-only
sourceTableIdstringThe id of the table being shared.
tableTableDto
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "destinationWorkspaceId": "string",
  "id": "string",
  "parentId": "string",
  "sourceTableId": "string",
  "table": {
    "created": "2019-08-24T14:15:22Z",
    "databaseId": "string",
    "datasetUpdated": "2019-08-24T14:15:22Z",
    "deleted": false,
    "description": "string",
    "id": "string",
    "isShared": false,
    "lastUploaded": "2019-08-24T14:15:22Z",
    "name": "string",
    "parentId": "string",
    "readOnly": false,
    "tableSchema": {
      "columns": [
        {
          "alias": "string",
          "description": "string",
          "metadata": {
            "property1": {},
            "property2": {}
          },
          "mode": "nullable",
          "name": "string",
          "type": "string"
        }
      ]
    },
    "type": "data",
    "uniqueTableConstraints": [
      {
        "description": "string",
        "id": "string",
        "name": "key_columns",
        "tableId": "string",
        "values": [
          "string"
        ]
      }
    ],
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

SingleError

Properties

NameTypeDescriptionRestrictions
bodystring
codeinteger(int32)

Example

{
  "body": "string",
  "code": 0
}

SpreadsheetInfoDto

Properties

NameTypeDescriptionRestrictions
sheetIdstringThe unique identifier of the sheet
workbookIdstringThe unique identifier of the workbook

Example

{
  "sheetId": "string",
  "workbookId": "string"
}

StartValidateFilesDto

Properties

NameTypeDescriptionRestrictions
tableIdstringThe unique identifier for the table.

Example

{
  "tableId": "string"
}

TableDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
databaseIdstringThe unique identifier of the database where the table resides.read-only
datasetUpdatedstring(date-time)The last time that the data set for this table was modified.
deletedbooleanThis is for backwards compatibility only and will always return false.read-only
descriptionstringMay be at most 255 characters in length
idstringThe entity's unique identifierread-only
isSharedbooleanA property indicating if this table is shared to any destination.
lastUploadedstring(date-time)Contains the date and time of the last file that was imported into the table. Valuable for determining if the data is stale.read-only
namestringMay be at most 150 characters in length
parentIdstringIf non-null, indicates the parent of this entity. Must be modified through the folder api.read-only
readOnlybooleanIndicates if this table is readonly in the account receiving this table. If so, any attempt to edit the table will fail.read-only
tableSchemaTableSchema
typestringThe type of table
uniqueTableConstraints[UniqueConstraintDto]A property indicating the unique constraints on the table.
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Enumerated Values

PropertyValue
typedata
typelookup

Example

{
  "created": "2019-08-24T14:15:22Z",
  "databaseId": "string",
  "datasetUpdated": "2019-08-24T14:15:22Z",
  "deleted": false,
  "description": "string",
  "id": "string",
  "isShared": false,
  "lastUploaded": "2019-08-24T14:15:22Z",
  "name": "string",
  "parentId": "string",
  "readOnly": false,
  "tableSchema": {
    "columns": [
      {
        "alias": "string",
        "description": "string",
        "metadata": {
          "property1": {},
          "property2": {}
        },
        "mode": "nullable",
        "name": "string",
        "type": "string"
      }
    ]
  },
  "type": "data",
  "uniqueTableConstraints": [
    {
      "description": "string",
      "id": "string",
      "name": "key_columns",
      "tableId": "string",
      "values": [
        "string"
      ]
    }
  ],
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

TableSchema

Properties

NameTypeDescriptionRestrictions
columns[ColumnDto]list of columns in the table, must at least one in size

Example

{
  "columns": [
    {
      "alias": "string",
      "description": "string",
      "metadata": {
        "property1": {},
        "property2": {}
      },
      "mode": "nullable",
      "name": "string",
      "type": "string"
    }
  ]
}

TagDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
idstringThe entity's unique identifierread-only
keystringValue for the key, maximum 100 characters in length
updatedstring(date-time)When the entity was last updatedread-only
userIdstringThe owner of the entityread-only
values[string]Set of values for the tag
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "id": "string",
  "key": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "values": [
    "string"
  ],
  "version": 0
}

TokenDto

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)When the entity was createdread-only
idstringThe entity's unique identifierread-only
objectIdstringThe object's unique identifier
updatedstring(date-time)When the entity was last updatedread-only
useFlatKeybooleanCreate token using flat query results key; Ignored unless true.
userIdstringThe owner of the entityread-only
versioninteger(int64)The version of the current representation of the entityread-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "id": "string",
  "objectId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "useFlatKey": false,
  "userId": "string",
  "version": 0
}

UniqueConstraintDto

Properties

NameTypeDescriptionRestrictions
descriptionstringDescription of this unique constraint. Max length: 1024
idstringId of the unique constraint
namestringName of this unique constraint. Max length: 100
tableIdstringId of the table this unique constraint is associated with
values[string]List of values in the unique constraint

Enumerated Values

PropertyValue
namekey_columns

Example

{
  "description": "string",
  "id": "string",
  "name": "key_columns",
  "tableId": "string",
  "values": [
    "string"
  ]
}

ValidateFilesDto

Properties

NameTypeDescriptionRestrictions
deletedFiles[FileMetaDto]A list of files that were deleted during the validation because not enough information was available to repair them. These files will no longer be available via the endpoint and will not be included in queries.
repairedFiles[FileMetaDto]A list of files that were modified during the validation and will continue to be visible and to be usable in the account.

Example

{
  "deletedFiles": [
    {
      "columnMappings": {
        "property1": "string",
        "property2": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "delimiter": "string",
      "id": "string",
      "key": "string",
      "metadata": {
        "property1": {
          "property1": {},
          "property2": {}
        },
        "property2": {
          "property1": {},
          "property2": {}
        }
      },
      "name": "string",
      "numErrors": 0,
      "numRecords": 0,
      "originalFileSize": 0,
      "source": "string",
      "status": "STAGING",
      "tableId": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "repairedFiles": [
    {
      "columnMappings": {
        "property1": "string",
        "property2": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "delimiter": "string",
      "id": "string",
      "key": "string",
      "metadata": {
        "property1": {
          "property1": {},
          "property2": {}
        },
        "property2": {
          "property1": {},
          "property2": {}
        }
      },
      "name": "string",
      "numErrors": 0,
      "numRecords": 0,
      "originalFileSize": 0,
      "source": "string",
      "status": "STAGING",
      "tableId": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ]
}

ValidateTablesDto

Properties

NameTypeDescriptionRestrictions
deletedTables[TableDto]A list of tables that were deleted during the validation because not enough information was available to repair them. These tables will no longer be available via the endpoint and queries using these tables will cease to function properly.
repairedTables[TableDto]A list of tables that were modified during the validation and will continue to be visible and to be usable in the account.

Example

{
  "deletedTables": [
    {
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "datasetUpdated": "2019-08-24T14:15:22Z",
      "deleted": false,
      "description": "string",
      "id": "string",
      "isShared": false,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": false,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": {},
              "property2": {}
            },
            "mode": "nullable",
            "name": "string",
            "type": "string"
          }
        ]
      },
      "type": "data",
      "uniqueTableConstraints": [
        {
          "description": "string",
          "id": "string",
          "name": "key_columns",
          "tableId": "string",
          "values": [
            "string"
          ]
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "repairedTables": [
    {
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "datasetUpdated": "2019-08-24T14:15:22Z",
      "deleted": false,
      "description": "string",
      "id": "string",
      "isShared": false,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": false,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": {},
              "property2": {}
            },
            "mode": "nullable",
            "name": "string",
            "type": "string"
          }
        ]
      },
      "type": "data",
      "uniqueTableConstraints": [
        {
          "description": "string",
          "id": "string",
          "name": "key_columns",
          "tableId": "string",
          "values": [
            "string"
          ]
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ]
}