Skip to content
Processing Framework

UpdateProcedureParameters

@trimblecloudplatform/trimblecloud.processing

@trimblecloudplatform/trimblecloud.processing / UpdateProcedureParameters

Interface: UpdateProcedureParameters

Defined in: src/models/procedures.ts:351

Procedure parameters that can updated.

Properties

defaultRegion?

optional defaultRegion: string

Defined in: src/models/procedures.ts:391

Region name the Procedure should execute in by default.

description?

optional description: string

Defined in: src/models/procedures.ts:367

The description of the Procedure.

documentationUrl?

optional documentationUrl: string

Defined in: src/models/procedures.ts:375

Optional URL to reference external documentation for the Procedure.

identifier?

optional identifier: string

Defined in: src/models/procedures.ts:355

Unique identifier string for the Procedure.

name?

optional name: string

Defined in: src/models/procedures.ts:363

The name of the Procedure.

operations?

optional operations: Record<string, OperationForCreateUpdateProcedure>

Defined in: src/models/procedures.ts:395

Mapping of Procedure names and definitions. This is where the user specifies which Procedures make up the Procedure and how those Operations chain together.

parameters?

optional parameters: Record<string, ProcedureParameter>

Defined in: src/models/procedures.ts:399

Parameter mappings for the Procedures contained within the Procedure.

sharedWith?

optional sharedWith: string[]

Defined in: src/models/procedures.ts:379

Deprecated

Use sharedWithIdentities instead. List of names of Users with whom this Procedure has been shared.

sharedWithIdentities?

optional sharedWithIdentities: SharedWithIdentity[]

Defined in: src/models/procedures.ts:386

List of identities with whom this Procedure has been shared. Each entry contains an accountId and optionally a clientId. Sending an array replaces the existing list, not appends to it.

tags?

optional tags: string[]

Defined in: src/models/procedures.ts:371

List of tags (as strings) associated with the Procedure.

version?

optional version: number

Defined in: src/models/procedures.ts:359

The version of the Procedure.