Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

It is also possible to directly test the API response to a request with the playground area on the right. To do so, you have to be connected as a Cytomine user. To obtain a session, you have to connect using the web interface with the same browser.

  

API endpoint conventions

Basically, an object is created with a POST /api/object.json request.

To get an object, make a GET /api/object/{id}.json request where {id} is the identifier of the requested object. 

To update an object, make a PUT /api/object/{id}.json request where {id} is the identifier of the requested object. 

To delete an object, make a DELETE /api/object/{id}.json request where {id} is the identifier of the requested object. 

To obtain a list of objects, use a GET /api/object.json request.

A list of objects can often be filtered. For example, to obtain the list of projects that are available for a specifier user (which you have rights for), make a GET /api/user/{id}/project.json.


Cytomine API Simple examples

Here are examples of requests and description of typical results.

...