Operation

@trimblecloudplatform/trimblecloud.processing

---

@trimblecloudplatform/trimblecloud.processing / Operation

Interface: Operation

Defined in: src/models/operations.ts:41

The Operation object.

Properties

accountId?

optional accountId: string

Defined in: src/models/operations.ts:85

The TID account identifier of the owner of this Operation.

---

clientId?

optional clientId: string

Defined in: src/models/operations.ts:90

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

---

createdAt?

optional createdAt: string

Defined in: src/models/operations.ts:115

Timestamp for the Operation’s creation.

---

deploymentIdentifier?

optional deploymentIdentifier: string

Defined in: src/models/operations.ts:110

The identifier of the Deployment that supports this Operation.

---

deprecationMessage?

optional deprecationMessage: string

Defined in: src/models/operations.ts:150

Optional string parameter.

---

description?

optional description: string

Defined in: src/models/operations.ts:100

The description of the Operation.

---

dynamicOutput?

optional dynamicOutput: boolean

Defined in: src/models/operations.ts:145

Indicates whether or not the Output content is considered dynamic or not.

---

engineName?

optional engineName: string

Defined in: src/models/operations.ts:105

The name of the backend engine that supports this Operation.

---

executionStatus?

optional executionStatus: ExecutionStatus

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

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

---

id?

optional id: string

Defined in: src/models/operations.ts:45

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

---

identifier?

optional identifier: string

Defined in: src/models/operations.ts:50

Unique identifier string for the Operation.

---

inputs?

optional inputs: Record<string, InputParam>

Defined in: src/models/operations.ts:135

Named inputs for the Operation.

---

name?

optional name: string

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

The name of the Operation.

---

outputParameters?

optional outputParameters: Record<string, OutputParameter>

Defined in: src/models/operations.ts:130

A list of parameter objects that define values to be output from an Operation.

---

outputs?

optional outputs: Record<string, OutputParam>

Defined in: src/models/operations.ts:140

Named outputs for the Operation.

---

ownerName?

optional ownerName: string

Defined in: src/models/operations.ts:80

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

---

parameters?

optional parameters: Record<string, Parameter>

Defined in: src/models/operations.ts:125

A list of parameter objects attached to the Operation.

---

public?

optional public: boolean

Defined in: src/models/operations.ts:65

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

---

regions?

optional regions: string[]

Defined in: src/models/operations.ts:60

Allowable locations that a particular Operation can run in.

---

retiredAfter?

optional retiredAfter: string

Defined in: src/models/operations.ts:155

---

sharedWith?

optional sharedWith: string[]

Defined in: src/models/operations.ts:120

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

---

status?

optional status: Status

Defined in: src/models/operations.ts:70

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

---

version?

optional version: number

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

The version of the Operation.