Project

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
m (GET: Retrieve all projects)
m (REST Operations)
Line 6: Line 6:
 
A [[Protocol]] is always associated with a project,and the protocol representation includes a link to a Project.
 
A [[Protocol]] is always associated with a project,and the protocol representation includes a link to a Project.
  
== REST Operations ==
+
= REST Operations =
  
=== GET: Retrieve all projects ===
+
== GET: Retrieve all projects ==
 
{{REST Operations
 
{{REST Operations
 
|REST_op_description=Retrieves available projects
 
|REST_op_description=Retrieves available projects
Line 29: Line 29:
 
  curl -X GET -H 'Accept:text/uri-list' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project?page=0&pagesize=5
 
  curl -X GET -H 'Accept:text/uri-list' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project?page=0&pagesize=5
  
=== GET: Retrieve a single project ===
+
== GET: Retrieve a single project ==
 
{{REST Operations
 
{{REST Operations
 
|REST_op_description=Retrieves a single project
 
|REST_op_description=Retrieves a single project
Line 46: Line 46:
 
  curl -X GET -H 'Accept:application/rdf+xml' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project/G1
 
  curl -X GET -H 'Accept:application/rdf+xml' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project/G1
  
===POST: Create a project ===
+
==POST: Create a project ==
 
{{REST Operations
 
{{REST Operations
 
|REST_op_description=Creates a project
 
|REST_op_description=Creates a project
Line 64: Line 64:
 
         -d 'title=MANDATORY_VALUE' -d  'ldapgroup=OPTIONAL_VALUE' http://toxbanktest1.opentox.org:8080/toxbank/project
 
         -d 'title=MANDATORY_VALUE' -d  'ldapgroup=OPTIONAL_VALUE' http://toxbanktest1.opentox.org:8080/toxbank/project
  
===PUT: Update a project ===
+
==PUT: Update a project ==
 
{{REST Operations
 
{{REST Operations
 
|REST_op_description=Updates the project metadata
 
|REST_op_description=Updates the project metadata
Line 82: Line 82:
 
         -d 'title=MANDATORY_VALUE' -d  'ldapgroup=OPTIONAL_VALUE' http://toxbanktest1.opentox.org:8080/toxbank/project/G3
 
         -d 'title=MANDATORY_VALUE' -d  'ldapgroup=OPTIONAL_VALUE' http://toxbanktest1.opentox.org:8080/toxbank/project/G3
  
===DELETE: Delete a project ===
+
==DELETE: Delete a project ==
 
{{REST Operations
 
{{REST Operations
 
|REST_op_description=Removes an existing project
 
|REST_op_description=Removes an existing project

Revision as of 12:35, 14 December 2011

Project


A project is a REST resource,representing projects from SEURAT cluster, or external projects. A project is identified by its URI, has a name and may be assigned an LDAP group. The LDAP group should be one of the existing ToxBank LDAP groups and accessible via ToxBank OpenAM. External projects may or may not be assigned an LDAP group.

A Protocol is always associated with a project,and the protocol representation includes a link to a Project.

Contents

REST Operations

GET: Retrieve all projects

Description Retrieves available projects
Resource Project
Method GET
URI /project
Parameters none, or ?search=name or paging parameters: page, pagesize
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

Example: http://toxbanktest1.opentox.org:8080/toxbank/project

curl -X GET -H 'Accept:text/uri-list' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project
curl -X GET -H 'Accept:application/rdf+xml' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project?search=Tox
curl -X GET -H 'Accept:text/uri-list' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project?page=0&pagesize=5

GET: Retrieve a single project

Description Retrieves a single project
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

Example: http://toxbanktest1.opentox.org:8080/toxbank/project/G1

curl -X GET -H 'Accept:application/rdf+xml' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project/G1

POST: Create a project

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

Example: http://toxbanktest1.opentox.org:8080/toxbank/project

curl -X POST -H 'subjectid:TOKEN' -H 'Content-Type:application/x-www-form-urlencoded' \
       -d 'title=MANDATORY_VALUE' -d  'ldapgroup=OPTIONAL_VALUE' http://toxbanktest1.opentox.org:8080/toxbank/project

PUT: Update a project

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


Example:

curl -X PUT -H 'subjectid:TOKEN' -H 'Content-Type:application/x-www-form-urlencoded' \
       -d 'title=MANDATORY_VALUE' -d  'ldapgroup=OPTIONAL_VALUE' http://toxbanktest1.opentox.org:8080/toxbank/project/G3

DELETE: Delete a project

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


Example:

curl -X DELETE -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/project/G3

RDF representation

RDF N3

This RDF representation is automatically generated by the latesr version of the Toxbank Java client library

Facts about ProjectRDF feed
Acts on
Has output media typeapplication/rdf+xml;text/n3;text/uri-list  +
Has status code200,202,400,401,402,403,500  +
Personal tools