CreateProcedureParameters

@trimblecloudplatform/trimblecloud.processing

---

@trimblecloudplatform/trimblecloud.processing / CreateProcedureParameters

Interface: CreateProcedureParameters

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

Parameters passed while creating a Procedure.

Properties

description?

optional description: string

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

The description of the Procedure.

---

documentationUrl?

optional documentationUrl: string

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

Optional URL to reference external documentation for the Procedure.

---

name?

optional name: string

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

The name of the Procedure.

---

parameters?

optional parameters: Record<string, ProcedureParameter>

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

Parameter mappings for the Procedures contained within the Procedure.

---

sharedWith?

optional sharedWith: string[]

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

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:301

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:286

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