Sign in

v51

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

Create south item group

Creates a new group for a south connector

post/api/south/{southId}/groups

Path parameters

southIdstring required

Request body

idstring nullable required

The ID of the group (null when creating a new group).

Example request

{
  "standardSettings": {
    "scanModeId": "periodic-5min",
    "name": "Production Line A"
  },
  "historySettings": {
    "readDelay": 200,
    "maxReadInterval": 3600,
    "overlap": 1000
  }
}

Response

Created

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

Example response

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