Projects

Creates a project in the workspace linked to the current API Key

POST/projects

Body

application/json

nameany of

stringnull

Response

201401500

created

Body

application/json

id*string

nameany of

stringnull

status*object

updated_at*string

created_at*string

author*any of

objectnull

owner*any of

objectnull

Request

JavaScriptCurlPython

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

Response

201

{
  "id": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "updated_at": "text",
  "created_at": "text",
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

Retrieves a list of all resources from the service.

GET/projects

Query parameters

Response

200401500

success

Body

application/json

totalinteger

limitinteger

skipinteger

dataProjectList (array of Project (object))

Request

JavaScriptCurlPython

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

Response

200

{
  "total": 0,
  "limit": 0,
  "skip": 0,
  "data": [
    {
      "id": "text",
      "name": "text",
      "status": {
        "name": "text",
        "stage": "text"
      },
      "updated_at": "text",
      "created_at": "text",
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "owner": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      }
    }
  ]
}

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

GET/projects/{id}

Path parameters

id*integer

ID of Project to return

Response

200401404500

success

Body

application/json

id*string

nameany of

stringnull

status*object

updated_at*string

created_at*string

author*any of

objectnull

owner*any of

objectnull

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "updated_at": "text",
  "created_at": "text",
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

Updates the resource identified by id using data.

PATCH/projects/{id}

Path parameters

id*integer

ID of Project to update

Body

application/json

idstring

nameany of

stringnull

statusobject

updated_atstring

created_atstring

authorany of

objectnull

ownerany of

objectnull

Response

200401404500

success

Body

application/json

id*string

nameany of

stringnull

status*object

updated_at*string

created_at*string

author*any of

objectnull

owner*any of

objectnull

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "updated_at": "text",
  "created_at": "text",
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

Removes the resource with id.

DELETE/projects/{id}

Path parameters

id*integer

ID of Project to remove

Response

200401404500

success

Body

application/json

id*string

nameany of

stringnull

status*object

updated_at*string

created_at*string

author*any of

objectnull

owner*any of

objectnull

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "updated_at": "text",
  "created_at": "text",
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}