PUT api/Programs/Groups/DisableValidation/{id}?subLevels={subLevels}
Disables Validation at the Group level
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the Group |
integer |
Required |
| subLevels |
Number of levels below the Program to load (i.e. Groups, Steps), with a default value of -1 (all sublevels) |
integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
object
GetProgramsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Programs |
Array of Programs |
Collection of ProgramParent |
None. |
| Messages |
Array of messages |
Collection of Message |
None. |
| ServerInformation |
Relevant information regarding the Server |
ServerInformation |
None. |
| VersionInformation |
Relevant information regarding the API's version |
VersionInformation |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"Programs": [
{
"ID": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"ContainsValidation": true,
"ValidationEnable": true,
"OwnerID": 1,
"OwnerType": 10,
"Settings": {
"AutoCancel": true,
"CommandRetryLimit": 1,
"ResendOnError": true,
"ResendOnErrorLimit": 1,
"AllowStartDateAdjustment": true,
"SendPeriod": "00:00:00.1234567"
},
"StartConditions": [
{
"ID": 1,
"Name": "sample string 2"
},
{
"ID": 1,
"Name": "sample string 2"
}
],
"Groups": [
{
"ID": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroupID": 1,
"DisplayIndex": 1,
"AutoSkip": true,
"ContainsValidation": true,
"ValidationEnable": true,
"Offset": "00:00:00.1234567",
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"OwnerID": 1,
"OwnerType": 10,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"TotalRunTime": "00:00:00.1234567",
"Steps": [
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
},
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
}
]
},
{
"ID": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroupID": 1,
"DisplayIndex": 1,
"AutoSkip": true,
"ContainsValidation": true,
"ValidationEnable": true,
"Offset": "00:00:00.1234567",
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"OwnerID": 1,
"OwnerType": 10,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"TotalRunTime": "00:00:00.1234567",
"Steps": [
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
},
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
}
]
}
]
},
{
"ID": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"ContainsValidation": true,
"ValidationEnable": true,
"OwnerID": 1,
"OwnerType": 10,
"Settings": {
"AutoCancel": true,
"CommandRetryLimit": 1,
"ResendOnError": true,
"ResendOnErrorLimit": 1,
"AllowStartDateAdjustment": true,
"SendPeriod": "00:00:00.1234567"
},
"StartConditions": [
{
"ID": 1,
"Name": "sample string 2"
},
{
"ID": 1,
"Name": "sample string 2"
}
],
"Groups": [
{
"ID": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroupID": 1,
"DisplayIndex": 1,
"AutoSkip": true,
"ContainsValidation": true,
"ValidationEnable": true,
"Offset": "00:00:00.1234567",
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"OwnerID": 1,
"OwnerType": 10,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"TotalRunTime": "00:00:00.1234567",
"Steps": [
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
},
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
}
]
},
{
"ID": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroupID": 1,
"DisplayIndex": 1,
"AutoSkip": true,
"ContainsValidation": true,
"ValidationEnable": true,
"Offset": "00:00:00.1234567",
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"OwnerID": 1,
"OwnerType": 10,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"TotalRunTime": "00:00:00.1234567",
"Steps": [
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
},
{
"ID": 1,
"GroupID": 1,
"Description": "sample string 1",
"Type": 0,
"DisplayIndex": 1,
"AutoSkip": true,
"LinkID": 1,
"LinkObjectType": 0,
"LinkType": 0,
"DeviceID": 1,
"DeviceName": "sample string 2",
"SetValue": 1.0,
"ReturnValue": 1.0,
"StartDate": "2025-11-09T21:42:37.3511897+10:00",
"FinishDate": "2025-11-09T21:42:37.3511897+10:00",
"StartOffset": "00:00:00.1234567",
"FinishOffset": "00:00:00.1234567",
"Offset": "00:00:00.1234567",
"Duration": "00:00:00.1234567",
"LinkedDeviceID": 1,
"LinkedDeviceName": "sample string 3",
"LinkCutoffValue": 1.0,
"BatchTotalised": true,
"ContainsValidation": true,
"ValidationBeforeSpan": "00:00:00.1234567",
"ValidationBeforeLimit": 1,
"ValidationBeforeEnable": true,
"ValidationBeforeID": 1,
"ValidationBeforeName": "sample string 4",
"ValidationDuringSpan": "00:00:00.1234567",
"ValidationDuringLimit": 1,
"ValidationDuringEnable": true,
"ValidationDuringID": 1,
"ValidationDuringName": "sample string 5",
"ValidationAfterSpan": "00:00:00.1234567",
"ValidationAfterLimit": 1,
"ValidationAfterEnable": true,
"ValidationAfterID": 1,
"ValidationAfterName": "sample string 6"
}
]
}
]
}
],
"Messages": [
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
},
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
}
],
"ServerInformation": {
"CurrentTimeUTC": "2025-11-09T21:42:37.3511897+10:00",
"BuildDateUTC": "2025-11-09T21:42:37.3511897+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
}
}