IRPCReplicationPackages.GetReplicationPackages
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.
| Service | Replication packages MFiles.IRPCReplicationPackages |
|---|---|
| gRPC method | /MFiles.IRPCReplicationPackages/GetReplicationPackages |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-replication-packages |
| Request | GetReplicationPackagesRequest |
| Response | GetReplicationPackagesResponse |
| Book and level | Server integration API, specialized |
| 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
For M-Files components only. M-Files Admin calls it to show the packages in its Manage Replication dialog. Applications should not call it.
- Requires a vault session and the vault right
change_full_control_role. Without it the call fails with access denied. - Packages already imported into the session's vault are left out.
- An empty or malformed
connection_stringfails with an "Invalid pointer." error.
Request: GetReplicationPackagesRequest
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 |
|---|---|---|
connection_string | string | The 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.
| Field | Type | Description |
|---|---|---|
replication_packages[] | repeated ReplicationPackageInfo | One 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[].name | string | The display name of the item. |
replication_packages[].status | string | The status of the item. |