API Documentation
  • API Documentation
  • Ecosuite Project Data API
    • Authentication
    • OpenAPI reference
      • Events
        • Resolve
      • Feedback
      • Profile
      • Portfolios
      • Projects
        • Contacts
        • Pro forma
          • Versions
        • I2x
        • Records
        • Sites
          • Records
          • Systems
            • Records
        • Record documents
      • Record documents
      • Records
        • Record documents
      • Service requests
        • Generate
        • Resolve
      • Tariff
      • User groups
      • Users
        • Alerts
        • Groups
          • Reset
        • Mfa
        • Notifications
        • Resend
      • User types
      • Audit
        • Assets
        • Projects
        • Users
      • Coda
        • Milestones
        • Import
      • Connectivity
        • Data
        • Devices
      • Dashboard
        • Status
      • Energy
        • Datums
          • Most recent
          • Projects
          • Consumption
            • Cost
              • Projects
            • Predicted
              • Projects
            • Projects
          • Cumulative
            • Projects
          • Generation
            • Expected
            • Predicted
              • Projects
          • Nodes
            • Projects
        • Export
        • Instantaneous
        • Readings
        • Status
      • Finance
        • Cashflow totals
        • Report
        • Transactions
        • Sources uses
          • Sources uses
        • Export
          • Report
        • Projects
          • Billing
          • CashFlowTimeSeriesArrears
          • Categories
          • Irr categories
          • Report
          • Settings
          • Sources uses
          • Import
          • Cash flows
            • Payment logs
          • Pro forma
            • Irr
        • Record
          • Payments
        • Softledger
          • Locations
      • Media
        • Files
        • Tags
          • Storage
            • Code
            • Labels
          • Default
        • Storage
          • File
          • Code
      • Public
        • Projects
        • Energy
          • Datums
            • Projects
          • Readings
            • Projects
      • Schemas
        • Rfi
        • RfiReply
        • Dr event
        • Dr notification
        • Event
        • Participant
        • Finance
        • Notification
        • Portfolio
        • Pro forma
        • Profile
        • Project
        • Record
        • Service request
        • Site
        • System
        • User
        • User type
        • User groups
        • New tariff
        • Tariff
      • Rfi
        • Thread
          • Code
          • Resolve
          • Version
          • Replies
        • Reply
          • Version
      • Search
        • Refinements
      • Solarnetwork
        • Devices
        • Instruction
        • Nodes
        • Ssh
        • Credentials
          • Solarflux
          • Solarnode
          • Ssh
        • Metadata
          • Projects
        • Settings
          • Node ids
        • Solarnode
          • Login url
      • Tools
        • Address business details
      • Dr
        • Participants
        • Dr events
        • Dr notifications
      • Report
        • Operating
          • Project
      • Weather
        • Datums
          • Projects
        • Daylight
          • Projects
            • Sites
        • Projects
          • Sites
    • OpenAPI Specification
  • Ecosuite Time Series Data API
Powered by GitBook
On this page
  1. Ecosuite Project Data API
  2. OpenAPI reference

Portfolios

PreviousProfileNextProjects

Get Portfolio details

get

Gets the details for the specified Portfolio

Authorizations
Path parameters
portfolioIdstringRequired

The Portfolio ID

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

{
  "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
Responseobject
delete
DELETE //portfolios/{portfolioId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}
  • GETList the available portfolios
  • POSTCreate a new Portfolio
  • GETGet Portfolio details
  • PUTUpdate an existing Portfolio
  • DELETEDeletes an existing Portfolio

List the available portfolios

get

List the available portfolios

Authorizations
Responses
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
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
    }
  }
}

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
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
    }
  }
}