South Connectors

Get south item group

Changed on

Gets a specific group by ID

get/api/south/{southId}/groups/{groupId}

Request

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

Path parameters

southIdstring required
groupIdstring required

Response

The group object

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

    • 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

    • 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