/api/dataSets
Lists all datasets available to the user.
Resource Information
Resource URL | |
---|---|
HTTP Method |
|
Request Parameters
Parameters | Detail | Example |
---|---|---|
| (Optional) If set, the result only contains data sets that contain the filter text in name. | Sales |
| (Optional) Specifies the page offset if pagination is necessary. | 2 |
| (Optional) Specifies the number of entries on each page if pagination is necessary.
| 15 |
Response Structure
{ "dataSets" : [ ], "offset" : 0, "size" : 100 }
JSON response contains 2 pagination elements (offset and size) but the main element is array "dataSets" that contains multiple data set objects with following definition:
Name | Description |
---|---|
id | Data set identifier |
name | Data set name |
code | Data set code |
owner | Owner full name |
description | Data set description |
lastChange | Date and time of data set last change |
localization | Localization object that contains key-value pairs, where key is code of supported language and value is localized data set name. |
parameters | (Optional) Array of data set parameters |
Sample Request / Response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/dataSets?filter=john
The JSON format response:
{ "dataSets" : [ { "id" : 7497, "name" : "John's data set", "code" : "DATASET_CODE", "owner" : "John Smith", "localization" : { "de" : "Deutsch Name" }, "description" : "This is a sample data set.", "lastChange" : "Mon, 16 Apr 2012 10:17:26 GMT", "parameters": [ { "param1": "value1" }, { "param2": "value2" } ] } ], "offset" : 0, "size" : 100 }
Overview
Content Tools