Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.

Spider REST Command Summary

JoeWinter edited this page Feb 18, 2015 · 4 revisions

[Table of Contents](https://github.com/dell-oss/Doradus/wiki/Spider Databases: Table-of-Contents) | Previous | Next
Spider REST Commands: Spider REST Command Summary


The REST API commands supported by Doradus Spider are summarized below:
REST Command Method and URI
Application Management Commands
Create Application POST /_applications
Modify Application PUT /_applications/{application}
List All Applications GET /_applications
List Application GET /_applications/{application}
Delete Application DELETE /_applications/{application}
DELETE /_applications/{application}/{key}
Object Update Commands
Add Batch POST /{application}/{table}
Update Batch PUT /{application}/{table}
Delete Batch DELETE /{application}/{table}
Query Commands
Get Object by ID GET /{application}/{table}/{ID}
Object Query via URI GET /{application}/{table}/_query?{params}
Object Query via Entity GET /{application}/{table}/_query
PUT /{application}/{table}/_query
Aggregate Query via URI GET /{application}/{table}/_aggregate?{params}
Aggregate Query via Entity GET /{application}/{table}/_aggregate
PUT /{application}/{table}/_aggregate
Task Status Commands
Get All Task Status GET /_tasks
Get Application Task Status GET /_tasks/{application}
Get Table Task Status GET /_tasks/{application}/{table}
Get Table Task Type Status GET /_tasks/{application}/{table}/{task}
Modify Application Task Status PUT /_tasks/{application}?{command}
Modify Table Tasks Status PUT /_tasks/{application}/{table}?{command}
Modify Table Task Type Status PUT /_tasks/{application}/{table}/{task}?{command}
Start Data Cleanup Task POST /_tasks/{application}/{table}/{task}/{field}[?{params}]
Stop Data Cleanup Task DELETE /_tasks/{application}/{table}/{task}/[{field}]

Details on each command are described in the following sections.

Clone this wiki locally