South Connectors

Get south item group

Gets a specific group by ID

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

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 * * *"
    },
    "name": "Production Line A"
  },
  "historySettings": {
    "readDelay": 200,
    "maxReadInterval": 3600,
    "startTimeOffset": -1000
  }
}

Changes

Changed in 28 of the 74 revisions of this API.331049

  • 9a6250881fa713See the full diff
    • removed the required property historySettings/overlap from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/endTimeOffset to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/recoveryStrategy to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/startTimeOffset to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ea1c80cb9c6931See the full diff
    • removed the required property historySettings/endTimeOffset from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/recoveryStrategy from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/startTimeOffset from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/overlap to the response with the 200 status

      response-required-property-added

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6a232346b15813See the full diff
    • removed the required property historySettings/overlap from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/endTimeOffset to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/recoveryStrategy to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/startTimeOffset to the response with the 200 status

      response-required-property-added

  • 57cbe043ec5a31See the full diff
    • removed the required property historySettings/endTimeOffset from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/recoveryStrategy from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/startTimeOffset from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/overlap to the response with the 200 status

      response-required-property-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the required property historySettings/overlap from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/endTimeOffset to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/recoveryStrategy to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/startTimeOffset to the response with the 200 status

      response-required-property-added

    • removed the required property historySettings/endTimeOffset from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/recoveryStrategy from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/startTimeOffset from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/overlap to the response with the 200 status

      response-required-property-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c5a35475739f12See the full diff
    • removed the required property historySettings/overlap from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/endTimeOffset to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/startTimeOffset to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/recoveryStrategy to the response with the 200 status

      response-required-property-added

  • 2c78cb2da64731See the full diff
    • removed the required property historySettings/endTimeOffset from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/recoveryStrategy from the response with the 200 status

      response-required-property-removed

    • removed the required property historySettings/startTimeOffset from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/overlap to the response with the 200 status

      response-required-property-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9eab61b4f34912See the full diff
    • removed the required property historySettings/overlap from the response with the 200 status

      response-required-property-removed

    • added the required property historySettings/endTimeOffset to the response with the 200 status

      response-required-property-added

    • added the required property historySettings/startTimeOffset to the response with the 200 status

      response-required-property-added