IRPCWorkflowsAdmin.RemoveWorkflow
Administration API / specialized admin session
Deletes a workflow with its states and transitions.
| Service | Workflow administration MFiles.IRPCWorkflowsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCWorkflowsAdmin/RemoveWorkflow |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-workflow |
| Request | RemoveWorkflowRequest |
| Response | RemoveWorkflowResponse |
| 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
manage_workflowsandlicense_allows_modifications. - Classes that used the workflow as their workflow no longer refer to it.
- An unknown ID fails with "Not found.". Increments the metadata structure version.
Request: RemoveWorkflowRequest
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 |
|---|---|---|
id | int32 | The ID of the workflow to remove. |
Response: RemoveWorkflowResponse
No fields.