{"id":3881,"date":"2024-08-13T10:44:38","date_gmt":"2024-08-13T05:14:38","guid":{"rendered":"https:\/\/blogs.infosys.com\/infosys-cobalt\/?p=3881"},"modified":"2024-08-13T10:44:38","modified_gmt":"2024-08-13T05:14:38","slug":"exploring-oracle-cloud-ess-job-rest-api","status":"publish","type":"post","link":"https:\/\/blogs.infosys.com\/infosys-cobalt\/cloud-applications\/oracle\/exploring-oracle-cloud-ess-job-rest-api.html","title":{"rendered":"Exploring Oracle Cloud ESS Job REST API"},"content":{"rendered":"

Oracle Fusion Cloud ESS Job REST API<\/strong><\/p>\n

Enterprise Scheduler Service (ESS) is a feature in Oracle Fusion Cloud Applications that allows to run or schedule critical, complex or time-consuming tasks and reports. We can run the scheduled jobs on ad hoc basis or on a future date and time. We can schedule the tasks or reports and send notifications on completion of the task.<\/p>\n

Oracle REST APIs for managing ESS jobs in Fusion Cloud Applications was introduced in Version 23B. Using this REST API we can automate, orchestrate and integrate ESS jobs using Oracle Integration Cloud service or any third-party integration tools.<\/p>\n

Using the scheduler REST API we can perform ESS tasks like submitting a new job request, query existing job requests, schedule new job request, cancel or hold requests also we can register a call back URL to trigger another task on completion of current request.<\/p>\n

Base path of ESS Job REST API is \/ess\/rest\/scheduler\/v1\/requests\/.The path should be appended to the oracle cloud applications host name \u00a0as mentioned below https:\/\/serverhostname.fa.ocs.oraclecloud.com\/ess\/rest\/scheduler\/v1\/requests\/<\/p>\n

Some of the basic operations are as mentioned below:<\/strong><\/p>\n

GET :<\/p>\n

1.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 List all the resources of the REST API – Path:\u00a0ess\/rest\/scheduler\/v1<\/p>\n

2.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Query job requests in a range – Path:\u00a0ess\/rest\/scheduler\/v1\/query\/{application}\/requests<\/p>\n

3.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Query all job requests – Path:\u00a0ess\/rest\/scheduler\/v1\/requests<\/p>\n

4.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Query all job requests with Page index – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/search\/{pageIndex}<\/p>\n

5.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Get specific request information – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}<\/p>\n

e.g<\/p>\n

ess\/rest\/scheduler\/v1\/requests\/?q=state eq “RUNNING\u201d<\/p>\n

ess\/rest\/scheduler\/v1\/requests\/{requestId}?fields=@full<\/p>\n

ess\/rest\/scheduler\/v1\/requests\/{requestId}?fields=@basic<\/p>\n

6.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Get permission details of\u00a0 a request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/permissions<\/p>\n

PATCH :<\/p>\n

1.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To update the specific scheduler request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}<\/p>\n

Using this method we can update request parameters, schedule information and callback URL also<\/p>\n

POST :<\/p>\n

1.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To submit a new job request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests<\/p>\n

2.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To cancel any ongoing request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/cancel<\/p>\n

3.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To validate cancelling state of request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/checkInCancelling<\/p>\n

4.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To change the status of request execution – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/executionStatus<\/p>\n

5.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To cancel a running request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/forceCancel<\/p>\n

6.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To hold a running request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/hold<\/p>\n

7.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To release request – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/release<\/p>\n

8.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To register a callback URL – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/subscribe<\/p>\n

DELETE :<\/p>\n

1.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To update a running request as deleted – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}<\/p>\n

If parent request is marked as deleted then child requests too will be automatically marked as deleted and the requests will not be available to be viewed in the scheduler UI.<\/p>\n

2.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 To cancel callback subscription – Path:\u00a0ess\/rest\/scheduler\/v1\/requests\/{requestId}\/subscribe<\/p>\n

References :\u00a0 https:\/\/docs.oracle.com\/en\/cloud\/saas\/applications-common\/24c\/farca\/api-scheduler.html<\/p>\n

Use Cases :<\/strong><\/p>\n

1.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Method to get all the requests of the instance<\/strong><\/p>\n

Method : GET<\/p>\n

URL : https:\/\/server.fa.ocs.oraclecloud.com\/ess\/rest\/scheduler\/v1\/requests<\/p>\n

Authentication : Basic<\/p>\n

