IRPCExportedDataSets.TriggerExportedDataSetRefresh
Vault API / standard write session idempotent
Asks for an export of the data set to start now, outside its schedule.
| Service | Exported data sets MFiles.IRPCExportedDataSets |
|---|---|
| gRPC method | /MFiles.IRPCExportedDataSets/TriggerExportedDataSetRefresh |
| HTTP (mf-http-grpc) | POST /grpc/v1/trigger-exported-data-set-refresh |
| Request | TriggerExportedDataSetRefreshRequest |
| Response | TriggerExportedDataSetRefreshResponse |
| Book and level | Vault API, standard |
| Kind | write |
| 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
- Requires the vault right
trigger_data_exportand the Reporting module in the license. - Fails if the data set is disabled, and with "Not found." for an unknown ID.
- The call only records the time of the request (returned as
last_manual_execution_triggeredby GetDataSetAuxiliaryExecutionControlState); the export process notices it and runs the export. Follow the progress with GetDataSetExportingStatusBasic. - Cancel a running export with the administration service (CancelExportedDataSetExecution).
Request: TriggerExportedDataSetRefreshRequest
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: TriggerExportedDataSetRefreshResponse
No fields.
Related methods
- GetDataSetAuxiliaryExecutionControlState -- Gets when an export of the data set was last requested or cancelled by hand. Used by the export process.
- GetDataSetExportingStatusBasic -- Tells whether a data set is being exported right now and when its export status last changed.
- IRPCExportedDataSetsAdmin.CancelExportedDataSetExecution -- Requests that a running export of an exported data set stops.