IRPCReplicationPackages.GetReplicationPackages

View as Markdown

Server integration API / specialized internal: not for applications read session idempotent

Lists the replication packages in the given cloud storage location that this vault has not imported yet.

ServiceReplication packages MFiles.IRPCReplicationPackages
gRPC method/MFiles.IRPCReplicationPackages/GetReplicationPackages
HTTP (mf-http-grpc)POST /grpc/v1/get-replication-packages
RequestGetReplicationPackagesRequest
ResponseGetReplicationPackagesResponse
Book and levelServer integration API, specialized
Kindread
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

For M-Files components only. M-Files Admin calls it to show the packages in its Manage Replication dialog. Applications should not call it.

Request: GetReplicationPackagesRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
connection_stringstringThe cloud storage connection string as M-Files Admin composes it from the job's replication settings.

Response: GetReplicationPackagesResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
replication_packages[]repeated ReplicationPackageInfoOne entry per package: name is the package folder name and status a display text in the server's language ("In queue", "Next in queue" or "Failed" in English).
replication_packages[].namestringThe display name of the item.
replication_packages[].statusstringThe status of the item.