Response :<\/p>\n

{<\/p>\n

“count”: 200,<\/p>\n

“items”: [<\/p>\n

{<\/p>\n

“requestId”: 8630160,<\/p>\n

“state”: “SUCCEEDED”,<\/p>\n

“stateDescription”: “Succeeded”<\/p>\n

},<\/p>\n

{<\/p>\n

“requestId”: 8630162,<\/p>\n

“state”: “WAIT”,<\/p>\n

“stateDescription”: “Wait”<\/p>\n

},<\/p>\n

….<\/p>\n

],<\/p>\n

“links”: [<\/p>\n

{<\/p>\n

“href”: “https:\/\/server.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests”,<\/p>\n

“rel”: “SELF”<\/p>\n

}<\/p>\n

],<\/p>\n

“pageIndex”: 1<\/p>\n

}<\/p>\n

2.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Method to get all details of a request<\/strong><\/p>\n

Method : GET<\/p>\n

URL : https:\/\/server.fa.ocs.oraclecloud.com\/ess\/rest\/scheduler\/v1\/requests\/8630160\/?fields=@full<\/p>\n

Authentication :\u00a0 Basic<\/p>\n

Response :<\/p>\n

{<\/p>\n

“absParentRequestId”: 8630160,<\/p>\n

“application”: “CrmEss”,<\/p>\n

“cause”: “PROCESS_SUCCESS”,<\/p>\n

“causeDescription”: “Request execution was successful”,<\/p>\n

“completedTime”: “2024-06-30T10:24:07.723Z”,<\/p>\n

“deployedApplicationName”: “ORA_CRM_ESSAPP”,<\/p>\n

“description”: “Publish Active Predefined Rules”,<\/p>\n

“dispatcher”: “ESS_SOAServer_1”,<\/p>\n

“dmsRID”: “0:566:1”,<\/p>\n

“ecid”: “e2d877fd-b9cc-4177-906a-aed16ce50f75-00000971”,<\/p>\n

“elapsedTime”: 381300,<\/p>\n

“enterpriseId”: 1,<\/p>\n

“executableState”: “SUCCEEDED”,<\/p>\n

“executionAttempt”: 1,<\/p>\n

“executionMode”: “NONE”,<\/p>\n

“executionType”: “JAVA_TYPE”,<\/p>\n

“flowId”: “0000P1cd^vU66UqLsM4EyX1aWJ1z00000w”,<\/p>\n

“instanceParentExecAttempt”: 1,<\/p>\n

“instanceParentId”: 8630160,<\/p>\n

“isAsyncRecoverable”: false,<\/p>\n

“isAsynchronous”: true,<\/p>\n

“isCancellable”: false,<\/p>\n

“isHoldable”: false,<\/p>\n

“isRecoverable”: false,<\/p>\n

“isTimedOut”: false,<\/p>\n

“jobDefinitionId”: “JobDefinition:\/\/oracle\/apps\/ess\/crmCommon\/workMgmt\/assignmentMgr\/CacheRefresher”,<\/p>\n

“jobDescription”: “Publishes assignment rules and objects, synchronizes configuration, and refreshes the candidate information used in assignment.”,<\/p>\n

“jobDisplayName”: “Perform Assignment Data Publish, Refresh, and Synchronization”,<\/p>\n

“jobType”: “JobType:\/\/oracle\/as\/ess\/ext\/JavaJobType”,<\/p>\n

“lastScheduleInstanceId”: 0,<\/p>\n

“lastSubRequestSet”: 0,<\/p>\n

“parentExecAttempt”: 0,<\/p>\n

“pausedCount”: 0,<\/p>\n

“postProcessStatus”: “PROCEED”,<\/p>\n

“preprocessStatus”: “PROCEED”,<\/p>\n

“previousState”: “COMPLETED”,<\/p>\n

“priority”: 4,<\/p>\n

“processEndTime”: “2024-06-30T10:24:04.242Z”,<\/p>\n

“processGroup”: “FADomain##ESS_SOACluster”,<\/p>\n

“processPhase”: “Complete”,<\/p>\n

“processPhaseDescription”: “Complete”,<\/p>\n

“processStartTime”: “2024-06-30T10:17:42.942Z”,<\/p>\n

“processor”: “ESS_SOAServer_1”,<\/p>\n

“product”: “MOW”,<\/p>\n

“requestId”: 8630160,<\/p>\n

“requestMode”: “Fusion”,<\/p>\n

“requestParameters”: [<\/p>\n

{<\/p>\n

“name”: “jobExecutesVirusScanOnOutputFiles”,<\/p>\n

“paramType”: “BOOLEAN”,<\/p>\n

“value”: “false”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “essAppName”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “ORA_CRM_ESSAPP”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “aflogLevel”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “EXT_PortletContainerWebModule”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “ORA_CRM_UI”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “jobDisplayName”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Perform Assignment Data Publish, Refresh, and Synchronization”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “TENANT_UUID”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “00000000-0000-0000-0000-000000000000”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “parametersVO”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “oracle.apps.crmCommon.workMgmt.assignmentMgr.publicEssModel.view.CacheRefresherVO”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “publishFlag”,<\/p>\n

“paramType”: “BOOLEAN”,<\/p>\n

“value”: “false”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “jobPackageName”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “\/oracle\/apps\/ess\/crmCommon\/workMgmt\/assignmentMgr”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “oracle.apps.fnd.applcp.invokeIncrementProcIfPresent”,<\/p>\n

“paramType”: “BOOLEAN”,<\/p>\n

“value”: “true”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “jobExecutesVirusScanOnLogFiles”,<\/p>\n

“paramType”: “BOOLEAN”,<\/p>\n

“value”: “false”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “cpAsynchJobWrapper”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “oracle.apps.fnd.applcp.request.exec.AsyncExecutableWrapper”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “logLevel”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “1”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “cpSqlFileFlag”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “F”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument5”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “false”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “filePersistenceMode”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “content”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument4”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “true”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument3”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “MOW”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument2”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “PREDEFINED_RULE_PUBLISH”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “srsFlag”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “candidateObjectCode”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “jobDefinitionName”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “CacheRefresher”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “jobDesc”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Publishes assignment rules and objects, synchronizes configuration, and refreshes the candidate information used in assignment.”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “parentRequest”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “0”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “completionText”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “productCode”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “jobDefinitionApplication”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “MOW”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “requestStepPath”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “TENANT_NAME”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “GLOBAL”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “cpJavaJobWrapper”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “oracle.apps.fnd.applcp.request.exec.ExecutableWrapper”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “ownerModule”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “shadowClassName”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “oracle.apps.crmCommon.workMgmt.assignmentMgr.ess.program.CacheRefresher”<\/p>\n

}<\/p>\n

],<\/p>\n

“requestType”: “SINGLETON”,<\/p>\n

“requestedStartTime”: “2024-06-30T10:17:13.047Z”,<\/p>\n

“retriedCount”: 0,<\/p>\n

“runAsUser”: “FUSION_APPS_CRM_ESS_APPID”,<\/p>\n

“scheduledTime”: “2024-06-30T10:17:13.047Z”,<\/p>\n

“state”: “SUCCEEDED”,<\/p>\n

“stateChangeTime”: “2024-06-30T10:24:04.242Z”,<\/p>\n

“stateDescription”: “Succeeded”,<\/p>\n

“stepId”: “0”,<\/p>\n

“subRequestSet”: 0,<\/p>\n

“submissionTime”: “2024-06-30T10:17:13.047Z”,<\/p>\n

“submitter”: “FUSION_APPS_CRM_ESS_APPID”,<\/p>\n

“submitterDmsECID”: “e2d877fd-b9cc-4177-906a-aed16ce50f75-00000971”,<\/p>\n

“submitterDmsRID”: “0”,<\/p>\n

“submitterGUID”: “C74BC0A0CC03D92FE050F90A79B05A17”<\/p>\n

}<\/p>\n

