IRPCObjectOperations.GetMultipleWorkflowStatesAndTransitionsWithRightsCheck

View as Markdown

Vault API / core read session or assertion idempotent returns metadata structure version

Gets the states and transitions of several workflows in one call, in a compressed binary form, with the user's rights checked.

ServiceObjects, versions, properties and files MFiles.IRPCObjectOperations
gRPC method/MFiles.IRPCObjectOperations/GetMultipleWorkflowStatesAndTransitionsWithRightsCheck
HTTP (mf-http-grpc)POST /grpc/v1/get-multiple-workflow-states-and-transitions-with-rights-check
RequestGetMultipleWorkflowStatesAndTransitionsWithRightsCheckRequest
ResponseGetMultipleWorkflowStatesAndTransitionsWithRightsCheckResponse
Book and levelVault API, core
Kindread
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Used by M-Files clients; see GetMultipleWorkflowStatesAndTransitions.

Request: GetMultipleWorkflowStatesAndTransitionsWithRightsCheckRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
workflow_ids[]repeated int32The IDs of the workflows.

Response: GetMultipleWorkflowStatesAndTransitionsWithRightsCheckResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
statesbytesStates. Compressed, unless pulUncompressedStatesLength is -1.
uncompressed_states_lengthuint32Receives the length of the uncompressed data. Set to -1 if pbytesData is not compressed.
transitionsbytesTransitions. Compressed, unless pulUncompressedTransitionsLength is -1.
uncompressed_transitions_lengthuint32Receives the length of the uncompressed data. Set to -1 if pbytesData is not compressed.