Get Scheduler Job Locks
GET /obp/v7.0.0/management/system/scheduler/job-locks
OBPv7.0.0-getSchedulerJobs Roles: CanGetSchedulerJobLocks SystemAPI
List the scheduler lock rows from the jobscheduler table (most recent first, up to 100).
This is a lock table, not a job-history log. A row exists only while a
scheduled job (e.g. MetricsArchiveScheduler) holds its lock; it is deleted
when the job finishes. So in healthy operation this list is empty.
A row that is present is therefore one of:
- a job genuinely running right now (small
age_seconds), or - a stale lock left by a JVM that died mid-run (large
age_seconds) — this blocks new runs of that job (e.g. "Trigger a Metrics Archive Run" returnsskipped_already_in_progress). Clear it withDELETE /management/system/scheduler/job-locks/JOB_ID.
Each row reports job_id, name, api_instance_id, started_at and
age_seconds (seconds since the lock was taken).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (7)
- age_seconds
- age_seconds
- api_instance_id
- api_instance_id
- count
- job_id
- job_id
- jobs
- jobs
- name
- ACCOUNT_MANAGEMENT_FEE
- started_at
- started_at
Example success response
{
"jobs": [
{
"job_id": "9f3c2b1a-7d4e-4c8a-9b2f-1e6d5a0c4b7e",
"name": "MetricsArchiveScheduler",
"api_instance_id": "obp",
"started_at": "2024-06-01T00:00:00Z",
"age_seconds": 42
}
],
"count": 1
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.