IRPCExportedDataSets.GetExportedDataSets

View as Markdown

Vault API / standard read session idempotent

Gets all exported data sets of the vault.

Service	Exported data sets `MFiles.IRPCExportedDataSets`
gRPC method	`/MFiles.IRPCExportedDataSets/GetExportedDataSets`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-exported-data-sets`
Request	`GetExportedDataSetsRequest`
Response	`GetExportedDataSetsResponse`
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; no special vault rights.
Returns an empty list when the license does not include the Reporting module.
database_connection_string is empty unless the user has the vault right see_all_objects (VaultAccess).

Request: GetExportedDataSetsRequest

No fields.

Response: GetExportedDataSetsResponse

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
`results[]`	repeated `ExportedDataSet`	The exported data sets. See ExportedDataSet.
`results[].id`	`int32`	Exported data set ID.
`results[].name`	`string`	The name of the data set.
`results[].object_types[]`	repeated `ExportedDataObjectType`	Root nodes representing an object type.
`results[].object_types[].object_type`	`int32`	Object type or value list ID.
`results[].object_types[].property_defs[]`	repeated `ExportedDataPropertyDef`	Child property definition nodes.
`results[].object_types[].object_filter`	`SearchConditionArray`	The filtering conditions that limit the object set of this node.
`results[].options`	`EXPORTEDDATASETFLAGS`	Data set flags.
`results[].options.all`	`bool`	Specifies all flags set; Including any future flags.
`results[].options.disabled`	`bool`	Present if the data set is disabled. If not present, the data set is enabled.
`results[].options.scheduled`	`bool`	Present if the data set execution is scheduled.
`results[].options.incremental`	`bool`	Exported data set flags.
`results[].schedule`	`bytes`	The schedule of this data set extraction (a serialized Task object of Task Scheduler).
`results[].database_connection_string`	`string`	The database connection string.
`results[].run_as_user_id`	`int32`	"Run as" user id for the exported data set.
`results[].database_schema`	`ExportedDataSetDBSchema`	The database schema.Values: `EXPORTED_DATA_SET_DBSCHEMA_GENERIC` (0).