table

Retrieve all rows from the table

get/v1/org/{orgId}/table/{tableId}/data

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/table/{tableId}/data
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

tableIdstring required

Table id or unique name to retrieve

Query parameters

datestring date

Date to search as of

scenarioIdstring

Scenario id to retrieve from

qstring

Filter to query by

fromstring

Job id to start paginating from

limitinteger

Number of results to return

sortstring

Sort by fields, comma-separated. For descending sort, prepend a -

columnsstring

Columns to retrieve, comma-separated (defaults to all columns)

formatstring

Data format to use; default is json, can also use json-extended, json-readable, or csv

splitColumnsboolean

Whether to split complex columns, used for tabular data formats

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful retrieval

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 20 revisions of this API.