Experiments | Colabra REST API

Creates a new resource with data.

POST/experiments

Body

name*string

project_id*string

parent_idany of

priority*any of

assignee_idstring

Response

created

Body

id*string

name*string

project_id*string

parent_idany of

priority*any of

created_at*string

updated_at*string

start_date*any of

due_date*any of

status*any of

author*any of

assignee*any of

signatures*array of object

custom_propertiesobject

Request

const response = await fetch('/experiments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "project_id": "text",
      "priority": "text"
    }),
});
const data = await response.json();

Response

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

Retrieves a list of all resources from the service.

GET/experiments

Query parameters

Response

success

Body

totalinteger

limitinteger

skipinteger

dataExperimentList (array of Experiment (object))

Request

const response = await fetch('/experiments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GET/experiments/{id}

Path parameters

id*integer

ID of Experiment to return

Response

success

Body

id*string

name*string

project_id*string

parent_idany of

priority*any of

created_at*string

updated_at*string

start_date*any of

due_date*any of

status*any of

author*any of

assignee*any of

signatures*array of object

custom_propertiesobject

Request

const response = await fetch('/experiments/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Updates the resource identified by id using data.

PATCH/experiments/{id}

Path parameters

id*integer

ID of Experiment to update

Body

name*string

priority*any of

start_date*any of

due_date*any of

assignee_idstring

Response

success

Body

id*string

name*string

project_id*string

parent_idany of

priority*any of

created_at*string

updated_at*string

start_date*any of

due_date*any of

status*any of

author*any of

assignee*any of

signatures*array of object

custom_propertiesobject

Request

const response = await fetch('/experiments/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "priority": "text",
      "start_date": "text",
      "due_date": "text"
    }),
});
const data = await response.json();

Response

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

Removes the resource with id.

DELETE/experiments/{id}

Path parameters

id*integer

ID of Experiment to remove

Response

success

Body

id*string

name*string

project_id*string

parent_idany of

priority*any of

created_at*string

updated_at*string

start_date*any of

due_date*any of

status*any of

author*any of

assignee*any of

signatures*array of object

custom_propertiesobject

Request

const response = await fetch('/experiments/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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