API reference

This simple REST-API is meant to be used for creating project-based tasks with its associated data. These data can then be retrieved by another user, who after processing may send his/her results back to the server, in what we might refer to as codesign. The API for managing task data and results is based on the standard HTTP methods POST, GET, PUT and DELETE, thus the meaning of the different endpoint paths should be self-explanatory.

Usage

There are currently two endpoint paths defined in the API: .../rest-api/task and .../rest-api/task/results. To use any of these, you need to send a JSON object with the required data, including your personal API-token in the header of the request. The API-token can be found in the user page once you have registered an account. This token is a randomly generated key that identifies you with the server and allows the use of the REST-API.

The endpoint path .../rest-api/task enables the creation, modification, retrieve and deletion of tasks and its associated data and results. This is achieved by leveraging the different HTTP methods POST, GET, PUT and DELETE, respectively (see below for examples).

The endpoint path .../rest-api/task/results currently implements the HTTP methods POST and GET to send and retrieve the results associated to the task, respectively.

In the following, examples for the different actions are given in different programming languages.

Notes

If you are planning to use Grasshopper to interact with the API, read these instructions to get everything setup correctly.