IRPCScheduledJobsAdmin.StartScheduledJob
Administration API / specialized admin session idempotent
Runs a scheduled job now, outside its schedule.
| Service | Scheduled jobs MFiles.IRPCScheduledJobsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCScheduledJobsAdmin/StartScheduledJob |
| HTTP (mf-http-grpc) | POST /grpc/v1/start-scheduled-job |
| Request | StartScheduledJobRequest |
| Response | StartScheduledJobResponse |
| 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
- Starts a background job and returns before it completes; follow it with GetScheduledJobRunInfo.
- Fails with "The job is already running." if it is running.
- Rights depend on the job's type (see the service overview).
Request: StartScheduledJobRequest
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 job to run. |
Response: StartScheduledJobResponse
No fields.
Related methods
- GetScheduledJobRunInfo -- Gets the run state of a scheduled job: running or not, last and next run, errors and progress.