Sign in
Configuration Workflows

Create configuration workflow

Creates a new configuration workflow for a south connector

post/api/south/{southId}/workflows

Path parameters

southIdstring required

Request body

namestring required
discoveryScopeRecordStringUnknown required

Construct a type with a set of properties K of type T

identityKeyFieldsstring[] required

Local mode: at least one field is required. Remote mode (pushToOIAnalytics true): ignored, and stored empty — send [].

itemFieldMappingRecordStringString required

Construct a type with a set of properties K of type T

pushToOIAnalyticsboolean required
scanModeIdstring nullable required

The ID of the scan mode to use for this workflow, or null for manual-only.

enabledboolean required

Example request

{
  "identityKeyFields": [
    "nodeId"
  ],
  "eligibilityFilter": [
    {
      "field": "type",
      "operator": "equals",
      "value": "Variable"
    }
  ]
}

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.

namestring required

Unique per south connector.

southIdstring required

The south connector this workflow discovers from.

discoveryScopeRecordStringUnknown required

Construct a type with a set of properties K of type T

identityKeyFieldsstring[] required

Local mode only: discovered-record field(s) — possibly composite — that uniquely identify a record across re-runs. Always empty for a remote workflow (pushToOIAnalytics true), which never diffs against a previous run.

itemFieldMappingRecordStringString required

Construct a type with a set of properties K of type T

pushToOIAnalyticsboolean required

Remote mode: forward every run's raw eligible records to OIAnalytics as-is (no mapping, no local item, no per-record diffing) instead of creating/updating items locally. Requires OIBus to be registered with OIAnalytics.

enabledboolean required

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",
  "name": "Reactor OPC-UA discovery",
  "southId": "b7f8e6d2-1c3a-4b5d-9e0f-2a3b4c5d6e7f",
  "identityKeyFields": [
    "nodeId"
  ],
  "eligibilityFilter": [
    {
      "field": "type",
      "operator": "equals",
      "value": "Variable"
    }
  ],
  "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"
        }
      }
    }
  }
}

Changes

Changed in 9 of the 241 revisions of this API.45