ListProcedureQueryParameters

@trimblecloudplatform/trimblecloud.processing

---

@trimblecloudplatform/trimblecloud.processing / ListProcedureQueryParameters

Interface: ListProcedureQueryParameters

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

Interface for the query parameters used to filter the list of procedures.

Extends

• ListQueryParameters

Properties

executionStatus?

optional executionStatus: ExecutionStatus

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

The execution_status of a resource. Filters the list of returned resources by those that have an execution_status matching the supplied value.

---

identifier?

optional identifier: string

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

Returns all resource(s) that match the provided identifier string.

---

operationUuid?

optional operationUuid: string

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

Unique ID of an Operation.

---

page?

optional page: number

Defined in: src/models/listQueryParameters.ts:22

The page number to return

Inherited from

ListQueryParameters.page

---

perPage?

optional perPage: number

Defined in: src/models/listQueryParameters.ts:17

The number of items to return per page. The default is 5 and the maximum is 1000.

Inherited from

ListQueryParameters.perPage

---

public?

optional public: boolean

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

Filters results by public status. If not supplied, or explicitly set to “true”,

---

region?

optional region: region

Defined in: src/models/listQueryParameters.ts:12

The region to filter by. Allowed: aws-us1 ┃ azure-us1

Inherited from

ListQueryParameters.region

---

status?

optional status: Status

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

The status of a resource. Filters the list of returned results by those that have a status matching the supplied value.