Corrigo: Create rcs action

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

Operation corrigo.base_rcsaction_create

Provider route: POST /v1/base/RcsAction. 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["rcsAction"]["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.rcsAction.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_action.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 action — request body — body entity

Referenced models: Create rcs action — 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

3 more schemas are linked from the tables above, on the schema pages.

Create rcs action — 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
`actorId`	JSON	Optional
`actorId (anyOf 1)`	integer	Alternative	Format: int32
`actorId (anyOf 2)`	null	Alternative
`actorTypeId`	Model	Optional	Expand Create actor — request body — body entity type Id
`alarmSetPoint`	JSON	Optional
`alarmSetPoint (anyOf 1)`	number	Alternative	Format: double
`alarmSetPoint (anyOf 2)`	null	Alternative
`amountDestroyed`	number	Optional	Format: double
`amountReclaimed`	number	Optional	Format: double
`certClassId`	string	Optional	One of: None, Class1, Class1AndClass2, Class1AndClass2AndClass3, Class1AndClass3, Class2, Class2AndClass3, Class3, Universal Format: int32
`certNumber`	JSON	Optional
`certNumber (anyOf 1)`	string	Alternative
`certNumber (anyOf 2)`	null	Alternative
`circuit`	JSON	Optional
`circuit (anyOf 1)`	object	Alternative	A Corrigo RcsCircuit.
`circuit (anyOf 2)`	null	Alternative
`circuitNumber`	JSON	Optional
`circuitNumber (anyOf 1)`	string	Alternative
`circuitNumber (anyOf 2)`	null	Alternative
`comments`	JSON	Optional
`comments (anyOf 1)`	string	Alternative
`comments (anyOf 2)`	null	Alternative
`costValue`	JSON	Optional
`costValue (anyOf 1)`	number	Alternative	Format: double
`costValue (anyOf 2)`	null	Alternative
`cylinder`	JSON	Optional
`cylinder (anyOf 1)`	object	Alternative	A Corrigo RcsCylinder.
`cylinder (anyOf 2)`	null	Alternative
`cylinderNumber`	JSON	Optional
`cylinderNumber (anyOf 1)`	string	Alternative
`cylinderNumber (anyOf 2)`	null	Alternative
`cylinderSource`	JSON	Optional
`cylinderSource (anyOf 1)`	object	Alternative	A Corrigo RcsCylinder.
`cylinderSource (anyOf 2)`	null	Alternative
`detectionLimit`	JSON	Optional
`detectionLimit (anyOf 1)`	number	Alternative	Format: double
`detectionLimit (anyOf 2)`	null	Alternative
`dtALDAlarm`	JSON	Optional
`dtALDAlarm (anyOf 1)`	string	Alternative	Format: date-time
`dtALDAlarm (anyOf 2)`	null	Alternative
`dtDue`	JSON	Optional
`dtDue (anyOf 1)`	string	Alternative	Format: date-time
`dtDue (anyOf 2)`	null	Alternative
`dtEndIsolation`	JSON	Optional
`dtEndIsolation (anyOf 1)`	string	Alternative	Format: date-time
`dtEndIsolation (anyOf 2)`	null	Alternative
`dtIsolation`	JSON	Optional
`dtIsolation (anyOf 1)`	string	Alternative	Format: date-time
`dtIsolation (anyOf 2)`	null	Alternative
`dtShipment`	JSON	Optional
`dtShipment (anyOf 1)`	string	Alternative	Format: date-time
`dtShipment (anyOf 2)`	null	Alternative
`dtWhen`	JSON	Optional
`dtWhen (anyOf 1)`	string	Alternative	Format: date-time
`dtWhen (anyOf 2)`	null	Alternative
`equipmentDestinationId`	integer	Optional	Format: int32
`equipmentDestinationManager`	JSON	Optional
`equipmentDestinationManager (anyOf 1)`	object	Alternative	A Corrigo Employee.
`equipmentDestinationManager (anyOf 2)`	null	Alternative
`hasComponentIsolated`	boolean	Optional
`initialCharge`	boolean	Optional
`isALDCalibrationSuccess`	boolean	Optional
`isContactNotified`	boolean	Optional
`isMetric`	boolean	Optional
`isScheduled`	boolean	Optional
`isTestPassed`	boolean	Optional
`leakCauseDescription`	JSON	Optional
`leakCauseDescription (anyOf 1)`	string	Alternative
`leakCauseDescription (anyOf 2)`	null	Alternative
`leaksFound`	boolean	Optional
`leaksFoundCount`	integer	Optional	Format: int32
`moneyId`	Model	Optional	Expand Create rcs action — request body — body entity money Id
`noLeakRate`	boolean	Optional
`parasenseId`	JSON	Optional
`parasenseId (anyOf 1)`	string	Alternative
`parasenseId (anyOf 2)`	null	Alternative
`parentAction`	JSON	Optional
`parentAction (anyOf 1)`	object	Alternative	A Corrigo RcsAction.
`parentAction (anyOf 2)`	null	Alternative
`poNumber`	JSON	Optional
`poNumber (anyOf 1)`	string	Alternative
`poNumber (anyOf 2)`	null	Alternative
`product`	JSON	Optional
`product (anyOf 1)`	object	Alternative	A Corrigo Product.
`product (anyOf 2)`	null	Alternative
`qty`	JSON	Optional
`qty (anyOf 1)`	number	Alternative	Format: double
`qty (anyOf 2)`	null	Alternative
`qtyCylinder`	JSON	Optional
`qtyCylinder (anyOf 1)`	number	Alternative	Format: double
`qtyCylinder (anyOf 2)`	null	Alternative
`qtyCylinderSource`	JSON	Optional
`qtyCylinderSource (anyOf 1)`	number	Alternative	Format: double
`qtyCylinderSource (anyOf 2)`	null	Alternative
`rcsExtensionReasonId`	string	Optional	One of: Unknown, NoTechnician, NoParts, RequiresShutdown, RiskRadio, NoComponents, Other Format: int32
`rcsInspectionReasonID`	string	Optional	One of: Unknown, PlannedMaintenance, UnplannedMaintenance, AutomaticLeakDetectionAlarm, Other Format: int32
`rcsLeakCauseId`	string	Optional	One of: Unknown, Corrosion, JointFailure, NormalWear, RubOut, Rupture, SealFailure, Vibration, Abuse, Warranty, MechanicalFailure, Catastrophe, Other Format: int32
`rcsLeakLocationDetailId`	Model	Optional	Expand Create rcs action — request body — body entity rcs Leak Location Detail Id
`rcsLeakLocationId`	string	Optional	One of: Unknown, Compressor, DischargeLine, Condenser, Receiver, LiquidLine, Evaporator, SuctionLine, HeatRecovery, Piping, Purge, Valve, RuptureDisc, Other Format: int32
`rcsStockTypeId`	string	Optional	One of: Unknown, SupplierStock, OwnerStock, External Format: int32
`rcsTestMethodId`	string	Optional	One of: Unknown, NotTested, Pressurizing, Electronic, DeepVacuum, SoapBubbles, Other, CalibratedLeakDetectionDevice, DyeInject, HalideDetector, OilResidue, ApprovedAlternate Format: int32
`reclamationCompany`	JSON	Optional
`reclamationCompany (anyOf 1)`	string	Alternative
`reclamationCompany (anyOf 2)`	null	Alternative
`refrigerantHistory`	string	Optional	One of: Unknown, Virgin, Recycled, Reclaimed Format: int32
`refrigerantTypeOfRepairId`	string	Optional	One of: Unknown, AuditOrInspect, Weld, Replace, Bypass, Repair, Remove, Tighten, Newcap, Relocate, LeakInspection, Calibrate, Other Format: int32
`remainingCapacity`	number	Optional	Format: double
`serviceEventId`	integer	Optional	Format: int32
`shippedTo`	JSON	Optional
`shippedTo (anyOf 1)`	string	Alternative
`shippedTo (anyOf 2)`	null	Alternative
`supplier`	JSON	Optional
`supplier (anyOf 1)`	object	Alternative	A Corrigo Employee.
`supplier (anyOf 2)`	null	Alternative
`techName`	JSON	Optional
`techName (anyOf 1)`	string	Alternative
`techName (anyOf 2)`	null	Alternative
`typeId`	string	Optional	One of: Unknown, Purchased, Disposed, Refilled, CylinderRelease, CircuitRelease, Added, Recovered, Tested, Transferred, LeakIdentified, LeakRepaired, LeakTestFollow, Created, CircuitEdit, Retired, LeakTestInitial, Adjusted, CylinderEdit, LeakInspected, ALDCalibrated, Retrofitted, Activated, ServicedOrLeakRepaired Format: int32
`typeOfRepairDesc`	JSON	Optional
`typeOfRepairDesc (anyOf 1)`	string	Alternative
`typeOfRepairDesc (anyOf 2)`	null	Alternative
`workOrderId`	integer	Optional	Format: int32

Referenced models: Create actor — request body — body entity type Id, Create rcs action — request body — body entity money Id, Create rcs action — request body — body entity rcs Leak Location Detail Id

Policy, approvals and errors

SDK function policy ID: corrigo.base_rcsaction_create. Catalog operation: base.RcsAction.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