Project
From ToxBank API Wiki
(Difference between revisions)
m (Created page with "{{REST_resource}}") |
(added operations for project resource) |
||
Line 1: | Line 1: | ||
{{REST_resource}} | {{REST_resource}} | ||
+ | |||
+ | {{REST Operations | ||
+ | |REST_op_description=Retrieves the project metadata | ||
+ | |REST_resource=Project | ||
+ | |REST_op_method=GET | ||
+ | |REST_op_uri=/project/{id} | ||
+ | |REST_op_params=none, or ?search=name | ||
+ | |REST_header_param=subjectid:SECURITY-TOKEN | ||
+ | |REST_op_mime_input=none | ||
+ | |REST_op_result=The project representation in supported media type | ||
+ | |REST_op_mime_output=application/rdf+xml;text/n3;text/uri-list | ||
+ | |REST_op_status=200,400,401,402,403 | ||
+ | }} | ||
+ | |||
+ | {{REST Operations | ||
+ | |REST_op_description=Creates a project | ||
+ | |REST_resource=Project | ||
+ | |REST_op_method=POST | ||
+ | |REST_op_uri=/project | ||
+ | |REST_op_params=Any combination of name,ldapgroup | ||
+ | |REST_header_param=subjectid:SECURITY-TOKEN | ||
+ | |REST_op_mime_input=application/x-www-form-urlencoded | ||
+ | |REST_op_result=Task representation in supported MIME formats | ||
+ | |REST_op_mime_output=application/rdf+xml;text/n3;text/uri-list | ||
+ | |REST_op_status=200,202,400,401,402,403,500 | ||
+ | }} | ||
+ | |||
+ | {{REST Operations | ||
+ | |REST_op_description=Updates the project metadata | ||
+ | |REST_op_method=PUT | ||
+ | |REST_op_uri=/project/{id} | ||
+ | |REST_op_params=Any combination of name,ldapgroup | ||
+ | |REST_header_param=subjectid:SECURITY-TOKEN | ||
+ | |REST_op_mime_input=application/x-www-form-urlencoded | ||
+ | |REST_op_result=Task representation in supported MIME formats | ||
+ | |REST_op_mime_output=application/rdf+xml;text/n3;text/uri-list | ||
+ | |REST_op_status=200,202,400,401,402,403,500 | ||
+ | }} | ||
+ | |||
+ | {{REST Operations | ||
+ | |REST_op_description=Removes an existing project | ||
+ | |REST_op_method=DELETE | ||
+ | |REST_op_uri=/project/{id} | ||
+ | |REST_op_params=none | ||
+ | |REST_header_param=subjectid:SECURITY-TOKEN | ||
+ | |REST_op_mime_input=none | ||
+ | |REST_op_result=Task representation in supported MIME formats | ||
+ | |REST_op_mime_output=application/rdf+xml;text/n3;text/uri-list | ||
+ | |REST_op_status=200,202,400,401,402,403,500 | ||
+ | }} |
Revision as of 11:35, 14 December 2011
Project |
---|
Description | Retrieves the project metadata |
---|---|
Resource | Project |
Method | GET |
URI | /project/{id} |
Parameters | none, or ?search=name |
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | none |
Results | The project representation in supported media type |
Media Type (output) | application/rdf+xml;text/n3;text/uri-list |
Status code | 200,400,401,402,403 |
Description | Creates a project |
---|---|
Resource | Project |
Method | POST |
URI | /project |
Parameters | Any combination of name,ldapgroup |
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | application/x-www-form-urlencoded |
Results | Task representation in supported MIME formats |
Media Type (output) | application/rdf+xml;text/n3;text/uri-list |
Status code | 200,202,400,401,402,403,500 |
Description | Updates the project metadata |
---|---|
Resource | [[]] |
Method | PUT |
URI | /project/{id} |
Parameters | Any combination of name,ldapgroup |
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | application/x-www-form-urlencoded |
Results | Task representation in supported MIME formats |
Media Type (output) | application/rdf+xml;text/n3;text/uri-list |
Status code | 200,202,400,401,402,403,500 |
Description | Removes an existing project |
---|---|
Resource | [[]] |
Method | DELETE |
URI | /project/{id} |
Parameters | none |
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | none |
Results | Task representation in supported MIME formats |
Media Type (output) | application/rdf+xml;text/n3;text/uri-list |
Status code | 200,202,400,401,402,403,500 |
Facts about ProjectRDF feed
Acts on | |
Has output media type | application/rdf+xml;text/n3;text/uri-list + |
Has status code | 200,202,400,401,402,403,500 + |