Events

Lists all the events

get

Lists all the events for the specified date range

Authorizations
Query parameters
startstring · date-timeRequired

The inclusive start date

endstring · date-timeRequired

The exclusive end date

Responses
200

successful operation

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

{
  "events": [
    null
  ],
  "range": {
    "localStartDate": "2025-08-31T00:47:57.775Z",
    "localEndDate": "2025-08-31T00:47:57.775Z"
  }
}

Create a new event

post

Creates a new event generating it a unique ID

Authorizations
Body

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
post
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-08-31T00:47:57.775Z",
  "dueDate": "2025-08-31T00:47:57.775Z",
  "endDate": "2025-08-31T00:47:57.775Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-08-31T00:47:57.775Z",
      "note": "text"
    }
  ]
}
{}

Get event details

get

Gets the details for the specified event

Authorizations
Path parameters
eventIdstringRequired

The event ID

Responses
200

successful operation

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

{
  "event": {
    "type": "energy",
    "cause": "text",
    "priority": 1,
    "startDate": "2025-08-31T00:47:57.775Z",
    "dueDate": "2025-08-31T00:47:57.775Z",
    "endDate": "2025-08-31T00:47:57.775Z",
    "description": "text",
    "location": {
      "project": "text",
      "site": "text",
      "system": "text",
      "node": "text",
      "device": "text"
    },
    "notes": [
      {
        "noteDate": "2025-08-31T00:47:57.775Z",
        "note": "text"
      }
    ]
  }
}

Update an existing event

put

Update an existing event

Authorizations
Path parameters
eventIdstringRequired

The event ID

Body

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
put
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-08-31T00:47:57.775Z",
  "dueDate": "2025-08-31T00:47:57.775Z",
  "endDate": "2025-08-31T00:47:57.775Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-08-31T00:47:57.775Z",
      "note": "text"
    }
  ]
}
{
  "event": {
    "type": "energy",
    "cause": "text",
    "priority": 1,
    "startDate": "2025-08-31T00:47:57.775Z",
    "dueDate": "2025-08-31T00:47:57.775Z",
    "endDate": "2025-08-31T00:47:57.775Z",
    "description": "text",
    "location": {
      "project": "text",
      "site": "text",
      "system": "text",
      "node": "text",
      "device": "text"
    },
    "notes": [
      {
        "noteDate": "2025-08-31T00:47:57.775Z",
        "note": "text"
      }
    ]
  }
}

Deletes an existing event

delete

Deletes an existing event

Authorizations
Path parameters
eventIdstringRequired

The event ID

Responses
200

successful operation

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

{}
PreviousOpenAPI referenceNextResolve