3.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Method to get basic details of a request<\/strong><\/p>\n

Method :\u00a0 GET<\/p>\n

URL : https:\/\/server.fa.ocs.oraclecloud.com\/ess\/rest\/scheduler\/v1\/requests\/8630160\/?fields=@basic<\/p>\n

Response :<\/p>\n

{<\/p>\n

“absParentRequestId”:\u00a08630160,<\/p>\n

“application”:\u00a0“CrmEss”,<\/p>\n

“cause”:\u00a0“PROCESS_SUCCESS”,<\/p>\n

“causeDescription”:\u00a0“Request\u00a0execution\u00a0was\u00a0successful”,<\/p>\n

“deployedApplicationName”:\u00a0“ORA_CRM_ESSAPP”,<\/p>\n

“description”:\u00a0“Publish\u00a0Active\u00a0Predefined\u00a0Rules”,<\/p>\n

“executionType”:\u00a0“JAVA_TYPE”,<\/p>\n

“instanceParentId”:\u00a08630160,<\/p>\n

“isAsynchronous”:\u00a0true,<\/p>\n

“jobDefinitionId”:\u00a0“JobDefinition:\/\/oracle\/apps\/ess\/crmCommon\/workMgmt\/assignmentMgr\/CacheRefresher”,<\/p>\n

“jobType”:\u00a0“JobType:\/\/oracle\/as\/ess\/ext\/JavaJobType”,<\/p>\n

“priority”:\u00a04,<\/p>\n

“processGroup”:\u00a0“FADomain##ESS_SOACluster”,<\/p>\n

“processPhase”:\u00a0“Complete”,<\/p>\n

“processPhaseDescription”:\u00a0“Complete”,<\/p>\n

“product”:\u00a0“MOW”,<\/p>\n

“requestId”:\u00a08630160,<\/p>\n

“requestType”:\u00a0“SINGLETON”,<\/p>\n

“state”:\u00a0“SUCCEEDED”,<\/p>\n

“stateDescription”:\u00a0“Succeeded”,<\/p>\n

“stepId”:\u00a0“0”<\/p>\n

}<\/p>\n

