SITools2

h1. DataSet resources and representations

h2. Resources

h3. 1. Resources List:

* http://localhost:8184/sitools/datasets/{datasetId}

* http://localhost:8184/sitools/datasets/{datasetId}/start

* http://localhost:8184/sitools/datasets/{datasetId}/getSqlString

* http://localhost:8184/sitools/datasets/{datasetId}/stop

* http://localhost:8184/sitools/datasets/{datasetId}/refresh

* http://localhost:8184/sitools/datasets/{datasetId}/notify

* http://localhost:8184/sitools/datasets/{datasetId}/mappings

* http://localhost:8184/sitools/datasets/{datasetId}/mappings/{dictionaryId}

* http://localhost:8184/sitools/datasets/

$HOST_DOMAIN = Starter.PUBLIC_HOST_DOMAIN

h3. 2. Methods:

* GET: Method to retrieve a single or all datasets

* PUT:

 1. PUT /{datasetId}/start:  Performs a start action on the dataset making the related DatasetApplication ACTIVE.

 2. PUT /{datasetId}/getSqlString: Builds and returns the underlying data source SQL request string for the dataset.

 3. PUT /{datasetId}/stop: Performs a stop action on the dataset making the related DatasetApplication INACTIVE.

h3. 3. Examples:

<pre><code class="python">

curl -u $username:$userpwd -X PUT http://$localhost/sitools/datasets/$dataset_id/start

curl -u $username:$userpwd -X PUT http://$localhost/sitools/datasets/$dataset_id/start

curl -u $username:$userpwd -X PUT http://$localhost/sitools/datasets/$dataset_id/getSqlString

</code></pre>

h3. 4. Results of the above examples: 

1.  Performs a stop action on the dataset 

!Selection_357.jpg!

2.  Performs a start action on the dataset

!Selection_359.jpg!

3.  Builds and returns the underlying data source SQL request string for the dataset.

!Selection_358.jpg!

h3. 5. PUT and POST

* POST: Used to modify and update a resource. It is idempotent(Do it as many times I want with the same result at last).

* PUT: Used to create a resource, or overwrite it. While you specify the resources new URL. It is not idempotent.

* POST can't be used for modifying the status of a dataset in Sitools.

h2. Representations

* JSON response output representation (application/json - )

Example: 

<pre><code class="html">

http://idoc-medoc-test/webs_PICARD_dataset?media=json

</code></pre>

Then all information about the dataset come, including all XML nodes infomation, id, name, status, description, columnModel result block etc..