Portfolios

List the available portfolios

List the available portfolios

get

/portfolios

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.ecosuite.io//portfolios' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

{
  "portfolios": [
    null,
    null
  ]
}

successful operation

Create a new Portfolio

Create a new Portfolio and generate a unique ID

post

/portfolios

Authorizations

Body

nameNamerequired

projectsProjectsrequired

reportsReports

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//portfolios' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","projects":[null],"reports":{}}'

200

400

200

{
  "portfolio": {
    "name": "text",
    "projects": [
      "text"
    ],
    "reports": {}
  }
}

successful operation

Get Portfolio details

Gets the details for the specified Portfolio

get

/portfolios/{portfolioId}

Authorizations

Path parameters

portfolioIdstringrequired

The Portfolio ID

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.ecosuite.io//portfolios/{portfolioId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

{
  "portfolio": {
    "name": "text",
    "projects": [
      "text"
    ],
    "reports": {}
  }
}

successful operation

Update an existing Portfolio

Update an existing Portfolio

put

/portfolios/{portfolioId}

Authorizations

Path parameters

portfolioIdstringrequired

The Portfolio ID

Body

nameNamerequired

projectsProjectsrequired

reportsReports

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//portfolios/{portfolioId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","projects":[null],"reports":{}}'

200

400

200

{
  "portfolio": {
    "name": "text",
    "projects": [
      "text"
    ],
    "reports": {}
  }
}

successful operation

Deletes an existing Portfolio

Deletes an existing Portfolio

delete

/portfolios/{portfolioId}

Authorizations

Path parameters

portfolioIdstringrequired

The Portfolio ID

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.ecosuite.io//portfolios/{portfolioId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

{}

successful operation