AWaws-samples
Scheduler

GET /api/scheduler/jobs

Changed on

GET operation for /api/scheduler/jobs

get/api/scheduler/jobs

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Query parameters

userstring

Filter jobs by specific user (returns all jobs if not specified)

queuestring

Filter jobs by specific queue (returns all jobs if not specified)

scheduler_idstring

Filter jobs by specific scheduler_id (returns all jobs if not specified)

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Response

Jobs retrieved successfully

successboolean

Example response

{
  "success": true,
  "message": {
    "jobs": [
      {
        "Job_Name": "my_job",
        "Job_Owner": "john.doe@cluster",
        "job_state": "R",
        "queue": "normal"
      }
    ],
    "scheduler_errors": []
  }
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API