IRPCWorkflowsAdmin.GetWorkflows
Administration API / specialized admin session
Gets the full administrative definitions of all workflows.
| Service | Workflow administration MFiles.IRPCWorkflowsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCWorkflowsAdmin/GetWorkflows |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-workflows |
| Request | GetWorkflowsRequest |
| Response | GetWorkflowsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires
read_all_metadata_structure; a normal user gets "Access denied.". - Returned 4 workflows in the Sample Vault. The order is undefined.
Request: GetWorkflowsRequest
No fields.
Response: GetWorkflowsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
workflow_results[] | repeated WorkflowAdmin | One WorkflowAdmin per workflow. |
workflow_results[].workflow | Workflow | Basic information on the workflow. |
workflow_results[].workflow.id | int32 | Workflow ID. |
workflow_results[].workflow.name | string | The name of the workflow. |
workflow_results[].workflow.object_class_id | int32 | The class this workflow can be used with. |
workflow_results[].workflow.description | string | The user description of the workflow. |
workflow_results[].workflow.reserved1_obsolete | uint32 | Reserved, must be zero. |
workflow_results[].workflow.reserved2_obsolete | uint32 | Reserved, must be zero. |
workflow_results[].description | string | The description of the workflow. |
workflow_results[].states[] | repeated State | The states of this workflow. |
workflow_results[].states[].id | int32 | State ID. |
workflow_results[].states[].name | string | The name of the state. |
workflow_results[].states[].description | string | The description of the state. |
workflow_results[].states[].options | ACTIONFLAGS | Flags that tell which actions are enabled for this state. |
workflow_results[].states[].action_set_acl | ActionSetACL | The properties of the Set Permissions action. |
workflow_results[].states[].action_assign_to_user | ActionSetAssignment | The properties of the Assign to User action. |
workflow_results[].states[].actions[] | repeated ActionSetAssignment | Action array. |
workflow_results[].states[].action_send_notification | ActionSendNotification | The properties of the Send Notification action. |
workflow_results[].states[].action_set_properties | ActionSetProperties | Action: set properties. |
workflow_results[].states[].action_convert_to_pdf | ActionConvertToPDF | Action: convert to PDF. |
workflow_results[].states[].action_code | string | Action: run VBScript code. |
workflow_results[].states[].restrict_transitions | bool | True if transitions involving this state must be individually allowed. |
workflow_results[].states[].transitions_require_edit_access_to_object | bool | True if state transitions require edit access to the object. |
workflow_results[].states[].check_in_out_acl | bool | True if the in/out permissions of this state should be checked. |
workflow_results[].states[].in_out_acl | AccessControlList | The in/out permissions of this state. |
workflow_results[].states[].preconditions | StateConditions | State preconditions. (rules) |
workflow_results[].states[].postconditions | StateConditions | State postconditions. (rules) |
workflow_results[].states[].aliases | string | Semicolon-separated list of semantic aliases. |
workflow_results[].states[].user_description | string | The user description of the state. |
workflow_results[].states[].state_flags | STATEFLAGS | Flags that tell different options set for this state. |
workflow_results[].states[].agent_action_guid | string | The agent action GUID of the state, or GUID_NULL if not set. |
workflow_results[].transitions[] | repeated StateTransition | The state transitions of this workflow. |
workflow_results[].transitions[].id | int32 | State transition ID. |
workflow_results[].transitions[].from_state | int32 | The source state. |
workflow_results[].transitions[].to_state | int32 | The target state. |
workflow_results[].transitions[].evaluation_order | int32 | The evaluation order. |
workflow_results[].transitions[].name | string | The name of the state. |
workflow_results[].transitions[].description | string | The description of the state. |
workflow_results[].transitions[].acl | AccessControlList | Transition permissions. |
workflow_results[].transitions[].signature_settings | ElectronicSignatureSettings | Signature settings for this state transition. |
workflow_results[].transitions[].trigger_mode | AutoStateTransitionMode | The selected mode for automatically triggered state transition.Values: AUTO_STATE_TRANSITION_MODE_NONE (0), AUTO_STATE_TRANSITION_MODE_RELATIVE_TIME (1), AUTO_STATE_TRANSITION_MODE_CRITERIA_FULFILLED (4), AUTO_STATE_TRANSITION_MODE_SCRIPT_FULFILLED (5), AUTO_STATE_TRANSITION_MODE_ASSIGNMENT_COMPLETE (6), AUTO_STATE_TRANSITION_MODE_ASSIGNMENT_REJECTED (7). |
workflow_results[].transitions[].trigger_in_days | uint32 | The number of days before automatically triggered state transition. |
workflow_results[].transitions[].trigger_criteria[] | repeated SearchCondition | The criteria for automatically triggered state transition. |
workflow_results[].transitions[].trigger_code | string | The VB script for automatically triggered state transition. |
workflow_results[].transitions[].aliases | string | Semicolon-separated list of semantic aliases. |
workflow_results[].transitions[].vault_guids[] | repeated string | An array of GUIDS of vaults where this state transition will be triggered. |
workflow_results[].transitions[].user_description | string | The user description of the state. |
workflow_results[].acl | AccessControlList | Permissions. |
workflow_results[].acl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
workflow_results[].acl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
workflow_results[].acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
workflow_results[].acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
workflow_results[].acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
workflow_results[].acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
workflow_results[].aliases | string | Semicolon-separated list of semantic aliases. |
workflow_results[].graphical_layout_data | string | Layout data of the workflow. |