Events

Lists all the events

get

Lists all the events for the specified date range

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

startstring · date-timeRequired

The inclusive start date

endstring · date-timeRequired

The exclusive end date

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/events

HTTPcURLJavaScriptPython

GET /events?start=2025-12-08T17%3A55%3A47.472Z&end=2025-12-08T17%3A55%3A47.472Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "events": [
    null
  ],
  "range": {
    "localStartDate": "2025-12-08T17:55:47.472Z",
    "localEndDate": "2025-12-08T17:55:47.472Z"
  }
}

Create a new event

post

Creates a new event generating it a unique ID

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Body

application/json

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

typestring · enumRequiredPossible values:

causestringRequired

prioritynumber · enumOptionalDefault: 1Possible values:

startDatestring · date-timeRequired

dueDatestring · date-timeOptional

endDatestring · date-timeOptional

descriptionstringRequired

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

post

/events

HTTPcURLJavaScriptPython

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

{
  "type": "energy",
  "cause": "text",
  "priority": 1,
  "startDate": "2025-12-08T17:55:47.472Z",
  "dueDate": "2025-12-08T17:55:47.472Z",
  "endDate": "2025-12-08T17:55:47.472Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-12-08T17:55:47.472Z",
      "note": "text"
    }
  ]
}

{}

Get event details

get

Gets the details for the specified event

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

eventIdstringRequired

The event ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/events/{eventId}

HTTPcURLJavaScriptPython

GET /events/{eventId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "event": {
    "type": "energy",
    "cause": "text",
    "priority": 1,
    "startDate": "2025-12-08T17:55:47.472Z",
    "dueDate": "2025-12-08T17:55:47.472Z",
    "endDate": "2025-12-08T17:55:47.472Z",
    "description": "text",
    "location": {
      "project": "text",
      "site": "text",
      "system": "text",
      "node": "text",
      "device": "text"
    },
    "notes": [
      {
        "noteDate": "2025-12-08T17:55:47.472Z",
        "note": "text"
      }
    ]
  }
}

Update an existing event

put

Update an existing event

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

eventIdstringRequired

The event ID

Body

application/json

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

typestring · enumRequiredPossible values:

causestringRequired

prioritynumber · enumOptionalDefault: 1Possible values:

startDatestring · date-timeRequired

dueDatestring · date-timeOptional

endDatestring · date-timeOptional

descriptionstringRequired

Responses

200

successful operation

application/json

400

Invalid status value

application/json

put

/events/{eventId}

HTTPcURLJavaScriptPython

PUT /events/{eventId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 333

{
  "type": "energy",
  "cause": "text",
  "priority": 1,
  "startDate": "2025-12-08T17:55:47.472Z",
  "dueDate": "2025-12-08T17:55:47.472Z",
  "endDate": "2025-12-08T17:55:47.472Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-12-08T17:55:47.472Z",
      "note": "text"
    }
  ]
}

{
  "event": {
    "type": "energy",
    "cause": "text",
    "priority": 1,
    "startDate": "2025-12-08T17:55:47.472Z",
    "dueDate": "2025-12-08T17:55:47.472Z",
    "endDate": "2025-12-08T17:55:47.472Z",
    "description": "text",
    "location": {
      "project": "text",
      "site": "text",
      "system": "text",
      "node": "text",
      "device": "text"
    },
    "notes": [
      {
        "noteDate": "2025-12-08T17:55:47.472Z",
        "note": "text"
      }
    ]
  }
}

Deletes an existing event

delete

Deletes an existing event

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

eventIdstringRequired

The event ID

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

delete

/events/{eventId}

HTTPcURLJavaScriptPython

DELETE /events/{eventId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}