v51

OpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-01133591927.1 KB
South Connectors

Search south connector items

Searches for items in a south connector with optional filtering

get/api/south/{southId}/items/search

Path parameters

southIdstring required

Query parameters

namestring required
scanModeIdstring required
enabledboolean required
pagenumber double

Response

Paginated list of items

totalElementsnumber double required

The total number of elements across all pages.

sizenumber double required

The size of the page, i.e., the maximum number of elements per page.

numbernumber double required

The number of the current page, starting at 0.

totalPagesnumber double required

The total number of pages (which can be 0 if there are no elements).

Example response

{
  "content": [
    {
      "id": "entity123",
      "createdBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      },
      "updatedBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      },
      "createdAt": "2023-10-31T12:34:56.789Z",
      "updatedAt": "2023-10-31T12:34:56.789Z",
      "name": "Temperature Logs",
      "enabled": true,
      "scanMode": {
        "id": "entity123",
        "createdBy": {
          "id": "abc123",
          "friendlyName": "John Doe (john.doe)"
        },
        "updatedBy": {
          "id": "abc123",
          "friendlyName": "John Doe (john.doe)"
        },
        "createdAt": "2023-10-31T12:34:56.789Z",
        "updatedAt": "2023-10-31T12:34:56.789Z",
        "name": "Daily Backup Scan",
        "description": "Scans for new backup data every day at midnight",
        "cron": "0 0 * * *"
      },
      "group": {
        "id": "entity123",
        "createdBy": {
          "id": "abc123",
          "friendlyName": "John Doe (john.doe)"
        },
        "updatedBy": {
          "id": "abc123",
          "friendlyName": "John Doe (john.doe)"
        },
        "createdAt": "2023-10-31T12:34:56.789Z",
        "updatedAt": "2023-10-31T12:34:56.789Z",
        "standardSettings": {
          "scanMode": {
            "id": "entity123",
            "createdBy": {
              "id": "abc123",
              "friendlyName": "John Doe (john.doe)"
            },
            "updatedBy": {
              "id": "abc123",
              "friendlyName": "John Doe (john.doe)"
            },
            "createdAt": "2023-10-31T12:34:56.789Z",
            "updatedAt": "2023-10-31T12:34:56.789Z",
            "name": "Daily Backup Scan",
            "description": "Scans for new backup data every day at midnight",
            "cron": "0 0 * * *"
          },
          "name": "Production Line A"
        },
        "historySettings": {
          "readDelay": 200,
          "maxReadInterval": 3600,
          "overlap": 1000
        }
      },
      "syncWithGroup": true,
      "maxReadInterval": 3600,
      "readDelay": 200,
      "overlap": 1000
    }
  ],
  "totalElements": 2,
  "size": 10,
  "totalPages": 1
}