AWaws-samples
Scheduler

GET /api/scheduler/job

Changed on

GET operation for /api/scheduler/job

get/api/scheduler/job

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

scheduler_idstring

ID of scheduler. Optional if only one scheduler is configured

serialize'true' | 'false'

Choose whether to serialize output. Recommended to set to true

job_idstring required

ID of the job to retrieve

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Response

Job information retrieved successfully

successboolean

Example response

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

Changes

  • v1058396b8f0f1Revision changes
    • breaking

      the query request parameter serialize was restricted to a list of enum values

    • warning

      changed the pattern of the query request parameter scheduler_id from ^[0-9]+\.[a-zA-Z0-9_.-]+$ to ^[a-zA-Z0-9_.-]+$

    • 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

      the query request parameter scheduler_id became optional

    • info

      added the new enum value false to the query request parameter serialize

    • info

      added the new enum value true to the query request parameter serialize

    • info

      removed the pattern true/false from the query request parameter serialize

  • 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