IRPCServerAdmin.GetPerformanceMeasurementsAsJSON
Administration API / specialized admin session idempotent
Gets the current results of a vault database performance measurement as JSON.
| Service | Server administration MFiles.IRPCServerAdmin |
|---|---|
| gRPC method | /MFiles.IRPCServerAdmin/GetPerformanceMeasurementsAsJSON |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-performance-measurements-as-json |
| Request | GetPerformanceMeasurementsAsJSONRequest |
| Response | GetPerformanceMeasurementsAsJSONResponse |
| 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
- Requires a vault session with the vault right
change_full_control_role. Without it the call fails with "Access denied." ; a server-level session fails with "Login required.". - An unknown or ended measurement ID fails with "Not found.".
- The JSON format is that of M-Files Admin's vault information page and is not otherwise documented.
Request: GetPerformanceMeasurementsAsJSONRequest
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 |
|---|---|---|
background_op_id | int32 | The ID returned by BeginPerformanceMeasurementsAsJSON. |
Response: GetPerformanceMeasurementsAsJSONResponse
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_as_json_ | string | The measurement results as a JSON document. |