Projects

All API Operations related with projects

READ Scope

List all Projects

Retrieves all the projects

GEThttps://api.nuvio.io/v1/project

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataarray of Projects

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/project', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "budget": 0,
      "startDate": "text",
      "endDate": "text",
      "code": "text"
    }
  ]
}

Get a Project by ID

Retrieves a single product or service by its unique ID or user-generated project code.

GEThttps://api.nuvio.io/v1/project/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataProject

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/project/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "budget": 0,
    "startDate": "text",
    "endDate": "text",
    "code": "text"
  }
}

WRITE Scope

Create a new Project

Creates a new project

POSThttps://api.nuvio.io/v1/project

Body

application/jsontext/jsonapplication/*+json

name*string

Name of the project

startDatestring

Starting date of the project. Should be in YYYY-MM-DD format

endDatestring

Ending date of the project. Should be in YYYY-MM-DD format

projectCodestring

Name of the project

budgetnullable number (double)

Total budget of the project.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataProject

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/project', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "budget": 0,
    "startDate": "text",
    "endDate": "text"
  }
}

UPDATE Scope

Update Project

Updates an existing project

PUThttps://api.nuvio.io/v1/project/{id}

Path parameters

id*string (uuid)

Body

application/jsontext/jsonapplication/*+json

namestring

Name of the project

startDatestring

Starting date of the project. Should be in YYYY-MM-DD format

endDatestring

Ending date of the project. Should be in YYYY-MM-DD format

projectCodestring

Name of the project

budgetnullable number (double)

Total budget of the project.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataProject

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/project/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "budget": 0,
    "startDate": "text",
    "endDate": "text"
  }
}