IRPCExportedDataSetsAdmin.TriggerExportedDataSetExecution
Administration API / specialized admin session idempotent
Requests an immediate export run of an exported data set.
| Service | Exported data set administration MFiles.IRPCExportedDataSetsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCExportedDataSetsAdmin/TriggerExportedDataSetExecution |
| HTTP (mf-http-grpc) | POST /grpc/v1/trigger-exported-data-set-execution |
| Request | TriggerExportedDataSetExecutionRequest |
| Response | TriggerExportedDataSetExecutionResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requests a background run and returns at once: the server records the request and M-Files Reporting Data Services runs the export. Follow it with GetExportedDataSetExecutionStatus.
- Fails when the data set is disabled. An unknown ID fails with "Not found.".
- Requires a vault session and the vault right
see_all_objects.
Request: TriggerExportedDataSetExecutionRequest
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 data set to export. |
Response: TriggerExportedDataSetExecutionResponse
No fields.
Related methods
- GetExportedDataSetExecutionStatus -- Gets the progress and status of the latest export run of an exported data set.