Portfolios

List the available portfolios

get

List the available portfolios

Authorizations
Responses
200

successful operation

application/json
get
GET //portfolios HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "portfolios": [
    null,
    null
  ]
}

Create a new Portfolio

post

Create a new Portfolio and generate a unique ID

Authorizations
Body

Refer to the /schemas/portfolio endpoint for the full JSON Schema definition

namestringRequired
projectsstring[] · min: 1Required
Responses
200

successful operation

application/json
post
POST //portfolios HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

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

Get Portfolio details

get

Gets the details for the specified Portfolio

Authorizations
Path parameters
portfolioIdstringRequired

The Portfolio ID

Responses
200

successful operation

application/json
get
GET //portfolios/{portfolioId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

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

Update an existing Portfolio

put

Update an existing Portfolio

Authorizations
Path parameters
portfolioIdstringRequired

The Portfolio ID

Body

Refer to the /schemas/portfolio endpoint for the full JSON Schema definition

namestringRequired
projectsstring[] · min: 1Required
Responses
200

successful operation

application/json
put
PUT //portfolios/{portfolioId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

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

Deletes an existing Portfolio

delete

Deletes an existing Portfolio

Authorizations
Path parameters
portfolioIdstringRequired

The Portfolio ID

Responses
200

successful operation

application/json
Responseobject
delete
DELETE //portfolios/{portfolioId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}
PreviousProfileNextProjects