Corrigo: Create rcs circuit

Corrigo rcsCircuit.create: arguments, response, policy and SDK examples.

Operation corrigo.base_rcscircuit_create

Provider route: POST /v1/base/RcsCircuit. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/corrigo with npm, or alter-sdk-corrigo with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { CorrigoIntegration } from "@alter-ai/corrigo";

async function execute(input: Parameters<CorrigoIntegration["rcsCircuit"]["create"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new CorrigoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.rcsCircuit.create(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_corrigo import CorrigoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = CorrigoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.rcs_circuit.create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`body`	object	Required within parent	Additional keys: not allowed
`body.requestId`	JSON	Optional
`body.requestId (anyOf 1)`	string	Alternative
`body.requestId (anyOf 2)`	null	Alternative
`body.properties`	JSON	Optional
`body.properties (anyOf 1)`	array	Alternative
`body.properties (anyOf 1)[]`	string	Each item
`body.properties (anyOf 2)`	null	Alternative
`body.entity`	Model	Required within parent	Expand Create rcs circuit — request body — body entity

Referenced models: Create rcs circuit — request body — body entity

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	JSON	Root

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

Create actor — request body — body entity type Id

Field	Type	Presence	Description and constraints
`$`	string	Root	One of: Unknown, Employee, Occupancy, CorrigoNet, Resident, CommLease, CommLeaseSpace, Property, Portfolio, LeaseGroup, LeaseUser, Supplier, Asset, WO, Org, Warranty, WOPrintout, Team, CompanyProp, Landmark, Provider, ReportTimeSet, TenantCoi, Model, Theme, CustomerInvoice, Payment, MhLocation, MhProduct, PmRmTemplate, Document, WoProxy, Proposal, PlWoItem, Insurance, InvTemplate, ReportSubscription, Requestor, ProcTemplateStep, Procedure, MhOrder, AssetSystem, WorkTemplate, WtWoProxy, Incident, Visit, DutyType, Estimate, Quote, WoActionLog, ProcedureTemplate, WoRequiredDoc, WoSchedule, Rounds, RoundsSchedule, RoundsStep, Specialty, ReceiptStorageRecord, MhTransaction, MhConsumptionRequest, AlertSend Format: int32

Policy, approvals and errors

SDK function policy ID: corrigo.base_rcscircuit_create. Catalog operation: base.RcsCircuit.create. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page