IRPCPropertyDefsAdmin.RecalculateProperty
Administration API / specialized admin session
Starts a server job that recalculates the automatic values of a property in all existing objects.
| Service | Property definition and class administration MFiles.IRPCPropertyDefsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCPropertyDefsAdmin/RecalculateProperty |
| HTTP (mf-http-grpc) | POST /grpc/v1/recalculate-property |
| Request | RecalculatePropertyRequest |
| Response | RecalculatePropertyResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Starts a temporary server-level scheduled job and returns before it completes.
task_idis the job's ID; M-Files Admin follows it with GetScheduledJobRunInfo from a server-level session. - Changes property values of existing objects. Requires
change_metadata_structureandlicense_allows_modifications.
Request: RecalculatePropertyRequest
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 |
|---|---|---|
property_def | int32 | The ID of the property to recalculate. |
null_values_only | bool | True to fill in only empty values, false to recalculate every value. |
Response: RecalculatePropertyResponse
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 |
|---|---|---|
task_id | int32 | The ID of the scheduled job that does the work. |
Related methods
- IRPCScheduledJobsAdmin.GetScheduledJobRunInfo -- Gets the run state of a scheduled job: running or not, last and next run, errors and progress.