IRPCScheduledJobsAdmin.RemoveScheduledJob
Administration API / specialized admin session
Removes a scheduled job.
| Service | Scheduled jobs MFiles.IRPCScheduledJobsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCScheduledJobsAdmin/RemoveScheduledJob |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-scheduled-job |
| Request | RemoveScheduledJobRequest |
| Response | RemoveScheduledJobResponse |
| 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
- Destructive. The job definition is deleted; the job no longer runs.
- Rights depend on the job's type (see the service overview); an unknown ID fails with "Not found.".
Request: RemoveScheduledJobRequest
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 remove. |
Response: RemoveScheduledJobResponse
No fields.