South Connectors

Create south item group

Changed on

Creates a new group for a south connector

post/api/south/{southId}/groups

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/south/{southId}/groups
  • Auth: none required

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,
    "startTimeOffset": -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 * * *",
      "interval": {
        "value": 30
      },
      "activationWindow": {
        "dateRange": {
          "start": "2023-10-31T12:34:56.789Z",
          "end": "2023-10-31T12:34:56.789Z"
        },
        "recurring": {
          "timezone": "Europe/Paris",
          "daysOfWeek": [
            6,
            0
          ],
          "timeOfDay": {
            "start": "12:34:56",
            "end": "12:34:56"
          }
        }
      }
    },
    "name": "Production Line A"
  },
  "historySettings": {
    "readDelay": 200,
    "maxReadInterval": 3600,
    "startTimeOffset": -1000
  }
}

Changes

  • 0df3f625a5c2Revision changes
    • breaking

      added the new required request property /

    • info

      added the required property / to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 21b34a490fa3Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the request property /