Project resources and representations¶

Resources¶

1. Resources List:

• http://$HOST_DOMAIN/sitools/projects/{projectId}
• http://$HOST_DOMAIN/sitools/projects/{projectId}/start
• http://$HOST_DOMAIN/sitools/projects/{projectId}/stop
• http://$HOST_DOMAIN/sitools/projects/{projectId}/startmaintenance
• http://$HOST_DOMAIN/sitools/projects/{projectId}/stopmaintenance
• http://$HOST_DOMAIN/sitools/projects/{projectId}/graph
• http://$HOST_DOMAIN/sitools/projects/{projectId}/datasets
• http://$HOST_DOMAIN/sitools/projects/{projectId}/notify
• http://$HOST_DOMAIN/sitools/projects/{projectId}/graph/notify
• http://$HOST_DOMAIN/sitools/projects/

URL	Verb	Description	Response	Comments
/projects/{projectId}	GET	Retrieve all project's dataset	All project's dataSet as JSON

$HOST_DOMAIN = Starter.PUBLIC_HOST_DOMAIN

2. Methods:

• GET: Method to retrieve a single or all projects.
• PUT: Method to modify the current status of a project. (activate or deactivate)
• DELETE: Method to delete a single project by ID
• POST

3. Examples:¶

curl -u $username:$userpwd -X GET http://$HOST_DOMAIN/sitools/projects/$project_id
curl -u $username:$userpwd -X GET http://$localhost/sitools/projects/$project_id/graph
curl -u $username:$userpwd -X PUT http://$HOST_DOMAIN/sitools/projects/$project_id/stop
curl -u $username:$userpwd -X PUT http://$HOST_DOMAIN/sitools/projects/$project_id/start

4. 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 project in Sitools.

Representations¶

• JSON response output representation (application/json - )

Example:

http://idoc-medoc-test/project/solar?media=json

Then all information about the project come, including all XML nodes infomation, name, description, datasets result block etc..