POST api/v1/points/{pointTag}/config
Updates a point configuration record
CygNet Access Requirements
CygNet ACS security: BRDGAPI ACCESS 3
CygNet Bridge API license type: Base
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pointTag |
CygNet point tag |
string |
Required |
Body Parameters
Request object for updating a point configuration record
| Name | Description | Type | Additional information |
|---|---|---|---|
| pointConfig |
Single Point Configuration Record DTO |
PointConfigRecordDTO |
None |
Request Formats
application/json, text/json
Sample:
{
"pointConfig": {
"pointTag": "BRIDGECP.UIS.00004812:ANTIER_WL_PRTUBXIN:ANTIER_WL.PRTUBXIN",
"isActive": true,
"pointVersion": "2018-08-07T11:37:03.095-07:00",
"description": "Tubing Pressure",
"longDescription": "Tubing Pressure",
"pointScheme": 1,
"pointDataType": "AI",
"primaryUnits": "psi",
"alternateUnits": "bar",
"systemName": "N/A",
"displayAttribute": "",
"securityApp": "",
"initialType": "Restore",
"initialValue": "",
"allowedUpdates": "All",
"manualInputEnabled": false,
"suppressAlarms": false,
"suppressAlarmsEndsOnNormal": false,
"suppressAlarmsEndsOnDateTime": "0001-01-01T00:00:00",
"alarmCategory": "GC",
"anyConfigBitEnabled": true,
"anyConfigBitReportingCAS": true,
"anyConfigBitReportingGNS": false,
"anyConfigBitHasGNSId": false,
"anyConfigBitHasReportingDelay": false,
"reportDelayUnits": "Seconds",
"reportVHS": true,
"historyOnLineDays": 30,
"forceHistoryOnUpdate": true,
"forceHistory": "Disabled",
"forcePeriod": "00:00:00",
"minimumEvaluationTime": "00:00:00",
"compressionType": "None",
"alarmDeadBand": 0.0,
"historyDeadBand": 0.0,
"maxSetPoint": 0.0,
"minSetPoint": 0.0,
"scaleValue": false,
"scaleCoefficientA0": 0.0,
"scaleCoefficientA1": 1.0,
"scaleCoefficientA2": 0.0,
"scaleCoefficientA3": 0.0,
"scaleCoefficientA4": 0.0,
"scaleCoefficientA5": 0.0,
"twoPointScale": true,
"rawLow": 0.0,
"rawHigh": 1.0,
"engineeringLow": 0.0,
"engineeringHigh": 1.0,
"useDecimalPlaces": false,
"decimalPlaces": 2,
"digitalOnString": "SET",
"digitalOffString": "NOT SET",
"enumTableName": "",
"pointReferenceType": "",
"referenceSite": "",
"referenceService": "",
"referencePointId": "",
"referencePointIdLong": "",
"anyVerifiedFlag": false,
"verifiedFlag1": false,
"verifiedFlag2": false,
"verifiedFlag3": false,
"verifiedFlag4": false,
"verifiedTimestamp": "0001-01-01T00:00:00",
"questionableFlag": false,
"questionableTimestamp": "0001-01-01T00:00:00",
"anyUserFlag": true,
"userFlag1": true,
"userFlag2": false,
"userFlag3": false,
"userFlag4": false,
"userFlag5": false,
"userFlag6": false,
"userFlag7": false,
"userFlag8": false,
"indexed1": "",
"indexed2": "",
"indexed3": "",
"tableDriven1": "",
"tableDriven2": "",
"tableDriven3": "",
"general1": "",
"general2": "",
"general3": "",
"externalIdType": "",
"externalId": "",
"comment": "",
"hasEnhancedAlarmConfig": false,
"hasEnhancedAlmarmConfigError": false,
"hyperPointEnabled": false,
"scriptEnabled": false,
"scriptVersion": "2018-08-07T11:36:30.304-07:00",
"hyperPointType": "Standard",
"hyperPointScriptFormat": "",
"hyperPointLibLongId": "",
"configurableBitParameters": [
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "0",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": true,
"calculationParameter1": "190",
"calculationParameter2": "",
"reportCAS": true,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 70
},
{
"enabledForCvsCalculation": true,
"calculationParameter1": "400",
"calculationParameter2": "",
"reportCAS": true,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 95
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "0",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
}
]
}
}
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| pointConfig |
Single Point Configuration Record DTO |
PointConfigRecordDTO |
None |
Response Formats
application/json, text/json
Sample:
{
"pointConfig": {
"pointTag": "BRIDGECP.UIS.00004812:ANTIER_WL_PRTUBXIN:ANTIER_WL.PRTUBXIN",
"isActive": true,
"pointVersion": "2018-08-07T11:37:03.095-07:00",
"description": "Tubing Pressure",
"longDescription": "Tubing Pressure",
"pointScheme": 1,
"pointDataType": "AI",
"primaryUnits": "psi",
"alternateUnits": "bar",
"systemName": "N/A",
"displayAttribute": "",
"securityApp": "",
"initialType": "Restore",
"initialValue": "",
"allowedUpdates": "All",
"manualInputEnabled": false,
"suppressAlarms": false,
"suppressAlarmsEndsOnNormal": false,
"suppressAlarmsEndsOnDateTime": "0001-01-01T00:00:00",
"alarmCategory": "GC",
"anyConfigBitEnabled": true,
"anyConfigBitReportingCAS": true,
"anyConfigBitReportingGNS": false,
"anyConfigBitHasGNSId": false,
"anyConfigBitHasReportingDelay": false,
"reportDelayUnits": "Seconds",
"reportVHS": true,
"historyOnLineDays": 30,
"forceHistoryOnUpdate": true,
"forceHistory": "Disabled",
"forcePeriod": "00:00:00",
"minimumEvaluationTime": "00:00:00",
"compressionType": "None",
"alarmDeadBand": 0.0,
"historyDeadBand": 0.0,
"maxSetPoint": 0.0,
"minSetPoint": 0.0,
"scaleValue": false,
"scaleCoefficientA0": 0.0,
"scaleCoefficientA1": 1.0,
"scaleCoefficientA2": 0.0,
"scaleCoefficientA3": 0.0,
"scaleCoefficientA4": 0.0,
"scaleCoefficientA5": 0.0,
"twoPointScale": true,
"rawLow": 0.0,
"rawHigh": 1.0,
"engineeringLow": 0.0,
"engineeringHigh": 1.0,
"useDecimalPlaces": false,
"decimalPlaces": 2,
"digitalOnString": "SET",
"digitalOffString": "NOT SET",
"enumTableName": "",
"pointReferenceType": "",
"referenceSite": "",
"referenceService": "",
"referencePointId": "",
"referencePointIdLong": "",
"anyVerifiedFlag": false,
"verifiedFlag1": false,
"verifiedFlag2": false,
"verifiedFlag3": false,
"verifiedFlag4": false,
"verifiedTimestamp": "0001-01-01T00:00:00",
"questionableFlag": false,
"questionableTimestamp": "0001-01-01T00:00:00",
"anyUserFlag": true,
"userFlag1": true,
"userFlag2": false,
"userFlag3": false,
"userFlag4": false,
"userFlag5": false,
"userFlag6": false,
"userFlag7": false,
"userFlag8": false,
"indexed1": "",
"indexed2": "",
"indexed3": "",
"tableDriven1": "",
"tableDriven2": "",
"tableDriven3": "",
"general1": "",
"general2": "",
"general3": "",
"externalIdType": "",
"externalId": "",
"comment": "",
"hasEnhancedAlarmConfig": false,
"hasEnhancedAlmarmConfigError": false,
"hyperPointEnabled": false,
"scriptEnabled": false,
"scriptVersion": "2018-08-07T11:36:30.304-07:00",
"hyperPointType": "Standard",
"hyperPointScriptFormat": "",
"hyperPointLibLongId": "",
"configurableBitParameters": [
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "0",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": true,
"calculationParameter1": "190",
"calculationParameter2": "",
"reportCAS": true,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 70
},
{
"enabledForCvsCalculation": true,
"calculationParameter1": "400",
"calculationParameter2": "",
"reportCAS": true,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 95
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "0",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
},
{
"enabledForCvsCalculation": false,
"calculationParameter1": "",
"calculationParameter2": "",
"reportCAS": false,
"reportGNS": false,
"gnsId": "",
"reportingDelay": 0,
"alarmPriority": 0
}
]
}
}