IRPCScheduledJobsAdmin.ResetScheduledJobProgress

Administration API / specialized admin session idempotent

Resets the saved progress of an optimize vault job, so that its next run retries the failed step or starts over.

Service	Scheduled jobs `MFiles.IRPCScheduledJobsAdmin`
gRPC method	`/MFiles.IRPCScheduledJobsAdmin/ResetScheduledJobProgress`
HTTP (mf-http-grpc)	`POST /grpc/v1/reset-scheduled-job-progress`
Request	`ResetScheduledJobProgressRequest`
Response	`ResetScheduledJobProgressResponse`
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

Only for optimize vault jobs (JOB_TYPE_OPTIMIZE_VAULT); other job types fail with "The parameter is incorrect.". Fails with "The job is already running." while the job runs.
Changes only what the next run does; it does not start the job.
Allowed also when the vault is offline. Requires manage_jobs or manage_scheduled_jobs (see the service overview).

A structure that specifies the request of the method that resets the resume progress of a scheduled job.

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
`scheduled_job`	`int32`	The ID of the optimize vault job.
`start_over`	`bool`	True to start over from the first step on the next run, false to retry the failed step.

No fields.