/schema endpoint returns information about the SuperSTAR datasets that are available to you, and their fields and measures.
|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.|
|The API Key to use to authenticate this request. You can obtain your API key from the Preferences page in SuperWEB2.||Required in all requests.|
|If you provide a known Etag value, then (if the response has not changed) this endpoint will return a 304 response instead of the response body. 304 responses do not count against your rate limit usage.||Optional. If not set, the request will count against your rate limit usage.|
|The rate limit configured for this server. By default, this is set to 100.|
|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 time when the rate limit will next be reset. This is expressed as a UNIX timestamp in milliseconds (the number of milliseconds since January 1st 1970).|
|The checksum of the response. You can store this and use it in the |
If the response returns a large number of child values then it may be subject to pagination (by default, this occurs if there are over 100 child values, although your administrator may have configured a different limit). When the response is paginated, this header will contain a link to the next page of results.
If this header is not returned then this indicates either that the response was not paginated, or that the current response contains the last page of results.
The root endpoint,
/schema, returns details of all datasets and folders at the root level of the SuperSTAR server that your user account has permission to access. For example, the following response indicates that there are two datasets installed at the root level that you have permission to access: people and bank.
As shown by this example, each object that is described in the response has a unique ID that begins with
str:. You can append this to the URL to obtain more details about that object. For example, querying
/schema/str:database:bank returns information about the Retail Banking database:
You can use any of the IDs returned here to further explore the schema, for example you might call
/schema/str:folder:bank:Customers to query the fields available in the Customers folder within the Retail Banking dataset.
Schema Types and Associated ID Schemes
The following is a list of all the available schema types and their corresponding ID schemes:
|Folder (grouping within a dataset)|