Retrieve Scheduler Data

This page includes the following:

Requests

You can use the following requests to retrieve scheduler data:

HTTP Verb Resource Input Expected Output (HTTP/1.1)
GET /scheduler For typical query parameters and query parameter formatting, see Appendix A - Query Parameters

Success code: 200 OK

Content: 

{
  "startIndex" : [Integer],
  "maxSize" : [Integer],
  "available" : [Integer],
  "results" : [
    {
      "meta" : {
        "type" : “scheduler”,
        "id" : [String],
        "uri" : "http://.../schedulers/{id}"
      },
      "jammerLastRunTime" : [String yyyy-MM-dd HH:mm:ss.SSS Z],
      "jammerLastJammedTime" : [String yyyy-MM-dd HH:mm:ss.SSS Z],
      "converterLastRunTime" : [String yyyy-MM-dd HH:mm:ss.SSS Z],
      "online" : true,
      "instanceName" : [String],
      "jobCount" : [Integer],
      "schedulerType" : [String],
      "lastEventTime" : [String yyyy-MM-dd HH:mm:ss.SSS Z],
      "canEdit" : [Boolean],
      "canDelete" : [Boolean],
      "canDownload" : [Boolean],
      "canRebuild" : [Boolean],
      "canViewLog" : [Boolean],
      "canSetOnOffLine" : [Boolean],
      "name" : [String]
    }
  ]
}
GET /machine

Query parameters:

history= [Boolean],
 fromTime= [String],
 toTime=[String],
 resolution= [String],
 topBusynessToReturn= [Integer],
 timeFormat= [String]

For additional parameters and query parameter formatting, see Appendix A - Query Parameters.

Success code: 200 OK

Content: 

{
  "startIndex" : [Integer],
  "maxSize" : [Integer],
  "available" : [Integer],
  "results" : [
    {
      "meta" : {
        "type" : [String],
        "id" : [String],
        "uri" : "http://.../machines/{id}"
      },
      "status" : [String],
      "fullName" : [String],
      "maxLoad" : [Integer],
      "overallMaxLevel" : [Integer],
      "machineName" : [String],
      "virtual" : [Boolean],
      "scheduler" : {
        "meta" : {
          "type" : [String],
          "id" : [String],
          "uri" : "http://…/schedulers/{id}"
        },
        "instanceName" : [String],
        "schedulerType" : [String],
        "name" : [String]
      },
      "type" : [String]
    }
  ]
}
GET /jobs

Query Parameters: 

scheduerId= [String]
jobName= [String]

For additional parameters and query parameter formatting, see Appendix A - Query Parameters.

Success code: 200 OK

Content: 

{
  "results" : [
    {
      "meta" : {
        "type" : "Job",
        "id" : [Integer],
        "uri" : "http://.../jobs/{id}"
      },
      "currentState" : [String],
      "jobType" : [String],
      "jobProperties" : {
        "[Name]" : [String],...
      },
      "parentage" : [String],
      "isContainer" : true,
      "timeZone" : [String],
      "name" : [String],
      "parent" : {
        ...
      }
    }
  ]
}
GET /jobs/{jobId}?fetch=conditions,conditions.all

Query Parameters:

Note: Fetch with conditions,conditions.all to return dependency conditions for the job.

Success code: 200 OK

Content: 

{
      "meta" : {
        "type" : "Job",
        "id" :  “jobId”,
        "uri" : "http://.../jobs/{id}"
      },
      "currentState" : [String],
      "jobType" : [String],
      "jobProperties" : {
        "[Name]" : [String],...
      },
      "parentage" : [String],
      "isContainer" : true,
      "timeZone" : [String],
      "name" : [String],
      "parent" : {
        ...
      },
      "conditions" :[ {
           "componentIds": ["condId1", "condId2"],
           "jobId": "{jobId}",
           "condMode": "JOB_START",
           "operator": "|"
         }, {
           "jobId": "{jobId}",
           "dependantJob": {
               "meta": {
                  "type": "Job",
                  "id": "depJobId",
                  "uri": "http:/.../jobs/depJobId"
                },
                "name": "PQJOB200",
	…
              },
            "condMode": "JOB_START",
            "state": "CA7.Success"
         },  ...
       ]     
}
GET /customConditions 
scheduerId= [String]
type= [String]

