IRPCExportedDataSetsAdmin.GetExportedDataSetExecutionStatus
Administration API / specialized admin session idempotent
Gets the progress and status of the latest export run of an exported data set.
| Service | Exported data set administration MFiles.IRPCExportedDataSetsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCExportedDataSetsAdmin/GetExportedDataSetExecutionStatus |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-exported-data-set-execution-status |
| Request | GetExportedDataSetExecutionStatusRequest |
| Response | GetExportedDataSetExecutionStatusResponse |
| 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
- Requires a vault session and the vault right
see_all_objects. An unknown ID fails with "Not found.".
Request: GetExportedDataSetExecutionStatusRequest
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. |
Response: GetExportedDataSetExecutionStatusResponse
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 |
|---|---|---|
progress_percent | int32 | The progress of the current run, 0-100. |
status_explanation | string | The current status; the error message if the run failed. |
status_time | google.protobuf.Timestamp | When the status was last updated. |