Get an uploaded file
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/datasets/{id}
An uploaded CSV file or Excel workbook. A workbook comes with its sheets, the range each one uses and its named ranges: pass a sheet's id as sheetId to also read its cells as text, which shows where a table's header row is. Then add the sheet, or a range of it that starts at the header row, to a report with addReportDatasheets. Cells show what the workbook saved: nothing is recalculated.
Requires the slide_decks:read scope.
Operation ID: getDataset.
Path parameters
id(string, required): The uploaded file to read: theidreturned bycreateDataset, or a datasheet'sdatasetIdinlistReportDatasheets. It can be any uploaded file of your organization, including one another member uploaded.
Query parameters
sheetId(string): A sheet of an uploaded workbook whose cells to read: one of thesheets[].idvalues of an earlier call. The answer'scellsthen holds them. Omit it to list the workbook's sheets only.range(string): The cells to read from the sheet, in A1 notation without the sheet's name, such asA1:H40. Omit it to read from the start of the range the sheet uses. Only withsheetId. Example:A1:H40.
Response 200
Success
application/json
id(string, required): Unique identifier for the uploaded file. Pass it asidtoreplaceDatasetanddeleteDatasetand, for a CSV file, asdatasetIdtoaddReportDatasheetsto add it to a report.name(string, required): The uploaded file's name: thenameit was created with for a CSV file, or the workbook's file name for an Excel workbook, such asQ3 pipeline.xlsx. Replacing the file's content doesn't change it.createdAt(string (date-time), required): When the file was uploaded. Replacing its content doesn't change it.updatedAt(string (date-time), required): When the file's content was last replaced withreplaceDataset, or when it was uploaded if it has never been replaced.kind(string, required): What the uploaded file is. Acsvfile is added to a report whole. Aworkbookis added one sheet or range at a time. One ofcsv,workbook.sheets(array of object or null, required): A workbook's sheets (tabs), in the order Excel shows them, hidden ones included.nullfor a CSV file.id(string, required): Unique identifier for the sheet within the workbook. Pass it assheetIdtoaddReportDatasheets, with the file'sidasdatasetId.title(string, required): The sheet's name, as shown on its tab in Excel.hidden(boolean, required): Whether the sheet is hidden in Excel. A hidden sheet can still be read.usedRange(string or null, required): The cells of the sheet that hold something, in A1 notation, such asA1:H40: whataddReportDatasheetsreads when you pass norange. It can start with title rows or hold several tables, so read itscellsbefore adding it.nullfor an empty sheet.
namedRanges(array of object or null, required): A workbook's named ranges that lie on one of its sheets.nullfor a CSV file.name(string, required): The named range's name in Excel.sheetId(string, required): The sheet the named range is on: one ofsheets[].id.range(string, required): The cells the name stands for, in A1 notation. Pass it asrangetoaddReportDatasheets.
cells(object or null, required): The cells of the sheet asked for withsheetId.nullwhen no sheet was asked for.sheetId(string, required): The sheet the cells were read from.range(string, required): The cells asked for, in A1 notation.rows(array of array of string, required): The cells as text, as Excel shows them, row by row from the top-left cell ofrange, with an empty string for an empty cell. At most 50 rows and 30 columns. Use them to find the row a table's header is on, then add the table withaddReportDatasheets, starting itsrangeat that row.truncated(boolean, required): Whetherrangeholds more rows or columns thanrowsshows. Read further with arangethat starts lower.