IRPCPropertyDefsAdmin.UpdateObjectNames
Administration API / specialized admin session
Starts a server job that recalculates the names of all objects of a class from the class's name property.
| Service | Property definition and class administration MFiles.IRPCPropertyDefsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCPropertyDefsAdmin/UpdateObjectNames |
| HTTP (mf-http-grpc) | POST /grpc/v1/update-object-names |
| Request | UpdateObjectNamesRequest |
| Response | UpdateObjectNamesResponse |
| 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. - Requires
change_metadata_structureandlicense_allows_modifications. - Fails with an invalid-argument error when the class uses Name or title (property 0) as its name property: there is nothing to recalculate.
Request: UpdateObjectNamesRequest
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 |
|---|---|---|
doc_class | int32 | The ID of the class whose objects are renamed. |
Response: UpdateObjectNamesResponse
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.