For additional parameters and query parameter formatting, see Appendix A - Query Parameters.

Success code: 200 OK

Content: 

{
  "results" : [
    {
      "meta" : {
        "type" : “CustomCondition”,
        "id" : [String],
        "uri" : "http://.../customConditions/{id}"
      },
    {
      “scheduler” : scheduler,
      “customConditionType” : [String],
      “job” : job,
      “dependantScheduler” : scheduler,
      “dependantJob” : job,
      “offset” : [String],
      “type”: [String],
      “operator”: [String],
      “value”: [Integer],
      “lookbackSec”: [Long]
    }
  ]
}
GET /jobs/{jobId}/slas

Success code: 200 OK

Content: 

[{
{
  "slaId": [String],
  "entityId": [String],
  "entityType": [String],
  "slaType": [String],
  "name": [String],
  "desc": [String],
  "sendSnmp": [Boolean],
  "sendEmail": [Boolean],
  "emailList": [String],
  "jobSchedulerId": [String],
  "value": {
    "scheduleType": [String],
    "daysOfWeek": ["MONDAY"],
    "timeZone": [String],
    "time": [String],
    "duration": [String],,
    "jobRunNumber": [Integer],
    "alertTypes":["SLA_IN_DANGER"]
  }
}
]}
GET /jobs/{jobId}/sla/predictions

Query parameter: 

fromTime= [long], 
toTime=[long]

By default, fromTime is set to scheduler ‘now’ and toTime is set to ‘now’ + forecastPeriod server param

Success code: 200 OK

Content: 

{
  "results" : [{
{
  "name": [String],
  "value":[ [String yyyy/MM/dd HH:mm:ss.SSS Z], [String yyyy/MM/dd HH:mm:ss.SSS Z ]],
}
]}
GET /jobs/{jobId}/slaAlerts

Query parameter: 

fromTime= [long], 
toTime=[long],

Success code: 200 OK

Content: 

{
  "results" : [{
  "alertId": [String],
  "alertDefinition": [String],
  "subject": [String],
  "message": [String],
  "time": [String yyyy-MM-dd HH:mm:ss.SSS Z],
  "slaId": [String],
  "slaDetail": {
      "slaId": [String],
      "entityId": [String],
      "entityType": [String],
      "slaType": [String],
      "name": [String],
      "value": {
        "scheduleType": [String],
        "daysOfWeek": ["MONDAY"],
        "timeZone": [String],
        "time": [String],
        "duration": [String],   
        "alertTypes":["SLA_IN_DANGER"],
        "jobRunNumber": [Integer]
      }
    }
} 
 ]
}
GET /slaAlerts?numDays={numDays}

Query parameter:

numDays= [integer]

Success code: 200 OK

Content: 

{
  "results" : [{
  "alertId": [String],
  "alertDefinition": [String],
  "subject": [String],
  "message": [String
  "time": [String yyyy-MM-dd HH:mm:ss.SSS Z],
  "slaId": [String],
  "slaDetail": {
      "slaId": [String],
      "entityId": [String],
      "entityType": [String],
      "slaType": [String],
      "name": [String],
      "value": {
        "scheduleType": [String],
        "daysOfWeek": ["MONDAY"],
        "timeZone": [String],
        "time": [String],
        "duration": [String],
        "alertTypes":["SLA_IN_DANGER"],
      "jobRunNumber": [Integer]
      }
    }
} 
 ]
}
GET /slaAlerts/{slaAlertId}

Success code: 200 OK

Content: 

{
  "alertId": [String],
  "alertDefinition": [String],
  "subject": [String],
  "message": [String],
  "name": [String],
  "time": [String yyyy-MM-dd HH:mm:ss.SSS Z],
  "slaId": [String],
  "sendEmail": [Boolean],
  "slaDetail": {
      "slaId": [String],
      "entityId": [String],
      "entityType": [String],
      "slaType": [String],
      "name": [String],
      "value": {
        "scheduleType": [String],
        "daysOfWeek": ["MONDAY"],
        "timeZone": [String],
        "time": [String],
        "duration": [String],
        "alertTypes":["SLA_IN_DANGER"],
        "jobRunNumber": [Integer]
      }
    }
}
GET /slas

Success code: 200 OK

Content: 

{
  "results" : [{
{
  "slaId": [String],
  "entityId": [String],
  "entityType": [String],
  "slaType": [String],
  "name": [String],
  "desc": [String],
  "sendSnmp": [Boolean],
  "sendEmail": [Boolean],
  "emailList": [String],
  "jobSchedulerId": [String],
  "value": {
    "scheduleType": [String],
    "daysOfWeek": ["MONDAY"],
    "timeZone": [String],
    "time": [String],
    "duration": [String],,
    "jobRunNumber": [Integer],
    "alertTypes":["SLA_IN_DANGER"]
  }
}
]}
GET /slas/{slaId}

Success code: 200 OK

Content: 

{
  "slaId": [String],
  "entityId": [String],
  "entityType": [String],
  "slaType": [String],
  "name": [String],
  "desc": [String],
  "sendSnmp": [Boolean],
  "sendEmail": [Boolean],
  "emailList": [String],
  "jobSchedulerId": [String],
  "value": {
    "scheduleType": [String],
    "daysOfWeek": ["MONDAY"],
    "timeZone": [String],
    "time": [String],
    "duration": [String],,
    "jobRunNumber": [Integer],
    "alertTypes":["SLA_IN_DANGER"]
  }
}
GET /slas/statuses

Query parameter:

jobIds=[string]

fromTime= [long],

toTime=[long],

Success code: 200 OK

Content: 

{
  "results" : [{
        "jobId": "alJobName",
        "slaStatuses": [{
            "sla": 
           {
             "slaId": [String],
             "entityId": [String],
             "entityType": [String],
             "slaType": [String],
             "name": [String],
             "desc": [String],
             "sendSnmp": [Boolean],
             "sendEmail": [Boolean],
             "emailList": [String],
             "jobSchedulerId": [String],
             "value": {
               "scheduleType": [String],
               "daysOfWeek": ["MONDAY"],
               "timeZone": [String],
               "time": [String],
               "duration": [String],,
               "jobRunNumber": [Integer],
               "alertTypes":["SLA_IN_DANGER"]
             }
           },
            "isPredicted": false,
            "time": "2018\/10\/08 00:00:00.000 -0600",
            "status": "SLA_IN_DANGER"
]}

Retrieve Scheduler Data Dictionary

  • schedulerId

    Allowed values: Any valid JAWS schedulerId

    Notes: For custom conditions if schedulerId is left out then all custom conditions for all schedulers is returned

  • jobName

    Allowed values: Name of a job in JAWS

  • history

    Allowed values: Whether history is requested for the machines

    Notes: Not required, default = false

  • fromTime

    Allowed values: Beginning of time interval (yyyy/MM/dd HH:mm[:ss[.S]] [z])

    Notes: Required if history=true

  • toTime

    Allowed values: End of time interval (yyyy/MM/dd HH:mm[:ss[.S]] [z])

    Notes: Required if history=true

  • resolution

    Allowed values: Sets the timescale below which to omit detail

    Example

    If set to 1:00, the resulting data summarizes the information for each minute, approximately. If not provided, all data is returned

  • topBusynessToReturn

    Allowed values: The number of machines to return with the top busyness after the filter

    Notes: If not provided, all data is returned

  • timeFormat

    Allowed values: If 'epoch', times are returned as numeric epoch values, which you don't have to parse

    Notes: Not required

  • type

    Allowed values: jobDependancy, hardStart, jobTrigger, datasetCreating

    Notes: If not provided all types would be returned