IRPCExportedDataSets.GetExportedDataSet
Vault API / standard read session idempotent
Gets one exported data set by ID.
| Service | Exported data sets MFiles.IRPCExportedDataSets |
|---|---|
| gRPC method | /MFiles.IRPCExportedDataSets/GetExportedDataSet |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-exported-data-set |
| Request | GetExportedDataSetRequest |
| Response | GetExportedDataSetResponse |
| 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. An unknown ID fails with "Not found.".
database_connection_stringis empty unless the user has the vault rightsee_all_objects.
Request: GetExportedDataSetRequest
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 exported data set. |
Response: GetExportedDataSetResponse
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 |
|---|---|---|
pexpdataset | ExportedDataSet | The exported data set. See ExportedDataSet. |
pexpdataset.id | int32 | Exported data set ID. |
pexpdataset.name | string | The name of the data set. |
pexpdataset.object_types[] | repeated ExportedDataObjectType | Root nodes representing an object type. |
pexpdataset.object_types[].object_type | int32 | Object type or value list ID. |
pexpdataset.object_types[].property_defs[] | repeated ExportedDataPropertyDef | Child property definition nodes. |
pexpdataset.object_types[].object_filter | SearchConditionArray | The filtering conditions that limit the object set of this node. |
pexpdataset.options | EXPORTEDDATASETFLAGS | Data set flags. |
pexpdataset.options.all | bool | Specifies all flags set; Including any future flags. |
pexpdataset.options.disabled | bool | Present if the data set is disabled. If not present, the data set is enabled. |
pexpdataset.options.scheduled | bool | Present if the data set execution is scheduled. |
pexpdataset.options.incremental | bool | Exported data set flags. |
pexpdataset.schedule | bytes | The schedule of this data set extraction (a serialized Task object of Task Scheduler). |
pexpdataset.database_connection_string | string | The database connection string. |
pexpdataset.run_as_user_id | int32 | "Run as" user id for the exported data set. |
pexpdataset.database_schema | ExportedDataSetDBSchema | The database schema.Values: EXPORTED_DATA_SET_DBSCHEMA_GENERIC (0). |