4.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Submit a simple request<\/strong><\/p>\n

Method : POST<\/p>\n

URL http:\/\/servername.fa.us2.oraclecloud.com\/ess\/rest\/scheduler\/ess\/rest\/scheduler\/v1\/requests<\/p>\n

Sample Payload :<\/p>\n

{<\/p>\n

“description”: “Identifies customer contracts”,<\/p>\n

“jobDefinitionId”: “JobDefinition:\/\/oracle\/apps\/ess\/financials\/revenueManagement\/contractObligation\/IdentifyContractObligation”,<\/p>\n

“application”: “FscmEss”,<\/p>\n

“requestParameters”:<\/p>\n

[{<\/p>\n

“name”: “submit.argument1”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “300000003474495”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument2”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “D”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument3”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “2024-03-20”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument4”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “S”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument5”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument6”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument7”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument8”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument9”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “”<\/p>\n

}<\/p>\n

]<\/p>\n

}<\/p>\n

Response :<\/p>\n

{<\/p>\n

“id”: 8748368,<\/p>\n

“links”: [<\/p>\n

{<\/p>\n

“href”: “https:\/\/servername.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748368”,<\/p>\n

“rel”: “SELF”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”: “https:\/\/servername.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748368\/cancel”,<\/p>\n

“rel”: “CANCEL”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”: “https:\/\/servername.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748368\/hold”,<\/p>\n

“rel”: “HOLD”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”: “https:\/\/servername.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748368\/release”,<\/p>\n

“rel”: “RELEASE”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”: “https:\/\/servername.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/”,<\/p>\n

“rel”: “PARENTREQUEST”<\/p>\n

}<\/p>\n

]<\/p>\n

}<\/p>\n

5.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Submit a Scheduled Request<\/strong><\/p>\n

Method : POST<\/p>\n

URL : https:\/\/servername.fa.ocs.oraclecloud.com\/ess\/rest\/scheduler\/v1\/requests\/<\/p>\n

Sample Payload:<\/p>\n

