Corrigo: Update procedure template step

← Procedure template step operations · Get started

Operation corrigo.base_proceduretemplatestep_update

Provider route: PUT /v1/base/ProcedureTemplateStep. 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["procedureTemplateStep"]["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.procedureTemplateStep.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.procedure_template_step.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 procedure template step — request body — body entity

Referenced models: Create procedure template step — 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 procedure template step — 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
attrDescriptor	JSON	Optional
attrDescriptor (anyOf 1)	object	Alternative	A Corrigo AttributeDescriptor.
attrDescriptor (anyOf 2)	null	Alternative
conditionAttribute	JSON	Optional
conditionAttribute (anyOf 1)	object	Alternative	A Corrigo AttributeOption.
conditionAttribute (anyOf 2)	null	Alternative
conditionCustomField	JSON	Optional
conditionCustomField (anyOf 1)	object	Alternative	A Corrigo CustomFieldOption.
conditionCustomField (anyOf 2)	null	Alternative
conditionType	string	Optional	One of: Unknown, Regular, Parent, Conditional Format: int32
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
fieldDescriptor	JSON	Optional
fieldDescriptor (anyOf 1)	object	Alternative	A Corrigo CustomFieldDescriptor.
fieldDescriptor (anyOf 2)	null	Alternative
index	integer	Optional	Format: int32
instructions	JSON	Optional
instructions (anyOf 1)	string	Alternative
instructions (anyOf 2)	null	Alternative
isRequired	boolean	Optional
parentStepId	integer	Optional	Format: int32
procedureTemplateId	integer	Optional	Format: int32
typeId	string	Optional	One of: Unknown, Text, Field, Attribute, Document Format: int32
yIdx	integer	Optional	Format: int32
zIdx	integer	Optional	Format: int32

Policy, approvals and errors

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