Corrigo: Update model

Corrigo model.update: arguments, response, policy and SDK examples.

Operation corrigo.base_model_update

Provider route: PUT /v1/base/Model. 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["model"]["update"]>[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.model.update(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.model.update(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 model — request body — body entity

Referenced models: Create model — 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 model — 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
`isRemoved`	boolean	Optional
`allowAnonymousRequests`	boolean	Optional
`assetCategoryId`	string	Optional	One of: Unknown, Regular, Building, Unit, Community, RoomArea, Floor, Utility, Equipment Format: int32
`attributeDescriptors`	JSON	Optional
`attributeDescriptors (anyOf 1)`	array	Alternative
`attributeDescriptors (anyOf 1)[]`	JSON	Each item
`attributeDescriptors (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo LinkModelAndAttribute.
`attributeDescriptors (anyOf 1)[] (anyOf 2)`	null	Alternative
`attributeDescriptors (anyOf 2)`	null	Alternative
`chargeCode`	JSON	Optional
`chargeCode (anyOf 1)`	object	Alternative	A Corrigo ChargeCodeLookup.
`chargeCode (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`displayAs`	JSON	Optional
`displayAs (anyOf 1)`	string	Alternative
`displayAs (anyOf 2)`	null	Alternative
`glAccount`	JSON	Optional
`glAccount (anyOf 1)`	string	Alternative
`glAccount (anyOf 2)`	null	Alternative
`instructions`	JSON	Optional
`instructions (anyOf 1)`	string	Alternative
`instructions (anyOf 2)`	null	Alternative
`number`	JSON	Optional
`number (anyOf 1)`	string	Alternative
`number (anyOf 2)`	null	Alternative
`parts`	JSON	Optional
`parts (anyOf 1)`	array	Alternative
`parts (anyOf 1)[]`	JSON	Each item
`parts (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo LinkProductAndQtyAttribute.
`parts (anyOf 1)[] (anyOf 2)`	null	Alternative
`parts (anyOf 2)`	null	Alternative
`public`	boolean	Optional
`subComponentIdx`	string	Optional
`tasks`	JSON	Optional
`tasks (anyOf 1)`	array	Alternative
`tasks (anyOf 1)[]`	JSON	Each item
`tasks (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo Task.
`tasks (anyOf 1)[] (anyOf 2)`	null	Alternative
`tasks (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: corrigo.base_model_update. Catalog operation: base.Model.update. 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