Corrigo: Rcs circuit schemas
1 Corrigo schema with complete fields and constraints.
← Rcs circuit operations · All schemas
Create rcs circuit — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
actions | JSON | Optional | |
actions (anyOf 1) | array | Alternative | |
actions (anyOf 1)[] | JSON | Each item | |
actions (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo RcsAction. |
actions (anyOf 1)[] (anyOf 2) | null | Alternative | |
actions (anyOf 2) | null | Alternative | |
alarmSetPoint | JSON | Optional | |
alarmSetPoint (anyOf 1) | number | Alternative | Format: double |
alarmSetPoint (anyOf 2) | null | Alternative | |
asset | JSON | Optional | |
asset (anyOf 1) | object | Alternative | A Corrigo Location. |
asset (anyOf 2) | null | Alternative | |
assetSystem | JSON | Optional | |
assetSystem (anyOf 1) | object | Alternative | A Corrigo AssetSystem. |
assetSystem (anyOf 2) | null | Alternative | |
calendarLeakRate | JSON | Optional | |
calendarLeakRate (anyOf 1) | number | Alternative | Format: double |
calendarLeakRate (anyOf 2) | null | Alternative | |
capacity | number | Optional | Format: double |
comments | JSON | Optional | |
comments (anyOf 1) | string | Alternative | |
comments (anyOf 2) | null | Alternative | |
concentrationMonitorTypeID | JSON | Optional | |
concentrationMonitorTypeID (anyOf 1) | integer | Alternative | Format: int32 |
concentrationMonitorTypeID (anyOf 2) | null | Alternative | |
dateOfOperation | JSON | Optional | |
dateOfOperation (anyOf 1) | string | Alternative | Format: date-time |
dateOfOperation (anyOf 2) | null | Alternative | |
detectionLimit | JSON | Optional | |
detectionLimit (anyOf 1) | number | Alternative | Format: double |
detectionLimit (anyOf 2) | null | Alternative | |
equipmentCalibrationDate | JSON | Optional | |
equipmentCalibrationDate (anyOf 1) | string | Alternative | Format: date-time |
equipmentCalibrationDate (anyOf 2) | null | Alternative | |
equipmentName | JSON | Optional | |
equipmentName (anyOf 1) | string | Alternative | |
equipmentName (anyOf 2) | null | Alternative | |
equipmentStatusId | string | Optional | One of: Active, Mothballed, Retired, Inactive, Decommissioned Format: int32 |
equipmentTypeID | JSON | Optional | |
equipmentTypeID (anyOf 1) | integer | Alternative | Format: int32 |
equipmentTypeID (anyOf 2) | null | Alternative | |
fullChargeCalcMethodID | JSON | Optional | |
fullChargeCalcMethodID (anyOf 1) | integer | Alternative | Format: int32 |
fullChargeCalcMethodID (anyOf 2) | null | Alternative | |
hasEquipmentCalibration | boolean | Optional | |
hasLeakInspection | boolean | Optional | |
installDate | JSON | Optional | |
installDate (anyOf 1) | string | Alternative | Format: date-time |
installDate (anyOf 2) | null | Alternative | |
isLeakDetectionEquipment | boolean | Optional | |
isMetric | boolean | Optional | |
isMothball | boolean | Optional | |
leakDetectionCoverID | JSON | Optional | |
leakDetectionCoverID (anyOf 1) | integer | Alternative | Format: int32 |
leakDetectionCoverID (anyOf 2) | null | Alternative | |
leakDetectionDeviceTypeID | JSON | Optional | |
leakDetectionDeviceTypeID (anyOf 1) | integer | Alternative | Format: int32 |
leakDetectionDeviceTypeID (anyOf 2) | null | Alternative | |
leakInspectionDate | JSON | Optional | |
leakInspectionDate (anyOf 1) | string | Alternative | Format: date-time |
leakInspectionDate (anyOf 2) | null | Alternative | |
leakRate | number | Optional | Format: double |
leakRateLogs | JSON | Optional | |
leakRateLogs (anyOf 1) | array | Alternative | |
leakRateLogs (anyOf 1)[] | JSON | Each item | |
leakRateLogs (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo RcsLeakRateLog. |
leakRateLogs (anyOf 1)[] (anyOf 2) | null | Alternative | |
leakRateLogs (anyOf 2) | null | Alternative | |
leakThreshold | number | Optional | Format: double |
locationDescription | JSON | Optional | |
locationDescription (anyOf 1) | string | Alternative | |
locationDescription (anyOf 2) | null | Alternative | |
locationOfSensorsInlets | JSON | Optional | |
locationOfSensorsInlets (anyOf 1) | string | Alternative | |
locationOfSensorsInlets (anyOf 2) | null | Alternative | |
locationTypeID | JSON | Optional | |
locationTypeID (anyOf 1) | integer | Alternative | Format: int32 |
locationTypeID (anyOf 2) | null | Alternative | |
manufacturer | JSON | Optional | |
manufacturer (anyOf 1) | string | Alternative | |
manufacturer (anyOf 2) | null | Alternative | |
mhProduct | JSON | Optional | |
mhProduct (anyOf 1) | object | Alternative | A Corrigo Product. |
mhProduct (anyOf 2) | null | Alternative | |
model | JSON | Optional | |
model (anyOf 1) | string | Alternative | |
model (anyOf 2) | null | Alternative | |
modelYear | JSON | Optional | |
modelYear (anyOf 1) | integer | Alternative | Format: int32 |
modelYear (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | |
number (anyOf 2) | null | Alternative | |
numberofSensors | JSON | Optional | |
numberofSensors (anyOf 1) | integer | Alternative | Format: int32 |
numberofSensors (anyOf 2) | null | Alternative | |
objectId | integer | Optional | Format: int32 |
objectTypeId | Model | Optional | Expand Create actor — request body — body entity type Id |
operationalStatusDate | JSON | Optional | |
operationalStatusDate (anyOf 1) | string | Alternative | Format: date-time |
operationalStatusDate (anyOf 2) | null | Alternative | |
operationalStatusId | string | Optional | One of: Normal, UnderRepair, Seasonal, Retrofitted, PermanentShutdownAndRemoval, Mothball, Sold, DisposedOrDestroyed Format: int32 |
rcsCircuitMonitorMapping | JSON | Optional | |
rcsCircuitMonitorMapping (anyOf 1) | array | Alternative | |
rcsCircuitMonitorMapping (anyOf 1)[] | JSON | Each item | |
rcsCircuitMonitorMapping (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo RcsCircuitMonitorEquipment. |
rcsCircuitMonitorMapping (anyOf 1)[] (anyOf 2) | null | Alternative | |
rcsCircuitMonitorMapping (anyOf 2) | null | Alternative | |
sensorManufacturer | JSON | Optional | |
sensorManufacturer (anyOf 1) | string | Alternative | |
sensorManufacturer (anyOf 2) | null | Alternative | |
sensorTypeID | JSON | Optional | |
sensorTypeID (anyOf 1) | integer | Alternative | Format: int32 |
sensorTypeID (anyOf 2) | null | Alternative | |
serialNumber | JSON | Optional | |
serialNumber (anyOf 1) | string | Alternative | |
serialNumber (anyOf 2) | null | Alternative | |
statusId | string | Optional | One of: Active, Retired, Retrofitted Format: int32 |
temperatureClassificationID | JSON | Optional | |
temperatureClassificationID (anyOf 1) | integer | Alternative | Format: int32 |
temperatureClassificationID (anyOf 2) | null | Alternative |
Referenced models: Create actor — request body — body entity type Id