Saved Tables


The /table/saved endpoint allows you to submit a query for a saved table from the User Data Repository. To retrieve a specific table, use the /schema endpoint to find the table URI (which will be in the form str:table:<ID>), and append this to the endpoint used in the query (see below for a worked example).

Overview

Endpoint
https://<server>/webapi/rest/v1/table/saved/<table_uri>
HTTP MethodGET

Request Headers


Accept-Language
The language that labels will be returned in (setting this is equivalent to changing the dataset and user interface language in SuperWEB2).Optional. If not set, the server default language will be used.
APIKey
The API Key to use to authenticate this request. You can obtain your API key from the Account page in SuperWEB2.Required in all requests.

Response Headers


X-RateLimit
X-RateLimit-Schema
X-RateLimit-Table

The global, schema, and table rate limits (if configured).

The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies.

X-RateLimit-Remaining
X-RateLimit-Remaining-Schema
X-RateLimit-Remaining-Table

The number of requests remaining for the current rate limiting period. If this value drops to 0 then you will not be able to submit any further requests using this API key until the limit resets.

The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies.

X-RateLimit-Reset
X-RateLimit-Reset-Schema
X-RateLimit-Reset-Table

The time when the rate limit will next be reset. This is expressed as a UNIX timestamp in milliseconds (milliseconds since January 1st 1970).

The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies.

Response Body

The table query results. The response is in the same format as a regular query to the /table endpoint. See Table Endpoint for more details.

Example Query

For example, suppose the /schema endpoint returns the following for the table you are interested in:

        {
            "id": "str:table:e101771e-2161-4e72-850c-6f3183db652e",
            "label": "Participation by State, Gender and Age",
            "location": "https://sw2.wingarc.com.au/webapi/rest/v1/schema/str:table:e101771e-2161-4e72-850c-6f3183db652e",
            "type": "TABLE"
        }

In this example, the table URI is str:table:e101771e-2161-4e72-850c-6f3183db652e. To query for this saved table you would send your GET request to https://sw2.wingarc.com.au/webapi/rest/v1/table/saved/str:table:e101771e-2161-4e72-850c-6f3183db652e