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 1 month ago

get

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

Path parameters
idintegerrequired

ID of Experiment to return

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/experiments/{id}'
200
401
404
500
{
  "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": {}
}

success

delete

Removes the resource with id.

Path parameters
idintegerrequired

ID of Experiment to remove

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/experiments/{id}'
200
401
404
500
{
  "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": {}
}

success

  • 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

filterobjectoptional

Query parameters

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/experiments'
200
401
500
{
  "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": {}
    }
  ]
}

success

post

Creates a new resource with data.

Body
namestringrequired
project_idstringrequired
parent_idany ofoptional

priorityany ofrequired

assignee_idstringoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/experiments' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "project_id": "text",
    "parent_id": "text",
    "priority": "text",
    "assignee_id": "text"
  }'
201
401
500
{
  "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": {}
}

created

patch

Updates the resource identified by id using data.

Path parameters
idintegerrequired

ID of Experiment to update

Body
namestringrequired
priorityany ofrequired

start_dateany ofrequired

due_dateany ofrequired

assignee_idstringoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/experiments/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "priority": "text",
    "start_date": "text",
    "due_date": "text",
    "assignee_id": "text"
  }'
200
401
404
500
{
  "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": {}
}

success