Procedure

@trimblecloudplatform/trimblecloud.processing

---

@trimblecloudplatform/trimblecloud.processing / Procedure

Interface: Procedure

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

Represents a Procedure.

Properties

accountId?

optional accountId: string

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

The TID account identifier of the owner of this Procedure.

---

clientId?

optional clientId: string

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

The TID subject identifier (client ID) of the owner of this Procedure.

---

createdAt?

optional createdAt: string

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

Timestamp for the Procedure’s creation.

---

defaultRegion?

optional defaultRegion: string

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

Region name the Procedure should execute in by default.

---

description?

optional description: string

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

The description of the Procedure.

---

documentationUrl?

optional documentationUrl: string

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

Optional URL to reference external documentation for the Procedure.

---

executionStatus?

optional executionStatus: ExecutionStatus

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

The status of the Procedure’s execution. Allowed : NOT_READY┃READY┃SUSPENDED

---

id?

optional id: string

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

The unique identifier for the Procedure, read-only and assigned at creation time. Used to perform actions on specific Procedures through the API.

---

identifier?

optional identifier: string

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

Unique identifier string for the Procedure.

---

name?

optional name: string

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

The name of the Procedure.

---

operations?

optional operations: Record<string, OperationInProcedure>

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

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

---

ownerName?

optional ownerName: string

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

The owner name maps to the API Cloud application used to originally create the Procedure.

---

parameters?

optional parameters: Record<string, ProcedureParameter>

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

Parameter mappings for the Procedures contained within the Procedure.

---

public?

optional public: boolean

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

The state of the Procedure’s publication. If true, the Procedure is available for public use.

---

regions?

optional regions: string[]

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

Allowable locations that a particular Procedure can run in.

---

retiredAfter?

optional retiredAfter: string

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

Optional string parameter.

---

sharedWith?

optional sharedWith: string[]

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

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

---

status?

optional status: Status

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

The status of the Procedure. Allowed : MUTABLE┃EXECUTABLE┃RETIRED

---

tags?

optional tags: string[]

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

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

---

version?

optional version: number

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

The version of the Procedure.