Jump to

• Request
• Response
• Examples

Stop the Scheduler Engine v2

post

/jderest/v2/scheduler/stop

Stop all currently running schedules and also stop the scheduler engine. IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service and use the token for calls to all scheduler services.

Request

Supported Media Types

• application/json

Header Parameters

• jde-AIS-Auth(optional): string
  Token
• jde-AIS-Auth-Device(optional): string
  Device Name
• jde-AIS-MonitorOnStart(optional): boolean
  Monitor on Start
• jde-AIS-MonitorRequest(optional): string
  Monitor Request

  Allowed Values: [ "monitorRequest", "monitorRequestIO" ]

Body ()

The input to the scheduler services.

Root Schema : SchedulerRequest

Type: object

The input to the scheduler services.

Show Source

• deviceName(optional): string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment(optional): string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• jasserver(optional): string
  The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
• jobEndpointRequested(optional): string
  Endpoint or service name to use for scheduling.
• jobServicePath(optional): array jobServicePath
  The service path for the job to be scheduled.
• numberOfTests(optional): integer(int32)
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• primaryHost(optional): object SchedulerRequest
  The input to the scheduler services.
• psToken(optional): string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• role(optional): string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• scheduleCronString(optional): string
  The cron string that provides r the schedule of the requested endpoint.
• scheduleIntervalMinutes(optional): integer(int32)
  The interval in minutes for the desired endpoint to be scheduled.
• schedulerHosts(optional): array schedulerHosts
  A list of scheduler hosts.
• schedulerServices(optional): array schedulerServices
  A list of scheduler services.
• token(optional): string
  The AIS token, which is required if other authentication methods are not being used.
• username(optional): string
  JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.

{
    "type":"object",
    "properties":{
        "environment":{
            "type":"string",
            "description":"Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used."
        },
        "role":{
            "type":"string",
            "description":"The role to use for login. If not specified, the default role configured for the AIS Server will be used."
        },
        "jasserver":{
            "type":"string",
            "description":"The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used."
        },
        "token":{
            "type":"string",
            "description":"The AIS token, which is required if other authentication methods are not being used."
        },
        "deviceName":{
            "type":"string",
            "description":"An identifier for the device making the service call. If not provided, the requesting IP address is used."
        },
        "psToken":{
            "type":"string",
            "description":"Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server."
        },
        "username":{
            "type":"string",
            "description":"JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used."
        },
        "password":{
            "type":"string",
            "description":"The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used."
        },
        "jobEndpointRequested":{
            "type":"string",
            "description":"Endpoint or service name to use for scheduling."
        },
        "scheduleIntervalMinutes":{
            "type":"integer",
            "format":"int32",
            "description":"The interval in minutes for the desired endpoint to be scheduled."
        },
        "jobServicePath":{
            "type":"array",
            "description":"The service path for the job to be scheduled.",
            "items":{
                "type":"string"
            }
        },
        "scheduleCronString":{
            "type":"string",
            "description":"The cron string that provides r the schedule of the requested endpoint."
        },
        "schedulerHosts":{
            "type":"array",
            "description":"A list of scheduler hosts.",
            "items":{
                "$ref":"#/definitions/SchedulerRequest"
            }
        },
        "schedulerServices":{
            "type":"array",
            "description":"A list of scheduler services.",
            "items":{
                "$ref":"#/definitions/SchedulerService"
            }
        },
        "numberOfTests":{
            "type":"integer",
            "format":"int32"
        },
        "primaryHost":{
            "$ref":"#/definitions/SchedulerRequest"
        }
    },
    "description":"The input to the scheduler services."
}

Nested Schema : jobServicePath

Type: array

The service path for the job to be scheduled.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The service path for the job to be scheduled.",
    "items":{
        "type":"string"
    }
}

Nested Schema : schedulerHosts

Type: array

A list of scheduler hosts.

Show Source

• Array of: object SchedulerRequest
  The input to the scheduler services.

{
    "type":"array",
    "description":"A list of scheduler hosts.",
    "items":{
        "$ref":"#/definitions/SchedulerRequest"
    }
}

Nested Schema : schedulerServices

Type: array

A list of scheduler services.

Show Source

• Array of: object SchedulerService
  The input to the scheduler services where a list is requested.

{
    "type":"array",
    "description":"A list of scheduler services.",
    "items":{
        "$ref":"#/definitions/SchedulerService"
    }
}

Nested Schema : SchedulerService

Type: object

The input to the scheduler services where a list is requested.

Show Source

• environment(optional): string
• role(optional): string
• serviceEndpoint: string
  Endpoint or service name to use for scheduling.
• username(optional): string

{
    "type":"object",
    "required":[
        "serviceEndpoint"
    ],
    "properties":{
        "serviceEndpoint":{
            "type":"string",
            "description":"Endpoint or service name to use for scheduling."
        },
        "username":{
            "type":"string"
        },
        "environment":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    },
    "description":"The input to the scheduler services where a list is requested."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Execution

400 Response

Bad Request - Invalid JSON Input

403 Response

Authorization Failure

415 Response

Invalid Content-Type Header - Must use application/json

444 Response

Invalid Token

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

500 Response

Server Failed to Process Request

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

Examples

Example Request

The following shows an example of a scheduler stop request, which stops all of the currently running jobs and the scheduler engine.

The token passed in this example was received from a separate token request. You can also use other supported authentication methods.

IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service and use the token for calls to all scheduler services.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/scheduler/stop -d 

{   
    "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU="
}

        

Example Response

The following example shows the contents of the response body.

{"jobsstopped": [
      {
      "jobBaseUrl": "ais_server_url",
      "jobEndpointRequested": "ORC_1708110004TOOLS",
      "jobLastExecutionTimeMillis": 112,
      "jobLastExecutionDateTime": "2017-08-25 17:43:03.534",
      "jobServicePath":       [
         "jderest",
         "v2",
         "orchestrator"
      ],
      "jobNextFireTime": "2017-08-26 17:43:03 534",
      "jobTotalExecutions": 1,
      "jobTotalErrors": 0,
      "jobConsecutiveErrors": 0,
      "jobPercentageErrors": 0,
      "serviceShortEndpoint": "ORC_1708110004TOOLS",
      "serviceLongEndpoint": "Activate Demo",
      "omwServiceDescription": "Activate Demo",
      "omwScheduleDescription": "Run Once Daily",
      "scheduleIntervalMinutes": 1440,
      "jobgroup": "SCH_1708140001TOOLS",
      "jobname": "ORC_1708110004TOOLS"
   },
      {
      "jobBaseUrl": "ais_server_url",
      "jobEndpointRequested": "NTF_1708250001TOOLS",
      "jobLastExecutionTimeMillis": 191,
      "jobLastExecutionDateTime": "2017-08-25 17:43:03.29",
      "jobServicePath":       [
         "jderest",
         "v2",
         "notification"
      ],
      "jobNextFireTime": "2017-08-26 17:43:03 290",
      "jobTotalExecutions": 1,
      "jobTotalErrors": 0,
      "jobConsecutiveErrors": 0,
      "jobPercentageErrors": 0,
      "serviceShortEndpoint": "NTF_1708250001TOOLS",
      "serviceLongEndpoint": "DemoNotification",
      "omwServiceDescription": "DemoNotification",
      "omwScheduleDescription": "Run Once Daily",
      "scheduleIntervalMinutes": 1440,
      "jobgroup": "SCH_1708140001TOOLS",
      "jobname": "NTF_1708250001TOOLS"
   }
]}
        

Back to Top