IRPCExportedDataSets.GetDataSetExportingStatusBasic
Vault API / standard read session idempotent
Tells whether a data set is being exported right now and when its export status last changed.
| Service | Exported data sets MFiles.IRPCExportedDataSets |
|---|---|
| gRPC method | /MFiles.IRPCExportedDataSets/GetDataSetExportingStatusBasic |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-data-set-exporting-status-basic |
| Request | GetDataSetExportingStatusBasicRequest |
| Response | GetDataSetExportingStatusBasicResponse |
| Book and level | Vault API, standard |
| Kind | read |
| 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 Reporting module in the license. Fails if the data set is disabled, and with "Not found." for an unknown ID.
exportingis true while the export process reports progress (0-100) for the data set, and false once it has reported that the export is not running.- Compare
latest_activitywithcurrent(both server time) to see how recent the status is.
Request: GetDataSetExportingStatusBasicRequest
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: GetDataSetExportingStatusBasicResponse
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 |
|---|---|---|
exporting | bool | True if the data set is being exported. |
current | google.protobuf.Timestamp | The current server time. |
latest_activity | google.protobuf.Timestamp | When the export process last updated the status of the data set. Unset if it never has. |