Data Transfer Controller

get
Authorizations
Path parameters
dataTransferIdstringRequired
Responses
200
OK
*/*
get
GET /api/datatransfer/{dataTransferId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:30:45.800Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:30:45.800Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "dsc": "text",
  "period": 1,
  "owner": "text"
}
put
Authorizations
Path parameters
dataTransferIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
projectIdstringOptional
namestring · max: 100Required
dscstring · max: 255Optional
periodinteger · int32 · min: 1000Required
ownerstringOptional
Responses
204
No Content
put
PUT /api/datatransfer/{dataTransferId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "id": "text",
  "projectId": "text",
  "name": "text",
  "dsc": "text",
  "period": 1,
  "owner": "text"
}
No content
delete
Authorizations
Path parameters
dataTransferIdstringRequired
Responses
204
No Content
delete
DELETE /api/datatransfer/{dataTransferId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
dataTransferIdstringRequired
detailIdstringRequired
Responses
200
OK
*/*
get
GET /api/datatransfer/{dataTransferId}/details/{detailId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:30:45.800Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:30:45.800Z",
  "id": "text",
  "rangeType": "Current Hour",
  "calcType": "Min",
  "sourceVariable": {
    "creationDate": "2025-07-05T19:30:45.800Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:30:45.800Z",
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "threshold": 1,
  "targetVariable": {
    "creationDate": "2025-07-05T19:30:45.800Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:30:45.800Z",
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "sourceVariableId": "text",
  "dataTransferId": "text",
  "targetVariableId": "text"
}
put
Authorizations
Path parameters
dataTransferIdstringRequired
detailIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
rangeTypestring · enumOptionalPossible values:
calcTypestring · enumOptionalPossible values:
thresholdnumber · doubleOptional
sourceVariableIdstringRequired
dataTransferIdstringOptional
targetVariableIdstringRequired
Responses
204
No Content
put
PUT /api/datatransfer/{dataTransferId}/details/{detailId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 1387

{
  "id": "text",
  "rangeType": "Current Hour",
  "calcType": "Min",
  "sourceVariable": {
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "threshold": 1,
  "targetVariable": {
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "sourceVariableId": "text",
  "dataTransferId": "text",
  "targetVariableId": "text"
}
No content
delete
Authorizations
Path parameters
dataTransferIdstringRequired
detailIdstringRequired
Responses
204
No Content
delete
DELETE /api/datatransfer/{dataTransferId}/details/{detailId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Query parameters
projectIdstringOptional
Responses
200
OK
*/*
get
GET /api/datatransfer HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:30:45.800Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:30:45.800Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "dsc": "text",
    "period": 1,
    "owner": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
projectIdstringOptional
namestring · max: 100Required
dscstring · max: 255Optional
periodinteger · int32 · min: 1000Required
ownerstringOptional
Responses
200
OK
*/*
post
POST /api/datatransfer HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "id": "text",
  "projectId": "text",
  "name": "text",
  "dsc": "text",
  "period": 1,
  "owner": "text"
}
{
  "creationDate": "2025-07-05T19:30:45.800Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:30:45.800Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "dsc": "text",
  "period": 1,
  "owner": "text"
}
post
Authorizations
Path parameters
dataTransferIdstringRequired
Responses
204
No Content
post
POST /api/datatransfer/{dataTransferId}/schedule HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
dataTransferIdstringRequired
Responses
200
OK
*/*
get
GET /api/datatransfer/{dataTransferId}/details HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:30:45.800Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:30:45.800Z",
    "id": "text",
    "rangeType": "Current Hour",
    "calcType": "Min",
    "sourceVariable": {
      "creationDate": "2025-07-05T19:30:45.800Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:30:45.800Z",
      "id": "text",
      "keepLastValues": true,
      "unit": "text",
      "engZeroScale": 1,
      "fractionalDigitCount": 1,
      "name": "text",
      "logExpressionId": "text",
      "logType": "No Log",
      "logExpressionCode": "text",
      "valueExpressionCode": "text",
      "valueExpressionId": "text",
      "isPulseOff": true,
      "frameId": "text",
      "setMinValue": 1,
      "pulseOffDuration": 1,
      "code": "text",
      "engFullScale": 1,
      "pulseOnDuration": 1,
      "logThreshold": 1,
      "rawFullScale": 1,
      "isPulseOn": true,
      "valueExpressionType": "NONE",
      "logMaxValue": 1,
      "setMaxValue": 1,
      "logMinValue": 1,
      "isActive": true,
      "projectId": "text",
      "rawZeroScale": 1,
      "logPeriod": 1,
      "dsc": "text",
      "connectionId": "text",
      "deviceId": "text"
    },
    "threshold": 1,
    "targetVariable": {
      "creationDate": "2025-07-05T19:30:45.800Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:30:45.800Z",
      "id": "text",
      "keepLastValues": true,
      "unit": "text",
      "engZeroScale": 1,
      "fractionalDigitCount": 1,
      "name": "text",
      "logExpressionId": "text",
      "logType": "No Log",
      "logExpressionCode": "text",
      "valueExpressionCode": "text",
      "valueExpressionId": "text",
      "isPulseOff": true,
      "frameId": "text",
      "setMinValue": 1,
      "pulseOffDuration": 1,
      "code": "text",
      "engFullScale": 1,
      "pulseOnDuration": 1,
      "logThreshold": 1,
      "rawFullScale": 1,
      "isPulseOn": true,
      "valueExpressionType": "NONE",
      "logMaxValue": 1,
      "setMaxValue": 1,
      "logMinValue": 1,
      "isActive": true,
      "projectId": "text",
      "rawZeroScale": 1,
      "logPeriod": 1,
      "dsc": "text",
      "connectionId": "text",
      "deviceId": "text"
    },
    "sourceVariableId": "text",
    "dataTransferId": "text",
    "targetVariableId": "text"
  }
]
post
Authorizations
Path parameters
dataTransferIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
rangeTypestring · enumOptionalPossible values:
calcTypestring · enumOptionalPossible values:
thresholdnumber · doubleOptional
sourceVariableIdstringRequired
dataTransferIdstringOptional
targetVariableIdstringRequired
Responses
200
OK
*/*
post
POST /api/datatransfer/{dataTransferId}/details HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 1387

{
  "id": "text",
  "rangeType": "Current Hour",
  "calcType": "Min",
  "sourceVariable": {
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "threshold": 1,
  "targetVariable": {
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "sourceVariableId": "text",
  "dataTransferId": "text",
  "targetVariableId": "text"
}
{
  "creationDate": "2025-07-05T19:30:45.800Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:30:45.800Z",
  "id": "text",
  "rangeType": "Current Hour",
  "calcType": "Min",
  "sourceVariable": {
    "creationDate": "2025-07-05T19:30:45.800Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:30:45.800Z",
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "threshold": 1,
  "targetVariable": {
    "creationDate": "2025-07-05T19:30:45.800Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:30:45.800Z",
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "connectionId": "text",
    "deviceId": "text"
  },
  "sourceVariableId": "text",
  "dataTransferId": "text",
  "targetVariableId": "text"
}
post
Authorizations
Path parameters
dataTransferIdstringRequired
Responses
204
No Content
post
POST /api/datatransfer/{dataTransferId}/cancel HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204
No Content
post
POST /api/datatransfer/schedule/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
post
POST /api/datatransfer/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204
No Content
post
POST /api/datatransfer/cancel/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
dataTransferIdstringRequired
Responses
200
OK
*/*
Responsestring · enumPossible values:
get
GET /api/datatransfer/{dataTransferId}/status HTTP/1.1
Host: inscada.cloud
Accept: */*

Scheduled
get
Authorizations
Query parameters
dataTransferIdsstring[]Required
Responses
200
OK
*/*
get
GET /api/datatransfer/status/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Scheduled"
}
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200
OK
*/*
Responseobject
get
GET /api/datatransfer/export HTTP/1.1
Host: inscada.cloud
Accept: */*

{}
delete
Authorizations
Query parameters
dataTransferIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/datatransfer/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
delete
Authorizations
Query parameters
dataTransferDetailIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/datatransfer/details/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
PreviousDigital Alarm ControllerNextDashboard Controller