GET /api/external/v3/notes/{key}

Retrieves all published notes associated with the specified space and its underlying objects.

Request Information

Permissions

The user must be authorized and must have at least one of these operations to access this api method.

Operation (significant name)	Description
Access external API (acc_extapi)	Gives the user access to the external API.

Embeded Resource Parameters

None

URI Parameters

Name	Description	Type	Additional information
key	Identifier of the desired space.	string	Required

Body Parameters

None.

Response Information

Resource Description

A list of published note data if any, otherwise an empty list.

DataResultOfExtendedNoteDto

Name	Type	Additional information
Data	Collection of ExtendedNoteDto	None.
Total	integer	None.
Take	integer	None.
Skip	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "spaceId": 1,
      "spaceName": "sample string 2",
      "spaceNo": "sample string 3",
      "spaceSynchronizationKey": "sample string 4",
      "facilityId": 5,
      "facilityName": "sample string 6",
      "facilityNo": "sample string 7",
      "facilitySynchronizationKey": "sample string 8",
      "meterId": 9,
      "meterName": "sample string 10",
      "meterNo": "sample string 11",
      "meterSynchronizationKey": "sample string 12",
      "noteId": 13,
      "noteType": 14,
      "noteTitle": "sample string 15",
      "noteText": "sample string 16",
      "publishFromDt": "2025-04-26T14:02:31.2378922+02:00",
      "publishToDt": "2025-04-26T14:02:31.2378922+02:00",
      "createDateTime": "2025-04-26T14:02:31.2378922+02:00",
      "changeDateTime": "2025-04-26T14:02:31.2378922+02:00"
    },
    {
      "spaceId": 1,
      "spaceName": "sample string 2",
      "spaceNo": "sample string 3",
      "spaceSynchronizationKey": "sample string 4",
      "facilityId": 5,
      "facilityName": "sample string 6",
      "facilityNo": "sample string 7",
      "facilitySynchronizationKey": "sample string 8",
      "meterId": 9,
      "meterName": "sample string 10",
      "meterNo": "sample string 11",
      "meterSynchronizationKey": "sample string 12",
      "noteId": 13,
      "noteType": 14,
      "noteTitle": "sample string 15",
      "noteText": "sample string 16",
      "publishFromDt": "2025-04-26T14:02:31.2378922+02:00",
      "publishToDt": "2025-04-26T14:02:31.2378922+02:00",
      "createDateTime": "2025-04-26T14:02:31.2378922+02:00",
      "changeDateTime": "2025-04-26T14:02:31.2378922+02:00"
    }
  ],
  "total": 1,
  "take": 2,
  "skip": 3
}