Additional Objects

BaseErrorResponseDetail

Properties

Name	Type	Description	Restrictions
code	string	Error code of specific error	required
message	string	Message of specific error	required
target	string	Target of specific error

Example

{
  "code": "string",
  "message": "string",
  "target": "string"
}

BaseResponseCollectionFolderableDto

Properties

Name	Type	Description	Restrictions
body	[FolderableDto]
code	integer(int32)

Example

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

BaseResponseConnectionDto

Properties

Name	Type	Description	Restrictions
body	ConnectionDto
code	integer(int32)

Example

{
  "body": {
    "connectionId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "destinationId": "string",
    "destinationType": "spreadsheet",
    "destinationWorkspaceId": "string",
    "lastRun": {
      "connectionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "destinationMetadata": {
        "property1": null,
        "property2": null
      },
      "destinationParameters": {
        "property1": null,
        "property2": null
      },
      "destinationStatus": "not_started",
      "destinationWorkspaceId": "string",
      "error": "string",
      "jobId": "string",
      "sourceMetadata": {
        "property1": null,
        "property2": null
      },
      "sourceParameters": {
        "property1": null,
        "property2": null
      },
      "sourceStatus": "not_started",
      "sourceWorkspaceId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "workspaceId": "string"
    },
    "lastRunBy": "string",
    "lastRunDate": "2019-08-24T14:15:22Z",
    "lastRunDestinationParameters": {
      "property1": null,
      "property2": null
    },
    "lastRunJobId": "string",
    "lastRunSourceParameters": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "name": "string",
    "sourceId": "string",
    "sourceType": "spreadsheet",
    "sourceWorkspaceId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "workspaceId": "string"
  },
  "code": 0
}

BaseResponseConnectionRunDto

Properties

Name	Type	Description	Restrictions
body	ConnectionRunDto
code	integer(int32)

Example

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

BaseResponseDescribeQueryResponseDto

Properties

Name	Type	Description	Restrictions
body	DescribeQueryResponseDto
code	integer(int32)

Example

{
  "body": {
    "columns": [
      {
        "catalog": "string",
        "catalogColumnName": "string",
        "name": "string",
        "schema": "string",
        "table": "string",
        "type": "string"
      }
    ]
  },
  "code": 0
}

BaseResponseFileMetaDto

Properties

Name	Type	Description	Restrictions
body	FileMetaDto
code	integer(int32)

Example

