Comments

Creates a new resource with data.

post

/comments

Body

body_textstringrequired

experiment_idstring

project_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

401

500

201

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

created

Retrieves a list of all resources from the service.

get

/comments

Query parameters

$limitinteger

Number of results to return

$skipinteger

Number of results to skip

filterobject

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",
      "experiment_id": "text",
      "project_id": "text",
      "author_id": "text",
      "created_at": "text",
      "updated_at": "text",
      "body": {
        "html": "text",
        "text": "text"
      }
    }
  ]
}

success

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

get

/comments/{id}

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",
  "experiment_id": "text",
  "project_id": "text",
  "author_id": "text",
  "created_at": "text",
  "updated_at": "text",
  "body": {
    "html": "text",
    "text": "text"
  }
}

success