IRPCObjectOperations.GetWorkflowsForClient
Vault API / core read session or assertion idempotent returns metadata structure version
Gets all the workflows in a format suitable for client.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetWorkflowsForClient |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-workflows-for-client |
| Request | GetWorkflowsForClientRequest |
| Response | GetWorkflowsForClientResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Returns the workflows the user can see, each with its ID, name and object_class_id. In the Sample
Vault: workflow 106 "Reviewing drawings" with class 88.
Request: GetWorkflowsForClientRequest
No fields.
Response: GetWorkflowsForClientResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
workflows[] | repeated Workflow | Results Array. |
workflows[].id | int32 | Workflow ID. |
workflows[].name | string | The name of the workflow. |
workflows[].object_class_id | int32 | The class this workflow can be used with. |
workflows[].description | string | The user description of the workflow. |
workflows[].reserved1_obsolete | uint32 | Reserved, must be zero. |
workflows[].reserved2_obsolete | uint32 | Reserved, must be zero. |