{<\/p>\n

“description”:\u00a0“Identifies\u00a0customer\u00a0contracts”,<\/p>\n

“jobDefinitionId”:\u00a0“JobDefinition:\/\/oracle\/apps\/ess\/financials\/revenueManagement\/contractObligation\/IdentifyContractObligation”,<\/p>\n

“application”:\u00a0“FscmEss”,<\/p>\n

“requestParameters”:<\/p>\n

[{<\/p>\n

“name”:\u00a0“submit.argument1”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“300000003474495”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument2”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“D”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument3”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“2024-03-20”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument4”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“S”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument5”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument6”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument7”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument8”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”:\u00a0“submit.argument9”,<\/p>\n

“paramType”:\u00a0“STRING”,<\/p>\n

“value”:\u00a0“”<\/p>\n

}<\/p>\n

],<\/p>\n

“schedule”:\u00a0{<\/p>\n

“recurrences”:\u00a0[<\/p>\n

{<\/p>\n

“icalString”:\u00a0“FREQ=MINUTELY;INTERVAL=15;”<\/p>\n

}<\/p>\n

]<\/p>\n

}<\/p>\n

<\/p>\n

Response:<\/p>\n

{<\/p>\n

“id”:\u00a08748575,<\/p>\n

“links”:\u00a0[<\/p>\n

{<\/p>\n

“href”:\u00a0“https:\/\/fa-eply-dev10-saasfaprod1.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748575”,<\/p>\n

“rel”:\u00a0“SELF”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”:\u00a0“https:\/\/fa-eply-dev10-saasfaprod1.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748575\/cancel”,<\/p>\n

“rel”:\u00a0“CANCEL”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”:\u00a0“https:\/\/fa-eply-dev10-saasfaprod1.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748575\/hold”,<\/p>\n

“rel”:\u00a0“HOLD”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”:\u00a0“https:\/\/fa-eply-dev10-saasfaprod1.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/8748575\/release”,<\/p>\n

“rel”:\u00a0“RELEASE”<\/p>\n

},<\/p>\n

{<\/p>\n

“href”:\u00a0“https:\/\/fa-eply-dev10-saasfaprod1.fa.ocs.oraclecloud.com:443\/ess\/rest\/scheduler\/v1\/requests\/”,<\/p>\n

“rel”:\u00a0“PARENTREQUEST”<\/p>\n

}<\/p>\n

]<\/p>\n

}<\/p>\n

6.\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Submit a Scheduled Request with Callback Service.<\/strong><\/p>\n

Method : POST<\/p>\n

URL : https:\/\/servername.fa.ocs.oraclecloud.com\/ess\/rest\/scheduler\/v1\/requests\/<\/p>\n

Sample Payload :<\/p>\n

{<\/p>\n

“description”: “Identifies customer contracts”,<\/p>\n

“jobDefinitionId”: “JobDefinition:\/\/oracle\/apps\/ess\/financials\/revenueManagement\/contractObligation\/IdentifyContractObligation”,<\/p>\n

“application”: “FscmEss”,<\/p>\n

“requestParameters”:<\/p>\n

[{<\/p>\n

“name”: “submit.argument1”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “300000003474495”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument2”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “D”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument3”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “2024-03-20”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument4”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “S”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument5”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument6”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “N”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument7”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument8”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “Y”<\/p>\n

},<\/p>\n

{<\/p>\n

“name”: “submit.argument9”,<\/p>\n

“paramType”: “STRING”,<\/p>\n

“value”: “”<\/p>\n

}<\/p>\n

],<\/p>\n

“callbackSubscription”:<\/p>\n

{<\/p>\n

“callbackUrlPrefix”: “https:\/\/oicservername.integration.ocp.oraclecloud.com”,<\/p>\n

“callbackResourcePath”: “\/ic\/ws\/integration\/v1\/flows\/erp\/SAMPLEINTEGRATION\/1.0\/”<\/p>\n

},<\/p>\n

“schedule”: {<\/p>\n

“recurrences”: [<\/p>\n

{<\/p>\n

“icalString”: “FREQ=MINUTELY;INTERVAL=15;”<\/p>\n

}<\/p>\n

]<\/p>\n

}<\/p>\n

Summary :<\/strong><\/p>\n

Oracle Fusion Cloud ESS Job REST API gives multiple options to schedule an ESS job, submit adhoc jobs. It can be triggered from OIC Server, VBCS Applications and other third party applications with ease.<\/p>\n","protected":false},"excerpt":{"rendered":"

Oracle Fusion Cloud ESS Job REST API Enterprise Scheduler Service (ESS) is a feature […]<\/p>\n","protected":false},"author":645,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[69,72,70,113,71],"tags":[377,277,270,378],"coauthors":[375],"class_list":["post-3881","post","type-post","status-publish","format-standard","hentry","category-oracle","category-oracle-cloud-infrastructure","category-oracle-ebs","category-oracle-erp-cloud","category-oracle-saas-cloud","tag-ess-rest-api","tag-oracle-cloud","tag-oracle-erp-cloud","tag-restapi"],"acf":[],"_links":{"self":[{"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/posts\/3881","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/users\/645"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/comments?post=3881"}],"version-history":[{"count":1,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/posts\/3881\/revisions"}],"predecessor-version":[{"id":3883,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/posts\/3881\/revisions\/3883"}],"wp:attachment":[{"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/media?parent=3881"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/categories?post=3881"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/tags?post=3881"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/blogs.infosys.com\/infosys-cobalt\/wp-json\/wp\/v2\/coauthors?post=3881"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}