{
  "body": {
    "columnMappings": {
      "property1": "string",
      "property2": "string"
    },
    "created": "2019-08-24T14:15:22Z",
    "delimiter": "string",
    "id": "string",
    "key": "string",
    "metadata": {
      "property1": {
        "property1": null,
        "property2": null
      },
      "property2": {
        "property1": null,
        "property2": null
      }
    },
    "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
}

BaseResponseFolderDto

Properties

Name	Type	Description	Restrictions
body	FolderDto
code	integer(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
}

BaseResponseGlobalParameterDto

Properties

Name	Type	Description	Restrictions
body	GlobalParameterDto
code	integer(int32)

Example

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

BaseResponseImportInfoDto

Properties

Name	Type	Description	Restrictions
body	ImportInfoDto
code	integer(int32)

Example

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

BaseResponseLong

Properties

Name	Type	Description	Restrictions
body	integer(int64)
code	integer(int32)

Example

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

BaseResponseMapStringString

Properties

Name	Type	Description	Restrictions
body	object
body.additionalProperties	string
code	integer(int32)

Example

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

BaseResponsePivotViewDto

Properties

Name	Type	Description	Restrictions
body	PivotViewDto
code	integer(int32)

Example

{
  "body": {
    "additionalMeta": {
      "property1": null,
      "property2": null
    },
    "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
}

BaseResponseQueryColumnDataDto

Properties

Name	Type	Description	Restrictions
body	QueryColumnDataDto
code	integer(int32)

Example

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

BaseResponseQueryDto

Properties

Name	Type	Description	Restrictions
body	QueryDto
code	integer(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "definition": {
      "columns": [
        {
          "columnType": "integer",
          "name": "string"
        }
      ],
      "decimalPlaces": 16,
      "filters": [
        {
          "betweenValue": "string",
          "columnType": "integer",
          "exclude": true,
          "filter": "EQUAL",
          "filterValues": [
            "string"
          ],
          "name": "string",
          "value": "string"
        }
      ],
      "grandTotalEnabled": "ENABLED",
      "id": "string",
      "multipleHeaders": true,
      "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",
    "isShared": true,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunBy": "string",
    "name": "string",
    "parameters": [
      {
        "alias": "string",
        "choices": [
          null
        ],
        "id": "string",
        "label": "string",
        "listType": "string",
        "mode": "scalar",
        "name": "string",
        "overridable": true,
        "reference": null,
        "selectListId": "string",
        "type": "string",
        "value": null
      }
    ],
    "parentId": "string",
    "primaryQueryResultId": "string",
    "queryText": "string",
    "temporary": true,
    "type": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseQueryResultDto

Properties

Name	Type	Description	Restrictions
body	QueryResultDto
code	integer(int32)

Example

{
  "body": {
    "bytesScanned": 0,
    "columns": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "duration": 0,
    "error": "string",
    "id": "string",
    "isExplain": true,
    "parameters": {
      "property1": null,
      "property2": null
    },
    "pivotStatus": "NOT_STARTED",
    "queryDto": {
      "created": "2019-08-24T14:15:22Z",
      "definition": {
        "columns": [
          {
            "columnType": "integer",
            "name": "string"
          }
        ],
        "decimalPlaces": 16,
        "filters": [
          {
            "betweenValue": "string",
            "columnType": "integer",
            "exclude": true,
            "filter": "EQUAL",
            "filterValues": [
              "string"
            ],
            "name": "string",
            "value": "string"
          }
        ],
        "grandTotalEnabled": "ENABLED",
        "id": "string",
        "multipleHeaders": true,
        "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",
      "isShared": true,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunBy": "string",
      "name": "string",
      "parameters": [
        {
          "alias": "string",
          "choices": [
            null
          ],
          "id": "string",
          "label": "string",
          "listType": "string",
          "mode": "scalar",
          "name": "string",
          "overridable": true,
          "reference": null,
          "selectListId": "string",
          "type": "string",
          "value": null
        }
      ],
      "parentId": "string",
      "primaryQueryResultId": "string",
      "queryText": "string",
      "temporary": true,
      "type": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    },
    "queryId": "string",
    "queryParameters": [
      {
        "alias": "string",
        "choices": [
          null
        ],
        "id": "string",
        "label": "string",
        "listType": "string",
        "mode": "scalar",
        "name": "string",
        "overridable": true,
        "reference": null,
        "selectListId": "string",
        "type": "string",
        "value": null
      }
    ],
    "queryText": "string",
    "rowsReturned": 0,
    "size": 0,
    "status": "NOT_STARTED",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "code": 0
}

BaseResponseRefreshBatchDto

Properties

Name	Type	Description	Restrictions
body	RefreshBatchDto
code	integer(int32)

Example

{
  "body": {
    "batchRefreshId": "string",
    "childRefreshes": [
      {
        "connectionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "destinationMetadata": {
          "property1": null,
          "property2": null
        },
        "destinationParameters": {
          "property1": null,
          "property2": null
        },
        "destinationStatus": "not_started",
        "destinationWorkspaceId": "string",
        "error": "string",
        "jobId": "string",
        "sourceMetadata": {
          "property1": null,
          "property2": null
        },
        "sourceParameters": {
          "property1": null,
          "property2": null
        },
        "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
}

BaseResponseSelectListDto

Properties

Name	Type	Description	Restrictions
body	SelectListDto
code	integer(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": [
      null
    ],
    "version": 0
  },
  "code": 0
}

BaseResponseSharedTableDto

Properties

Name	Type	Description	Restrictions
body	SharedTableDto
code	integer(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": true,
      "description": "string",
      "hierarchyMetadata": {
        "childColumnId": "string",
        "parentColumnId": "string"
      },
      "id": "string",
      "isShared": true,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": true,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": null,
              "property2": null
            },
            "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
}

BaseResponseSpreadsheetInfoDto

Properties

Name	Type	Description	Restrictions
body	SpreadsheetInfoDto
code	integer(int32)

Example

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

BaseResponseString

Properties

Name	Type	Description	Restrictions
body	string
code	integer(int32)

Example

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

BaseResponseTableDto

Properties

Name	Type	Description	Restrictions
body	TableDto
code	integer(int32)

Example

{
  "body": {
    "created": "2019-08-24T14:15:22Z",
    "databaseId": "string",
    "datasetUpdated": "2019-08-24T14:15:22Z",
    "deleted": true,
    "description": "string",
    "hierarchyMetadata": {
      "childColumnId": "string",
      "parentColumnId": "string"
    },
    "id": "string",
    "isShared": true,
    "lastUploaded": "2019-08-24T14:15:22Z",
    "name": "string",
    "parentId": "string",
    "readOnly": true,
    "tableSchema": {
      "columns": [
        {
          "alias": "string",
          "description": "string",
          "metadata": {
            "property1": null,
            "property2": null
          },
          "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
}

BaseResponseTagDto

Properties

Name	Type	Description	Restrictions
body	TagDto
code	integer(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
}

BaseResponseTokenDto

Properties

Name	Type	Description	Restrictions
body	TokenDto
code	integer(int32)

Example

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

BaseResponseValidateFilesDto

Properties

Name	Type	Description	Restrictions
body	ValidateFilesDto
code	integer(int32)

Example

{
  "body": {
    "deletedFiles": [
      {
        "columnMappings": {
          "property1": "string",
          "property2": "string"
        },
        "created": "2019-08-24T14:15:22Z",
        "delimiter": "string",
        "id": "string",
        "key": "string",
        "metadata": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "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": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "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
}

BaseResponseValidateTablesDto

Properties

Name	Type	Description	Restrictions
body	ValidateTablesDto
code	integer(int32)

Example

{
  "body": {
    "deletedTables": [
      {
        "created": "2019-08-24T14:15:22Z",
        "databaseId": "string",
        "datasetUpdated": "2019-08-24T14:15:22Z",
        "deleted": true,
        "description": "string",
        "hierarchyMetadata": {
          "childColumnId": "string",
          "parentColumnId": "string"
        },
        "id": "string",
        "isShared": true,
        "lastUploaded": "2019-08-24T14:15:22Z",
        "name": "string",
        "parentId": "string",
        "readOnly": true,
        "tableSchema": {
          "columns": [
            {
              "alias": "string",
              "description": "string",
              "metadata": {
                "property1": null,
                "property2": null
              },
              "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": true,
        "description": "string",
        "hierarchyMetadata": {
          "childColumnId": "string",
          "parentColumnId": "string"
        },
        "id": "string",
        "isShared": true,
        "lastUploaded": "2019-08-24T14:15:22Z",
        "name": "string",
        "parentId": "string",
        "readOnly": true,
        "tableSchema": {
          "columns": [
            {
              "alias": "string",
              "description": "string",
              "metadata": {
                "property1": null,
                "property2": null
              },
              "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
}

Column

Properties

Name	Type	Description	Restrictions
alias	string
description	string
metadata	object
metadata.additionalProperties	any
mode	string
name	string
type	string

Enumerated Values

Property	Value
mode	nullable
mode	required
mode	repeated
type	string
type	bytes
type	integer
type	float
type	boolean
type	timestamp
type	date
type	time
type	datetime
type	global_parameter
type	nested_query_parameter

Example

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

ColumnDto

Properties

Name	Type	Description	Restrictions
alias	string	Optional alias, may be at most 255 characters in length	Maximum length: 255, Minimum length: 0
description	string	May be at most 255 characters in length	Maximum length: 255, Minimum length: 0
metadata	object	Optional 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.additionalProperties	any
mode	string	This property is for future use, currently always set to nullable
name	string	May be at most 100 characters in length	required, Maximum length: 100, Minimum length: 0
type	string	The type of column	required

Enumerated Values

Property	Value
mode	nullable
mode	required
mode	repeated
type	string
type	bytes
type	integer
type	float
type	boolean
type	timestamp
type	date
type	time
type	datetime
type	global_parameter
type	nested_query_parameter

Example

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

ColumnInfoDto

Contains column name and derived type from the associated query.

Properties

Name	Type	Description	Restrictions
name	string	The name of the column	read-only
type	string	The column’s type	read-only

Enumerated Values

Property	Value
type	string
type	bytes
type	integer
type	float
type	boolean
type	timestamp
type	date
type	time
type	datetime
type	global_parameter
type	nested_query_parameter

Example

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

ConnectionDto

Properties

Name	Type	Description	Restrictions
connectionId	string	The unique ID of the connection	read-only
created	string(date-time)	When the connection was created, as a datetime	read-only
createdBy	string	The ID of the user that created the connection	read-only
description	string	The description of the connection, if specified	read-only
destinationId	string	The ID of the file or item the connection sends data to	read-only
destinationType	string	The type of file or item the connection sends data to	read-only
destinationWorkspaceId	string	The workspace of the file or item the connection sends data to	read-only
lastRun	ConnectionRunDto	The last run of this connection
lastRunBy	string	The ID of the user that last ran the connection	read-only
lastRunDate	string(date-time)	When the connection last ran, as a datetime	read-only
lastRunDestinationParameters	object	A map of the parameters used with the destination when the connection last ran	read-only
lastRunDestinationParameters.additionalProperties	any
lastRunJobId	string	The ID of the connection’s last run	read-only
lastRunSourceParameters	object	A map of the parameters used with the source when the connection last ran	read-only
lastRunSourceParameters.additionalProperties	any
metadata	object	Any additional information about the connection	read-only
metadata.additionalProperties	any
name	string	The name of the connection, if specified	read-only
sourceId	string	The ID of the file or item the connection pulls data from	read-only
sourceType	string	The type of file or item the connection pulls data from	read-only
sourceWorkspaceId	string	The workspace of the file or item the connection pulls data from	read-only
updated	string(date-time)	When the connection was updated, as a datetime.	read-only
workspaceId	string	The workspace the connection belongs to	read-only

Enumerated Values

Property	Value
destinationType	spreadsheet
destinationType	spreadsheet_section
destinationType	presentation
destinationType	presentation_chart
destinationType	presentation_embedded_table
destinationType	document
destinationType	document_chart
destinationType	document_embedded_table
destinationType	wdata_query
destinationType	wdata_shared_query
destinationType	wdata_table
destinationType	wdata_table_dataset
destinationType	report
destinationType	esg_program
destinationType	chart_visual
destinationType	unknown_record_type
sourceType	spreadsheet
sourceType	spreadsheet_section
sourceType	presentation
sourceType	presentation_chart
sourceType	presentation_embedded_table
sourceType	document
sourceType	document_chart
sourceType	document_embedded_table
sourceType	wdata_query
sourceType	wdata_shared_query
sourceType	wdata_table
sourceType	wdata_table_dataset
sourceType	report
sourceType	esg_program
sourceType	chart_visual
sourceType	unknown_record_type

Example

{
  "connectionId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "destinationId": "string",
  "destinationType": "spreadsheet",
  "destinationWorkspaceId": "string",
  "lastRun": {
    "connectionId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "destinationMetadata": {
      "property1": null,
      "property2": null
    },
    "destinationParameters": {
      "property1": null,
      "property2": null
    },
    "destinationStatus": "not_started",
    "destinationWorkspaceId": "string",
    "error": "string",
    "jobId": "string",
    "sourceMetadata": {
      "property1": null,
      "property2": null
    },
    "sourceParameters": {
      "property1": null,
      "property2": null
    },
    "sourceStatus": "not_started",
    "sourceWorkspaceId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "workspaceId": "string"
  },
  "lastRunBy": "string",
  "lastRunDate": "2019-08-24T14:15:22Z",
  "lastRunDestinationParameters": {
    "property1": null,
    "property2": null
  },
  "lastRunJobId": "string",
  "lastRunSourceParameters": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "name": "string",
  "sourceId": "string",
  "sourceType": "spreadsheet",
  "sourceWorkspaceId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "workspaceId": "string"
}

ConnectionRunDto

Properties

Name	Type	Description	Restrictions
connectionId	string	The unique ID of the connection	read-only
created	string(date-time)	When the connection was created, as a datetime	read-only
createdBy	string	The ID of the user that created the connection	read-only
destinationMetadata	object	Any Metadata provided to the destination	read-only
destinationMetadata.additionalProperties	any
destinationParameters	object	Any parameters provided to the destination	read-only
destinationParameters.additionalProperties	any
destinationStatus	string	The run status of the destination	read-only
destinationWorkspaceId	string	The workspace of the the run destination	read-only
error	string	An error, if encountered, while initiating the job	read-only
jobId	string	The unique ID of the job	read-only
sourceMetadata	object	Any Metadata provided to the source	read-only
sourceMetadata.additionalProperties	any
sourceParameters	object	Any parameters provided to the source	read-only
sourceParameters.additionalProperties	any
sourceStatus	string	The run status of the source	read-only
sourceWorkspaceId	string	The workspace of the run source	read-only
updated	string(date-time)	When the connection was updated, as a datetime	read-only
workspaceId	string	The workspace id for this connection	read-only

Enumerated Values

Property	Value
destinationStatus	not_started
destinationStatus	running
destinationStatus	complete
destinationStatus	error
destinationStatus	cancelled
sourceStatus	not_started
sourceStatus	running
sourceStatus	complete
sourceStatus	error
sourceStatus	cancelled

Example

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

DatetimeDto

Properties

Name	Type	Description	Restrictions
candidate	string	Candidate to parse with the provided dateformat.	required, Maximum length: 200, Minimum length: 0
dateFormat	string	The dateformat of the candidate to test.	required, Maximum length: 200, Minimum length: 0

Example

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

DescribeQueryColumnDto

Properties

Name	Type	Description	Restrictions
catalog	string	The source of the column	read-only
catalogColumnName	string	The name of the original column, if available	read-only
name	string	The name of the column	read-only
schema	string	The source’s schema for this column	read-only
table	string	The schema’s table for this column	read-only
type	string	The column’s type	read-only

Enumerated Values

Property	Value
type	string
type	bytes
type	integer
type	float
type	boolean
type	timestamp
type	date
type	time
type	datetime
type	global_parameter
type	nested_query_parameter

Example

{
  "catalog": "string",
  "catalogColumnName": "string",
  "name": "string",
  "schema": "string",
  "table": "string",
  "type": "string"
}

DescribeQueryResponseDto

Properties

Name	Type	Description	Restrictions
columns	[DescribeQueryColumnDto]	A list of the output columns, including the name, type, and source information that would be returned in the result of a successful query run.	read-only, required

Example

{
  "columns": [
    {
      "catalog": "string",
      "catalogColumnName": "string",
      "name": "string",
      "schema": "string",
      "table": "string",
      "type": "string"
    }
  ]
}

ExportFileDto

Properties

Name	Type	Description	Restrictions
url	string	URL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.	Maximum length: 500, Minimum length: 0

Example

{
  "url": "string"
}

ExportQueryResultDto

Properties

Name	Type	Description	Restrictions
exportAsDataset	boolean	If set to true, the data will be exported as a connected dataset to spreadsheets.
url	string	URL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.	Maximum length: 500, Minimum length: 0
useFlatKey	boolean	Export flat query results in the context of crosstab queries; Ignored unless true.

Example

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

FileMetaDto

Properties

Name	Type	Description	Restrictions
columnMappings	object	Maps 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.additionalProperties	string
created	string(date-time)	When the entity was created	read-only
delimiter	string	The character to use as a delimiter within the file to separate one field from another. The default is comma	read-only
id	string	The entity’s unique identifier	read-only
key	string	The key is here for backwards compatibility only and will always be an empty string.	read-only
metadata	object	The file’s meta data	read-only
metadata.additionalProperties	object
metadata.additionalProperties.additionalProperties	any
name	string	The name of the file	read-only
numErrors	integer(int64)	Number of errors found in the file	read-only
numRecords	integer(int64)	Number of records imported from this file. This will only be non-zero if the file is in the IMPORTED status.	read-only
originalFileSize	integer(int64)	Size of the original file that was uploaded.	read-only
source	string	URI 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
status	string	The files’s current status	read-only
tableId	string	The unique identifier for the table	read-only
tags	object	The tags associated with the file	read-only
tags.additionalProperties	string
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-only

Enumerated Values

Property	Value
status	STAGING
status	STAGED
status	IMPORTING
status	IMPORTED
status	ERROR

Example

{
  "columnMappings": {
    "property1": "string",
    "property2": "string"
  },
  "created": "2019-08-24T14:15:22Z",
  "delimiter": "string",
  "id": "string",
  "key": "string",
  "metadata": {
    "property1": {
      "property1": null,
      "property2": null
    },
    "property2": {
      "property1": null,
      "property2": null
    }
  },
  "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

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
description	string	A description of the folder	Maximum length: 1024, Minimum length: 0
id	string	The entity’s unique identifier	read-only
name	string	The name of the folder	required, Maximum length: 255, Minimum length: 0
parentId	string	The ID of the folder to which this folder belongs. This can be null if the folder is not in another folder.	read-only
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-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

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
description	string	A description of the folderable entity	read-only
id	string	The UUID unique identifier for the entity.	required
metadata	object	Contains additional metadata about the entity returned. For example, a table entity might have a type attribute.	read-only
metadata.additionalProperties	any
modified	string(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
modifiedBy	string	The identifier of the user who last modified the entity	read-only
name	string	The name of the folderable entity	read-only
parentId	string	The ID of the folder to which this entity belongs. This can be null if the entity is not in a folder.	read-only
type	integer(int32)	The numerical identifier for the entity’s type: Query=100, Table=200, Pivot View=500, Folder=600, Shared Table=700	required
updated	string(date-time)	When the data object was last updated	read-only
updatedBy	string	The identifier of the user who last updated the entity	read-only

Example

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

GlobalParameterDto

Properties

Name	Type	Description	Restrictions
choices	[any]	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
created	string(date-time)	When the entity was created	read-only
databaseId	string	The unique identifier of the database where this parameter can be used to filter query results	read-only
description	string	The description of the parameter	Maximum length: 10000, Minimum length: 0
id	string	The entity’s unique identifier	read-only
label	string	The label for the query parameter	Maximum length: 255, Minimum length: 0
listType	string	For single and multi-select parameters, this represents the type of select list. Supported types are ‘static’ and ‘external_legal_entity’. This field is only required when creating a SYSTEM-scoped parameter, in which case it specifies a valid select list type to auto-create. For GLOBAL and LOCAL scoped parameters, this field is read-only and populated based on the referenced select list.
mode	string	The mode of the parameter	required
name	string	The name of the parameter	required, Maximum length: 255, Minimum length: 0
overridable	boolean	Denotes 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.
scope	string	The scope of the parameter (global, local, or system)
selectListId	string	If mode is select, this must be populated and is a reference to a select list from which choices will be derived. For SYSTEM-scoped parameters, this field is optional and will be resolved from the listType if not provided.
type	string	The type of the parameter	required
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
value	any	The default value of the parameter
version	integer(int64)	The version of the current representation of the entity	read-only

Enumerated Values

Property	Value
mode	scalar
mode	singleSelect
mode	multiSelect
scope	global
scope	local
scope	system
type	string
type	bytes
type	integer
type	float
type	boolean
type	timestamp
type	date
type	time
type	datetime
type	global_parameter
type	nested_query_parameter

Example

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

HierarchyMetadata

Properties

Name	Type	Description	Restrictions
childColumnId	string	The name of a column in the table that represents a unique identifier in the column. Every value in this column in the table should be unique and the value must not be empty. This identifier needs to match a column name defined in the table and the type of the column must be a string.	required, Maximum length: 100, Minimum length: 0
parentColumnId	string	The name of a column in the table that represents the parent identifier of any given row. The column referenced in this identifier should contain a value that references a value found in the child id column. Because a parent can have multiple children, the values in this column do not need to be unique. This column can contain a null which simply indicates the row is a root node.	required, Maximum length: 100, Minimum length: 0

Example

{
  "childColumnId": "string",
  "parentColumnId": "string"
}

ImportDto

Properties

Name	Type	Description	Restrictions
columnMappings	object	a map of import column names to table column ids
columnMappings.additionalProperties	string
delimiter	string	For 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.
fileId	string	id of the file to import to the table	required, Maximum length: 32, Minimum length: 0
metadata	object	For overriding column metadata specifically for this import. The keys in this object are column identifiers with the values being metadata objects.
metadata.additionalProperties	object
metadata.additionalProperties.additionalProperties	any
tags	object	an object containing keys and values, which becomes the tag map
tags.additionalProperties	string

Example

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

ImportErrorDto

Properties

Name	Type	Description	Restrictions
code	integer(int64)	The error code	read-only
created	string(date-time)	When the entity was created	read-only
id	string	The entity’s unique identifier	read-only
lineNumber	integer(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
message	string	The error message	read-only
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-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

Name	Type	Description	Restrictions
fileId	string
name	string		required, Maximum length: 100, Minimum length: 0
tags	object
tags.additionalProperties	string
url	string		required

Example

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

ImportInfoDto

Properties

Name	Type	Description	Restrictions
numFiles	integer(int64)	The total number of individual files imported to the table.	read-only
numRecords	integer(int64)	The total number of records/rows of data imported to the table.	read-only
tableId	string	The id for the table that the import info applies to.	read-only

Example

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

MultiError

Properties

Name	Type	Description	Restrictions
body	[string]	A human-readable message describing the error	required
code	integer(int32)	A server-defined error code	required
details	[BaseErrorResponseDetail]	Additional details of the error

Example

{
  "body": [
    "string"
  ],
  "code": 0,
  "details": [
    {
      "code": "string",
      "message": "string",
      "target": "string"
    }
  ]
}

PagedResponseConnectionDto

Properties

Name	Type	Description	Restrictions
body	[ConnectionDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "connectionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "destinationId": "string",
      "destinationType": "spreadsheet",
      "destinationWorkspaceId": "string",
      "lastRun": {
        "connectionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "destinationMetadata": {
          "property1": null,
          "property2": null
        },
        "destinationParameters": {
          "property1": null,
          "property2": null
        },
        "destinationStatus": "not_started",
        "destinationWorkspaceId": "string",
        "error": "string",
        "jobId": "string",
        "sourceMetadata": {
          "property1": null,
          "property2": null
        },
        "sourceParameters": {
          "property1": null,
          "property2": null
        },
        "sourceStatus": "not_started",
        "sourceWorkspaceId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "workspaceId": "string"
      },
      "lastRunBy": "string",
      "lastRunDate": "2019-08-24T14:15:22Z",
      "lastRunDestinationParameters": {
        "property1": null,
        "property2": null
      },
      "lastRunJobId": "string",
      "lastRunSourceParameters": {
        "property1": null,
        "property2": null
      },
      "metadata": {
        "property1": null,
        "property2": null
      },
      "name": "string",
      "sourceId": "string",
      "sourceType": "spreadsheet",
      "sourceWorkspaceId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "workspaceId": "string"
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseFileMetaDto

Properties

Name	Type	Description	Restrictions
body	[FileMetaDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "columnMappings": {
        "property1": "string",
        "property2": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "delimiter": "string",
      "id": "string",
      "key": "string",
      "metadata": {
        "property1": {
          "property1": null,
          "property2": null
        },
        "property2": {
          "property1": null,
          "property2": null
        }
      },
      "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"
}

PagedResponseFolderDto

Properties

Name	Type	Description	Restrictions
body	[FolderDto]
code	integer(int32)
cursor	string

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"
}

PagedResponseFolderableDto

Properties

Name	Type	Description	Restrictions
body	[FolderableDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "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"
}

PagedResponseGlobalParameterDto

Properties

Name	Type	Description	Restrictions
body	[GlobalParameterDto]
code	integer(int32)
cursor	string

Example

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

PagedResponseImportErrorDto

Properties

Name	Type	Description	Restrictions
body	[ImportErrorDto]
code	integer(int32)
cursor	string

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"
}

PagedResponsePivotViewDto

Properties

Name	Type	Description	Restrictions
body	[PivotViewDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "additionalMeta": {
        "property1": null,
        "property2": null
      },
      "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"
}

PagedResponseQueryDto

Properties

Name	Type	Description	Restrictions
body	[QueryDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "definition": {
        "columns": [
          {
            "columnType": "integer",
            "name": "string"
          }
        ],
        "decimalPlaces": 16,
        "filters": [
          {
            "betweenValue": "string",
            "columnType": "integer",
            "exclude": true,
            "filter": "EQUAL",
            "filterValues": [
              "string"
            ],
            "name": "string",
            "value": "string"
          }
        ],
        "grandTotalEnabled": "ENABLED",
        "id": "string",
        "multipleHeaders": true,
        "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",
      "isShared": true,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunBy": "string",
      "name": "string",
      "parameters": [
        {
          "alias": "string",
          "choices": [
            null
          ],
          "id": "string",
          "label": "string",
          "listType": "string",
          "mode": "scalar",
          "name": "string",
          "overridable": true,
          "reference": null,
          "selectListId": "string",
          "type": "string",
          "value": null
        }
      ],
      "parentId": "string",
      "primaryQueryResultId": "string",
      "queryText": "string",
      "temporary": true,
      "type": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseQueryResultDto

Properties

Name	Type	Description	Restrictions
body	[QueryResultDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "bytesScanned": 0,
      "columns": [
        {
          "name": "string",
          "type": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "duration": 0,
      "error": "string",
      "id": "string",
      "isExplain": true,
      "parameters": {
        "property1": null,
        "property2": null
      },
      "pivotStatus": "NOT_STARTED",
      "queryDto": {
        "created": "2019-08-24T14:15:22Z",
        "definition": {
          "columns": [
            {
              "columnType": "integer",
              "name": "string"
            }
          ],
          "decimalPlaces": 16,
          "filters": [
            {
              "betweenValue": "string",
              "columnType": "integer",
              "exclude": true,
              "filter": "EQUAL",
              "filterValues": [
                "string"
              ],
              "name": "string",
              "value": "string"
            }
          ],
          "grandTotalEnabled": "ENABLED",
          "id": "string",
          "multipleHeaders": true,
          "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",
        "isShared": true,
        "lastRun": "2019-08-24T14:15:22Z",
        "lastRunBy": "string",
        "name": "string",
        "parameters": [
          {
            "alias": "string",
            "choices": [
              null
            ],
            "id": "string",
            "label": "string",
            "listType": "string",
            "mode": "scalar",
            "name": "string",
            "overridable": true,
            "reference": null,
            "selectListId": "string",
            "type": "string",
            "value": null
          }
        ],
        "parentId": "string",
        "primaryQueryResultId": "string",
        "queryText": "string",
        "temporary": true,
        "type": "string",
        "updated": "2019-08-24T14:15:22Z",
        "userId": "string",
        "version": 0
      },
      "queryId": "string",
      "queryParameters": [
        {
          "alias": "string",
          "choices": [
            null
          ],
          "id": "string",
          "label": "string",
          "listType": "string",
          "mode": "scalar",
          "name": "string",
          "overridable": true,
          "reference": null,
          "selectListId": "string",
          "type": "string",
          "value": null
        }
      ],
      "queryText": "string",
      "rowsReturned": 0,
      "size": 0,
      "status": "NOT_STARTED",
      "updated": "2019-08-24T14:15:22Z",
      "userId": "string",
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseSelectListDto

Properties

Name	Type	Description	Restrictions
body	[SelectListDto]
code	integer(int32)
cursor	string

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": [
        null
      ],
      "version": 0
    }
  ],
  "code": 0,
  "cursor": "string"
}

PagedResponseSharedTableDto

Properties

Name	Type	Description	Restrictions
body	[SharedTableDto]
code	integer(int32)
cursor	string

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": true,
        "description": "string",
        "hierarchyMetadata": {
          "childColumnId": "string",
          "parentColumnId": "string"
        },
        "id": "string",
        "isShared": true,
        "lastUploaded": "2019-08-24T14:15:22Z",
        "name": "string",
        "parentId": "string",
        "readOnly": true,
        "tableSchema": {
          "columns": [
            {
              "alias": "string",
              "description": "string",
              "metadata": {
                "property1": null,
                "property2": null
              },
              "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"
}

PagedResponseTableDto

Properties

Name	Type	Description	Restrictions
body	[TableDto]
code	integer(int32)
cursor	string

Example

{
  "body": [
    {
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "datasetUpdated": "2019-08-24T14:15:22Z",
      "deleted": true,
      "description": "string",
      "hierarchyMetadata": {
        "childColumnId": "string",
        "parentColumnId": "string"
      },
      "id": "string",
      "isShared": true,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": true,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": null,
              "property2": null
            },
            "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"
}

PagedResponseTagDto

Properties

Name	Type	Description	Restrictions
body	[TagDto]
code	integer(int32)
cursor	string

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

Name	Type	Description	Restrictions
columns	[PivotViewDefinitionColumnDto]	The colmnnns associated with the pivot view	Minimum items: 0, Maximum items: 30
decimalPlaces	integer(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.	Maximum: 16, Minimum: 0
filters	[PivotViewDefinitionFilterDto]	The filters associated with the pivot view	Minimum items: 0, Maximum items: 30
grandTotalEnabled	string	The level to which Grand Totals are enabled. It is defaulted to DISABLED.
id	string	The pivot view’s definition’s id	read-only
multipleHeaders	boolean	Denotes whether a pivot is created in multi-line header mode. Default is false.
pivotViewType	string	The type of pivot view. Options are currently Classic and Compact.
rows	[PivotViewDefinitionRowDto]	The rows associated with the pivot view	Minimum items: 0, Maximum items: 30
sortColumns	[string]	Columns with which to sort the crosstab query	Minimum items: 0, Maximum items: 30
subtotalEnabled	string	The level to which Subtotals are enabled. It is defaulted to DISABLED.
values	[PivotViewDefinitionValueDto]	The values associated with the pivot view	Minimum items: 0, Maximum items: 30

Enumerated Values

Property	Value
grandTotalEnabled	ENABLED
grandTotalEnabled	ROW
grandTotalEnabled	COLUMN
grandTotalEnabled	DISABLED
pivotViewType	CLASSIC
pivotViewType	COMPACT
pivotViewType	FLAT
subtotalEnabled	ENABLED
subtotalEnabled	ROW
subtotalEnabled	COLUMN
subtotalEnabled	DISABLED

Example

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

PivotViewDefinitionColumnDto

Properties

Name	Type	Description	Restrictions
columnType	string	The column type.
name	string	Name of the pivot view column. The maximum size is 255 characters.	required, Maximum length: 255, Minimum length: 0

Enumerated Values

Property	Value
columnType	integer
columnType	number
columnType	boolean
columnType	timestamp
columnType	date
columnType	string
columnType	float

Example

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

PivotViewDefinitionFilterDto

Properties

Name	Type	Description	Restrictions
betweenValue	string	A second value for ‘between’ filters	Maximum length: 255, Minimum length: 0
columnType	string	The column type.	required
exclude	boolean	True if value list is exclude, false if value list is include. Defaults to true.	required
filter	string	The filter to perform.
filterValues	[string]	The values obtained after applying the filter	Minimum items: 0, Maximum items: 200
name	string	The column for the pivot view filter. The maximum size is 255 characters.	required, Maximum length: 255, Minimum length: 0
value	string	The value to filter on.	Maximum length: 255, Minimum length: 0

Enumerated Values

Property	Value
columnType	integer
columnType	number
columnType	boolean
columnType	timestamp
columnType	date
columnType	string
columnType	float
filter	EQUAL
filter	NOT_EQUAL
filter	GREATER
filter	GREATER_OR_EQUAL
filter	LESS
filter	LESS_OR_EQUAL
filter	BETWEEN
filter	NOT_BETWEEN

Example

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

PivotViewDefinitionRowDto

Properties

Name	Type	Description	Restrictions
name	string	Name of the pivot view row. The maximum size is 255 characters.	required, Maximum length: 255, Minimum length: 0
type	string	The column type.

Enumerated Values

Property	Value
type	integer
type	number
type	boolean
type	timestamp
type	date
type	string
type	float

Example

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

PivotViewDefinitionValueDto

Properties

Name	Type	Description	Restrictions
active	boolean		required
aggregation	string	The aggregation type to apply to the pivot view value	required
columnType	string	The column type.
name	string	Name of the pivot view value. The maximum size is 255 characters.	required, Maximum length: 255, Minimum length: 0

Enumerated Values

Property	Value
aggregation	sum
aggregation	count
aggregation	distinctcount
aggregation	average
aggregation	median
aggregation	product
aggregation	min
aggregation	max
aggregation	percent
aggregation	percentofcolumn
aggregation	percentofrow
aggregation	difference
aggregation	percentdifference
aggregation	runningtotals
aggregation	stdevp
aggregation	stdevs
columnType	integer
columnType	number
columnType	boolean
columnType	timestamp
columnType	date
columnType	string
columnType	float

Example

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

PivotViewDto

Properties

Name	Type	Description	Restrictions
additionalMeta	object	User-defined metadata to attach to the pivot view. This is any arbitrary JSON object and is not required.
additionalMeta.additionalProperties	any
created	string(date-time)	When the entity was created	read-only
description	string	The description of the pivot view
id	string	The entity’s unique identifier	read-only
name	string	Name of the pivot view. The maximum size is 255 characters.	required, Maximum length: 255, Minimum length: 0
parentId	string	If non-null, indicates the parent of this entity. Must be modified through the folder api.	read-only
queryId	string	The 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.	required
queryResultId	string	An 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.
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-only

Example

{
  "additionalMeta": {
    "property1": null,
    "property2": null
  },
  "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

Name	Type	Description	Restrictions
columns	[Column]

Example

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

QueryDependencyDto

The query text associated with any persisted query contains references to tables upon which that query relies. This model represents those dependencies. Every dependency contains a database and table identifier as in a traditional SQL database.

Properties

Name	Type	Description	Restrictions
databaseId	string	The database in which this dependency exists.	read-only, required
system	string	The name of the system holding this reference.	read-only, required
tableId	string	The id of the table this dependency represents.	read-only, required

Enumerated Values

Property	Value
system	prep
system	spreadsheets
system	queries
system	program
system	com
system	iam
system	graph
system	explorer
system	program_v2
system	explorer_v2
system	program_dimension_v1
system	program_tag_v1
system	pcaf

Example

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

QueryDto

Properties

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
definition	PivotDefinitionDto	The pivot view’s definition
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
description	string	The description of the query	Maximum length: 10000, Minimum length: 0
historyRevision	integer(int64)	Historical revision number of this entity
id	string	The entity’s unique identifier	read-only
isShared	boolean	Whether or not this query is being shared.
lastRun	string(date-time)	If non-null, indicates the last time this query was run.	read-only
lastRunBy	string	If non-null, indicates the last user that ran the query.	read-only
name	string	The name of the query	required, Maximum length: 100, Minimum length: 0
parameters	[QueryParameterDto]	The query parameters	Minimum items: 0, Maximum items: 30
parentId	string	If non-null, indicates the parent of this entity. Must be modified through the folder api.	read-only
primaryQueryResultId	string	The identifier of the primary query result	Maximum length: 32, Minimum length: 0
queryText	string	Max size is 30000 characters. Is required. Must be a valid DML statement.	required, Maximum length: 30000, Minimum length: 0
temporary	boolean	Denotes if this query is meant to be temporary. Default is false.
type	string	This field exists for backwards compatibility only and will always be an empty string.	read-only
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-only

Example

{
  "created": "2019-08-24T14:15:22Z",
  "definition": {
    "columns": [
      {
        "columnType": "integer",
        "name": "string"
      }
    ],
    "decimalPlaces": 16,
    "filters": [
      {
        "betweenValue": "string",
        "columnType": "integer",
        "exclude": true,
        "filter": "EQUAL",
        "filterValues": [
          "string"
        ],
        "name": "string",
        "value": "string"
      }
    ],
    "grandTotalEnabled": "ENABLED",
    "id": "string",
    "multipleHeaders": true,
    "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",
  "isShared": true,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunBy": "string",
  "name": "string",
  "parameters": [
    {
      "alias": "string",
      "choices": [
        null
      ],
      "id": "string",
      "label": "string",
      "listType": "string",
      "mode": "scalar",
      "name": "string",
      "overridable": true,
      "reference": null,
      "selectListId": "string",
      "type": "string",
      "value": null
    }
  ],
  "parentId": "string",
  "primaryQueryResultId": "string",
  "queryText": "string",
  "temporary": true,
  "type": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

QueryParameterDto

Properties

Name	Type	Description	Restrictions
alias	string	The alias of the query parameter, used to avoid name collisions for nested query parameter references	Maximum length: 255, Minimum length: 0
choices	[any]	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
id	string	The entity’s unique identifier, set if it is a reference kind.
label	string	The label for the query parameter	Maximum length: 255, Minimum length: 0
listType	string	If the query parameter is of type select, this is the listType and is either static or external_legal_entity.
mode	string	The mode of the query parameter	required
name	string	The name of the query parameter	required, Maximum length: 255, Minimum length: 0
overridable	boolean	Whether the parameter can be overridden, defaults to true.	read-only
reference	any	The hydrated reference object	read-only
selectListId	string	If mode is select, this must be populated and is a reference to a select list from which choices will be derived.
type	string	The type of the query parameter	required
value	any

Enumerated Values

Property	Value
mode	scalar
mode	singleSelect
mode	multiSelect
mode	reference
type	string
type	bytes
type	integer
type	float
type	boolean
type	timestamp
type	date
type	time
type	datetime
type	global_parameter
type	nested_query_parameter

Example

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

QueryResultDto

Properties

Name	Type	Description	Restrictions
bytesScanned	integer(int64)	The number of bytes scanned	read-only
columns	[ColumnInfoDto]	If the query has successfully completed, contains a list of columns and their associated computed types from the query.	read-only
created	string(date-time)	When the entity was created	read-only
duration	integer(int64)	The duration of time it took to execute the query	read-only
error	string	If an error was encountered during the query, this field will be populated with error text.	read-only
id	string	The entity’s unique identifier	read-only
isExplain	boolean	Determines if this query is to be explained and not executed
parameters	object	The query parameter map
parameters.additionalProperties	any
pivotStatus	string	The current status of the pivot execution	read-only
queryDto	QueryDto	Associated queryDto
queryId	string	The identifier of the original query	required, Maximum length: 32, Minimum length: 0
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
queryText	string		read-only
rowsReturned	integer(int64)	Contains the number of rows returned from the query.	read-only
size	integer(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
status	string	The current status of the query execution	read-only
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-only

Enumerated Values

Property	Value
pivotStatus	NOT_STARTED
pivotStatus	RUNNING
pivotStatus	COMPLETE
pivotStatus	ERROR
pivotStatus	CANCELLED
pivotStatus	RUNNING_QUERY
pivotStatus	PIVOT_QUEUED
pivotStatus	RUNNING_PIVOT
pivotStatus	QUERY_COMPLETE
pivotStatus	NOT_APPLICABLE
pivotStatus	PIVOT_ERROR
status	NOT_STARTED
status	RUNNING
status	COMPLETE
status	ERROR
status	CANCELLED

Example

{
  "bytesScanned": 0,
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "duration": 0,
  "error": "string",
  "id": "string",
  "isExplain": true,
  "parameters": {
    "property1": null,
    "property2": null
  },
  "pivotStatus": "NOT_STARTED",
  "queryDto": {
    "created": "2019-08-24T14:15:22Z",
    "definition": {
      "columns": [
        {
          "columnType": "integer",
          "name": "string"
        }
      ],
      "decimalPlaces": 16,
      "filters": [
        {
          "betweenValue": "string",
          "columnType": "integer",
          "exclude": true,
          "filter": "EQUAL",
          "filterValues": [
            "string"
          ],
          "name": "string",
          "value": "string"
        }
      ],
      "grandTotalEnabled": "ENABLED",
      "id": "string",
      "multipleHeaders": true,
      "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",
    "isShared": true,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunBy": "string",
    "name": "string",
    "parameters": [
      {
        "alias": "string",
        "choices": [
          null
        ],
        "id": "string",
        "label": "string",
        "listType": "string",
        "mode": "scalar",
        "name": "string",
        "overridable": true,
        "reference": null,
        "selectListId": "string",
        "type": "string",
        "value": null
      }
    ],
    "parentId": "string",
    "primaryQueryResultId": "string",
    "queryText": "string",
    "temporary": true,
    "type": "string",
    "updated": "2019-08-24T14:15:22Z",
    "userId": "string",
    "version": 0
  },
  "queryId": "string",
  "queryParameters": [
    {
      "alias": "string",
      "choices": [
        null
      ],
      "id": "string",
      "label": "string",
      "listType": "string",
      "mode": "scalar",
      "name": "string",
      "overridable": true,
      "reference": null,
      "selectListId": "string",
      "type": "string",
      "value": null
    }
  ],
  "queryText": "string",
  "rowsReturned": 0,
  "size": 0,
  "status": "NOT_STARTED",
  "updated": "2019-08-24T14:15:22Z",
  "userId": "string",
  "version": 0
}

QueryTextDto

Properties

Name	Type	Description	Restrictions
queryText	string	queryText to be parsed, if present and valid.	required, Maximum length: 30000, Minimum length: 0

Example

{
  "queryText": "string"
}

RefreshBatchDto

Properties

Name	Type	Description	Restrictions
batchRefreshId	string	The unique ID of the batch	read-only
childRefreshes	[ConnectionRunDto]	The list of jobs initiated by the batch	read-only
created	string(date-time)	When the batch was created, as a datetime	read-only
createdBy	string	The ID of the user that created the batch	read-only
destinationStatus	string	The run status of the destination	read-only
error	string	Any error encountered while initiating the batch	read-only
sourceStatus	string	The run status of the source	read-only
updated	string(date-time)	When the batch was updated, as a datetime	read-only

Enumerated Values

Property	Value
destinationStatus	not_started
destinationStatus	running
destinationStatus	complete
destinationStatus	error
destinationStatus	cancelled
sourceStatus	not_started
sourceStatus	running
sourceStatus	complete
sourceStatus	error
sourceStatus	cancelled

Example

{
  "batchRefreshId": "string",
  "childRefreshes": [
    {
      "connectionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "destinationMetadata": {
        "property1": null,
        "property2": null
      },
      "destinationParameters": {
        "property1": null,
        "property2": null
      },
      "destinationStatus": "not_started",
      "destinationWorkspaceId": "string",
      "error": "string",
      "jobId": "string",
      "sourceMetadata": {
        "property1": null,
        "property2": null
      },
      "sourceParameters": {
        "property1": null,
        "property2": null
      },
      "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

Name	Type	Description	Restrictions
connectionId	string	The unique ID of the connection	write-only
destinationParameters	object	Parameters to send to the destination, on refresh	write-only
destinationParameters.additionalProperties	any
sourceParameters	object	Parameters to send to the source, on refresh	write-only
sourceParameters.additionalProperties	any
usePreviousDestinationParameters	boolean	Use the destination parameters from the previous run. This overrides any specified destination parameters. Ignored by “Refresh batch of connections” endpoint	write-only
usePreviousSourceParameters	boolean	Use the source parameters from the previous run. This overrides any specified source parameters. Ignored by “Refresh batch of connections” endpoint	write-only
workspaceId	string	The workspace ID of the connection	write-only

Example

{
  "connectionId": "string",
  "destinationParameters": {
    "property1": null,
    "property2": null
  },
  "sourceParameters": {
    "property1": null,
    "property2": null
  },
  "usePreviousDestinationParameters": true,
  "usePreviousSourceParameters": true,
  "workspaceId": "string"
}

SelectListDto

Properties

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
description	string	Description of this select list. Max length: 1024	Maximum length: 1024, Minimum length: 0
id	string	The entity’s unique identifier	read-only
name	string	Name of this select list. Max length: 100	required, Maximum length: 100, Minimum length: 0
type	string	Defines the type of the select list. Currently supported types are: - static: A standard select list with user-defined values - external_legal_entity: A special select list that contains external legal entity values Defaults to static if not provided. Important: Select lists of type external_legal_entity have restricted update capabilities. Only the name field can be modified after creation.
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
valueType	string	Defines the type of the items in the list.	required
values	[any]	List of possible values for the list. These values will be validated against the valueType provided.	required
version	integer(int64)	The version of the current representation of the entity	read-only

Enumerated Values

Property	Value
type	static
type	external_legal_entity
valueType	string
valueType	bytes
valueType	integer
valueType	float
valueType	boolean
valueType	timestamp
valueType	date
valueType	time
valueType	datetime
valueType	global_parameter
valueType	nested_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": [
    null
  ],
  "version": 0
}

SharedTableDto

Properties

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
destinationWorkspaceId	string	The id of the workspace being shared to.	required, Maximum length: 40, Minimum length: 0
id	string	The entity’s unique identifier	read-only
parentId	string	If non-null, indicates the parent of this entity. Must be modified through the folder api.	read-only
sourceTableId	string	The id of the table being shared.	required
table	TableDto	The associated table which will be hydrated when listing are fetching shared table entities.
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-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": true,
    "description": "string",
    "hierarchyMetadata": {
      "childColumnId": "string",
      "parentColumnId": "string"
    },
    "id": "string",
    "isShared": true,
    "lastUploaded": "2019-08-24T14:15:22Z",
    "name": "string",
    "parentId": "string",
    "readOnly": true,
    "tableSchema": {
      "columns": [
        {
          "alias": "string",
          "description": "string",
          "metadata": {
            "property1": null,
            "property2": null
          },
          "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

Name	Type	Description	Restrictions
body	string	A human-readable message describing the error	required
code	integer(int32)	A server-defined error code	required
details	[BaseErrorResponseDetail]	Additional details of the error

Example

{
  "body": "string",
  "code": 0,
  "details": [
    {
      "code": "string",
      "message": "string",
      "target": "string"
    }
  ]
}

SpreadsheetInfoDto

Properties

Name	Type	Description	Restrictions
sheetId	string	The unique identifier of the sheet
workbookId	string	The unique identifier of the workbook

Example

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

StartValidateFilesDto

Properties

Name	Type	Description	Restrictions
tableId	string	The unique identifier for the table.	required

Example

{
  "tableId": "string"
}

TableDto

Properties

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
databaseId	string	The unique identifier of the database where the table resides.	read-only
datasetUpdated	string(date-time)	The last time that the data set for this table was modified.
deleted	boolean	This is for backwards compatibility only and will always return false.	read-only
description	string	May be at most 255 characters in length	Maximum length: 255, Minimum length: 0
hierarchyMetadata	HierarchyMetadata	For hierarchical tables, this object specifies the parent and child column identifiers. Only required for tables of type “hierarchy.”
id	string	The entity’s unique identifier	read-only
isShared	boolean	A property indicating if this table is shared to any destination.	read-only, required
lastUploaded	string(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
name	string	May be at most 150 characters in length	required, Maximum length: 150, Minimum length: 0
parentId	string	If non-null, indicates the parent of this entity. Must be modified through the folder api.	read-only
readOnly	boolean	Indicates if this table is readonly in the account receiving this table. If so, any attempt to edit the table will fail.	read-only
tableSchema	TableSchema	The schema to apply	required
type	string	The type of table	required
uniqueTableConstraints	[UniqueConstraintDto]	A property indicating the unique constraints on the table.	required
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-only

Enumerated Values

Property	Value
type	data
type	lookup
type	hierarchy

Example

{
  "created": "2019-08-24T14:15:22Z",
  "databaseId": "string",
  "datasetUpdated": "2019-08-24T14:15:22Z",
  "deleted": true,
  "description": "string",
  "hierarchyMetadata": {
    "childColumnId": "string",
    "parentColumnId": "string"
  },
  "id": "string",
  "isShared": true,
  "lastUploaded": "2019-08-24T14:15:22Z",
  "name": "string",
  "parentId": "string",
  "readOnly": true,
  "tableSchema": {
    "columns": [
      {
        "alias": "string",
        "description": "string",
        "metadata": {
          "property1": null,
          "property2": null
        },
        "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

Name	Type	Description	Restrictions
columns	[ColumnDto]	list of columns in the table, must at least one in size	required, Minimum items: 1, Maximum items: 150

Example

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

TagDto

Properties

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
id	string	The entity’s unique identifier	read-only
key	string	Value for the key, maximum 100 characters in length	required, Maximum length: 100, Minimum length: 0
updated	string(date-time)	When the entity was last updated	read-only
userId	string	The owner of the entity	read-only
values	[string]	Set of values for the tag	Minimum items: 0, Maximum items: 300, unique
version	integer(int64)	The version of the current representation of the entity	read-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

Name	Type	Description	Restrictions
created	string(date-time)	When the entity was created	read-only
id	string	The entity’s unique identifier	read-only
objectId	string	The object’s unique identifier	required, Maximum length: 32, Minimum length: 0
updated	string(date-time)	When the entity was last updated	read-only
useFlatKey	boolean	Create token using flat query results key; Ignored unless true.
userId	string	The owner of the entity	read-only
version	integer(int64)	The version of the current representation of the entity	read-only

Example

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

UniqueConstraintDto

Properties

Name	Type	Description	Restrictions
description	string	Description of this unique constraint. Max length: 1024	Maximum length: 1024, Minimum length: 0
id	string	Id of the unique constraint	required, Maximum length: 100, Minimum length: 0
name	string	Name of this unique constraint. Max length: 100	required
tableId	string	Id of the table this unique constraint is associated with	required, Maximum length: 100, Minimum length: 0
values	[string]	List of values in the unique constraint	required, Minimum items: 1, Maximum items: 512

Enumerated Values

Property	Value
name	key_columns

Example

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

ValidateFilesDto

Properties

Name	Type	Description	Restrictions
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.	read-only
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.	read-only

Example

{
  "deletedFiles": [
    {
      "columnMappings": {
        "property1": "string",
        "property2": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "delimiter": "string",
      "id": "string",
      "key": "string",
      "metadata": {
        "property1": {
          "property1": null,
          "property2": null
        },
        "property2": {
          "property1": null,
          "property2": null
        }
      },
      "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": null,
          "property2": null
        },
        "property2": {
          "property1": null,
          "property2": null
        }
      },
      "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

Name	Type	Description	Restrictions
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.	read-only
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.	read-only

Example

{
  "deletedTables": [
    {
      "created": "2019-08-24T14:15:22Z",
      "databaseId": "string",
      "datasetUpdated": "2019-08-24T14:15:22Z",
      "deleted": true,
      "description": "string",
      "hierarchyMetadata": {
        "childColumnId": "string",
        "parentColumnId": "string"
      },
      "id": "string",
      "isShared": true,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": true,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": null,
              "property2": null
            },
            "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": true,
      "description": "string",
      "hierarchyMetadata": {
        "childColumnId": "string",
        "parentColumnId": "string"
      },
      "id": "string",
      "isShared": true,
      "lastUploaded": "2019-08-24T14:15:22Z",
      "name": "string",
      "parentId": "string",
      "readOnly": true,
      "tableSchema": {
        "columns": [
          {
            "alias": "string",
            "description": "string",
            "metadata": {
              "property1": null,
              "property2": null
            },
            "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
    }
  ]
}