Comments

post

Creates a new resource with data.

Body

body_textstringrequired

experiment_idstringoptional

project_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/comments' \
  --header 'Content-Type: application/json' \
  --data '{
    "body_text": "text",
    "experiment_id": "text",
    "project_id": "text"
  }'

201

401

500

201

{
  "uuid": "text",
  "body": {
    "html": "text",
    "text": "text"
  },
  "experiment_id": "text",
  "project_id": "text",
  "author_id": "text",
  "created_at": "text",
  "updated_at": "text"
}

created

get

Retrieves a list of all resources from the service.

Query parameters

$limitintegeroptional

Number of results to return

$skipintegeroptional

Number of results to skip

filterobjectoptional

Query parameters

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/comments'

200

401

500

200

{
  "total": 1,
  "limit": 1,
  "skip": 1,
  "data": [
    {
      "uuid": "text",
      "body": {
        "html": "text",
        "text": "text"
      },
      "experiment_id": "text",
      "project_id": "text",
      "author_id": "text",
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

success

get

Retrieves a single resource with the given id from the service.

Path parameters

idintegerrequired

ID of Comment to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/comments/{id}'

200

401

404

500

200

{
  "uuid": "text",
  "body": {
    "html": "text",
    "text": "text"
  },
  "experiment_id": "text",
  "project_id": "text",
  "author_id": "text",
  "created_at": "text",
  "updated_at": "text"
}

success