Colabra REST API
  • Introduction
  • Authentication
  • Rate limits
  • Status and error codes
  • Resources
    • Comments
    • Events
    • Tasks
    • Projects
Powered by GitBook
On this page
  1. Resources

Comments

PreviousStatus and error codesNextEvents

Last updated 1 year ago

get

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

Path parameters
idintegerRequired

ID of Comment to return

Responses
200
success
application/json
401
not authenticated
404
not found
500
general error
get
GET /comments/{id} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "text",
  "body": {
    "html": "text",
    "text": "text"
  },
  "experiment_id": "text",
  "project_id": "text",
  "author_id": "text",
  "created_at": "text",
  "updated_at": "text"
}
  • POST/comments
  • GET/comments
  • GET/comments/{id}
get

Retrieves a list of all resources from the service.

Query parameters
$limitintegerOptional

Number of results to return

$skipintegerOptional

Number of results to skip

Responses
200
success
application/json
401
not authenticated
500
general error
get
GET /comments HTTP/1.1
Host: 
Accept: */*

{
  "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"
    }
  ]
}
post

Creates a new resource with data.

Body
body_textstringRequired
experiment_idstringOptional
project_idstringOptional
Responses
201
created
application/json
401
not authenticated
500
general error
post
POST /comments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 63

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