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

Tasks

PreviousEventsNextProjects

Last updated 2 months ago

get

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

Path parameters
idintegerRequired

ID of Experiment to return

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

{
  "id": "text",
  "name": "text",
  "project_id": "text",
  "parent_id": "text",
  "priority": "text",
  "created_at": "text",
  "updated_at": "text",
  "start_date": "text",
  "due_date": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "assignee": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "signatures": [
    {
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "comment": "text",
      "created_at": "text"
    }
  ],
  "custom_properties": {}
}
delete

Removes the resource with id.

Path parameters
idintegerRequired

ID of Experiment to remove

Responses
200
success
application/json
401
not authenticated
404
not found
500
general error
delete
DELETE /experiments/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text",
  "project_id": "text",
  "parent_id": "text",
  "priority": "text",
  "created_at": "text",
  "updated_at": "text",
  "start_date": "text",
  "due_date": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "assignee": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "signatures": [
    {
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "comment": "text",
      "created_at": "text"
    }
  ],
  "custom_properties": {}
}
  • POST/experiments
  • GET/experiments
  • GET/experiments/{id}
  • PATCH/experiments/{id}
  • DELETE/experiments/{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 /experiments HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "limit": 1,
  "skip": 1,
  "data": [
    {
      "id": "text",
      "name": "text",
      "project_id": "text",
      "parent_id": "text",
      "priority": "text",
      "created_at": "text",
      "updated_at": "text",
      "start_date": "text",
      "due_date": "text",
      "status": {
        "name": "text",
        "stage": "text"
      },
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "assignee": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "signatures": [
        {
          "author": {
            "uuid": "text",
            "name": "text",
            "email": "text"
          },
          "comment": "text",
          "created_at": "text"
        }
      ],
      "custom_properties": {}
    }
  ]
}
post

Creates a new resource with data.

Body
namestringRequired
project_idstringRequired
parent_idany ofOptional
stringOptional
or
nullOptional
priorityany ofRequired
stringOptional
or
nullOptional
assignee_idstringOptional
Responses
201
created
application/json
401
not authenticated
500
general error
post
POST /experiments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "project_id": "text",
  "parent_id": "text",
  "priority": "text",
  "assignee_id": "text"
}
{
  "id": "text",
  "name": "text",
  "project_id": "text",
  "parent_id": "text",
  "priority": "text",
  "created_at": "text",
  "updated_at": "text",
  "start_date": "text",
  "due_date": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "assignee": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "signatures": [
    {
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "comment": "text",
      "created_at": "text"
    }
  ],
  "custom_properties": {}
}
patch

Updates the resource identified by id using data.

Path parameters
idintegerRequired

ID of Experiment to update

Body
namestringRequired
priorityany ofRequired
stringOptional
or
nullOptional
start_dateany ofRequired
stringOptional
or
nullOptional
due_dateany ofRequired
stringOptional
or
nullOptional
assignee_idstringOptional
Responses
200
success
application/json
401
not authenticated
404
not found
500
general error
patch
PATCH /experiments/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "name": "text",
  "priority": "text",
  "start_date": "text",
  "due_date": "text",
  "assignee_id": "text"
}
{
  "id": "text",
  "name": "text",
  "project_id": "text",
  "parent_id": "text",
  "priority": "text",
  "created_at": "text",
  "updated_at": "text",
  "start_date": "text",
  "due_date": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "assignee": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "signatures": [
    {
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "comment": "text",
      "created_at": "text"
    }
  ],
  "custom_properties": {}
}