IRPCExportedDataSetsAdmin.ModifyExportedDataSet

View as Markdown

Administration API / specialized admin session idempotent

Replaces the definition of an exported data set.

Service	Exported data set administration `MFiles.IRPCExportedDataSetsAdmin`
gRPC method	`/MFiles.IRPCExportedDataSetsAdmin/ModifyExportedDataSet`
HTTP (mf-http-grpc)	`POST /grpc/v1/modify-exported-data-set`
Request	`ModifyExportedDataSetRequest`
Response	`ModifyExportedDataSetResponse`
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

The data set is identified by expdataset.dataset.id; the whole definition is replaced.
Requires a vault session and the vault right see_all_objects. Without the server right run_code, the connection string may change only in its credentials, and only with the vault right run_signed_code (part of full control); pointing it to another data source fails with "Access denied.".

Request: ModifyExportedDataSetRequest

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
`expdataset`	`ExportedDataSetAdmin`	The complete new definition, with the `dataset.id` of the data set to change.
`expdataset.dataset`	`ExportedDataSet`	The non-admin version of the struct.
`expdataset.dataset.id`	`int32`	Exported data set ID.
`expdataset.dataset.name`	`string`	The name of the data set.
`expdataset.dataset.object_types[]`	repeated `ExportedDataObjectType`	Root nodes representing an object type.
`expdataset.dataset.options`	`EXPORTEDDATASETFLAGS`	Data set flags.
`expdataset.dataset.schedule`	`bytes`	The schedule of this data set extraction (a serialized Task object of Task Scheduler).
`expdataset.dataset.database_connection_string`	`string`	The database connection string.
`expdataset.dataset.run_as_user_id`	`int32`	"Run as" user id for the exported data set.
`expdataset.dataset.database_schema`	`ExportedDataSetDBSchema`	The database schema.Values: `EXPORTED_DATA_SET_DBSCHEMA_GENERIC` (0).
`expdataset.aliases`	`string`	Semicolon-separated list of semantic aliases.

Response: ModifyExportedDataSetResponse

No fields.