Mirror of Oracle documentation

Converted for search and offline reading. Authoritative source: Oracle. Diagrams and some complex tables are simplified — check the PDF when in doubt.

10 Invoking POM Services

This chapter lists the ReST APIs that can be invoked and the steps needed to invoke them.

All the POM APIs are protected by the Oauth standard. It allows users to securely delegate access to resources without sharing their original credentials. Oauth2 has been around since 2012 as a standard and is built on lessons from other, earlier standards, including Oauth1 and SAML.

Note

ReST service calls from POM to external systems (customers), such as the call for External Status Update, are limited to Basic Auth at this time.

Oauth Token Generation

Using the Oauth protocol is a two-step process:

Request an access token from an authentication provider: IDCS or OCI IAM.
Provide the access token as an authorization header when invoking a service.

Prerequisite

Customers are required to create an OAuth client using the Retail Home Create IDCS OAuth 2.0 Client function. The OAuth client must be created against the “POM” app with the scope

rgbu:pom:services-customer-administrator-<ENV_ID>

where <ENV_ID> represents the unique environment identifier such as PRD1, STG1, DEV1 and so on.

For example, the DEV1 scope would be:

rgbu:pom:services-customer-administrator-DEV1

For more information about creating the OAuth client (one-time setup), refer to the “Creating IDCS OAuth 2.0 Client Apps” chapter in the Retail Home Administration Guide .

Invoke IDCS Token Endpoint

To generate a token from IDCS, the following information is needed:

IDCS URL
Client Id and Client Secret
OAuth Scope

The curl command below invokes an IDCS service to generate an access token:

curl -I

  -H 'Authorization: Basic <base64Encoded Oauth_Clientid:Secret>'
  -H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8'
  --request POST <IDCS_URL>/oauth2/v1/token
  -d 'grant_type=client_credentials&scope=rgbu:pom:services-customer-
administrator-<ENV_ID>'

This is a standard ReST call, with the following specifics:

<IDCS URL> is the IDCS URL of this instance.
<base64Encoded OAuth_Clientid:Secret> is the Base64-encoded OAuth Client Id and Client Secret provided as a Basic Authentication header.
Specify the body as:

grant_type=client_credentials&scope=
rgbu:pom:services-customer-administrator-<ENV_ID>

The response to this call will be in this format:

{
      "access_token": "<TOKEN>",
      "token_type": "Bearer",
      "expires_in": 3600
}

Invoking the POM Service

To invoke the POM ReST service, you must add an authorization header as Bearer , that is:

The word Bearer
A space
A valid token obtained as described above

For example, the POM nightly cycle start request would look something like the following:

curl -i
  -H 'Authorization: Bearer <OAuth Token>'
  -H 'Content-Type: application/json'
  --request POST 'https://<pom-server-host>/ProcessServices/services/private/
executionEngine/schedules/<Schedule_Name>//execution?skipVersion'
  -d '{ "cycleName" : "Nightly",  "flowName" : "Nightly"}'

HTTP Method

GET

Path

https://<pom-server-host>/ProcessServices/ services/public/
schedules/

<pom-server-host> - This is the POM URL

HTTP Headers

Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation Response Body Sample Response

{
  "schedules": [
     {
        "name": "MERCH",
        "displayScheduleName": "MERCH",
        "description": "Merch Batch Schedule",
        "version": "23.0.101",
        "creationDate": "2023-03-23",
        "schedulerEnabled": true,
        "executionEngineEnabled": false
     }
  ]
}

Parameter Description Schedules Array containing all the schedules name Name of the Batch Schedule displayScheduleName The name of the Schedule to be used for display purposes within POM. description Description of the Batch Schedule version Version of the Batch Schedule creationDate Creation Date

View Batch Cycles for Schedule

This endpoint will provide a list of Batch Cycles for the given schedule.

HTTP Method GET Path

https://<pom-server-host>/ProcessServices/ services/public/
schedules/<schedule-name>/cycles

<pom-server-host> - This is the POM URL. <schedule-name> - This is the name of the Schedule.

HTTP Headers

Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation

Response Body Sample Response

{
  "cycles": [
    {
      "cycleNumber": 1,
      "cycleName": "Adhoc",
      "cycleType": "A",
      "sequenceNumber": 1,
      "invokableCount": 225
    },
    {
      "cycleNumber": 2,
      "cycleName": "Nightly",
      "cycleType": "N",
      "sequenceNumber": 1,
      "jobCount": 385
    }
  ]
}

Parameter Description cycles Array containing all the cycles cycleNumber Cycle Number cycleName Cycle Name cycleType Type of Batch Cycle: • Adhoc - Adhoc or Standalone Cycle • Nightly - Nightly or EOD Cycle. • Hourly_Cycle_ - Hourly or Recurring Cycle. The is a number between 1 and 24. invokableCount The number of invokeable batch entities on the Adhoc Cycle. This value is only defined for the Adhoc Cycle, and will not be present for the other Cycles. jobCount The number of invokeable Jobs on the Cycle. This value is present for the Nightly and Hourly Cycles only.

Batch Execution API

Different SaaS customers operate in different models for running their batch. Some may choose to use the POM Scheduler to schedule the different entities such as Nightly, Recurring or Standalone. Refer to the POM User Guide for documentation on the POM Scheduler.

Others may choose to control the time and frequency of batch executions by invoking the provided ReST APIs. This section describes these APIs.

Execution Request Creation

POM also provides users the capability to control the time and frequency of batch executions by invoking the following ReST service.

HTTP

POST

Method

Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /executionRequests/

<pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked.

Note: Previously the private endpoint was exposed for this purpose: https:// <pom-server-host> /ProcessServices/services/private/executionEngine/ schedules/ <schedule-name> /execution

This is now deprecated. You should use the PUBLIC endpoint, because the private endpoints could change without notice.

HTTP Content-Type = application/json Headers Include Authorization header as shown in Oauth Token Generation

Request Body

{
    "cycleName"         : "<Cycle name>",
    "flowName"          : "<Flow name>",
    "processName"       : "<Process name>",
    "requestParameters" : "<Comma-separated key-value pairs>"
}

Parameter	Description
`cycleName`	Name of the Batch Cycle being invoked. Valid values are:
	• `"Nightly"`
	• `"Adhoc"`
	• `"Hourly_Cycle_N"`– (Replace`N`with the Hourly cycle number)
`flowName`	Name of the Batch Flow being invoked. In case of the Nightly Cycle invocation, the value is `"Nightly"`. For Adhoc Processes, the value is `"Adhoc"`itself.
`processName`	Name of the Batch Process being invoked. Needed only when invoking Processes on Adhoc Cycles.
`requestParameters`	Optional attribute. This is useful if external systems are providing custom identifers to POM and expect them to be returned on callbacks sent from POM.

Response Body { "value" :" Execution Request ID", "cycleName" :" Cycle name", "flowName" :" Flow name", "processName" :" Process name", "requestType" :" Request type", "requestParameters" :" Comma-separated key-value pairs", "executionEngineInfo" :" Status of Execution Engine", "hyperMediaContent" : {} }

Parameter	Description
`value`	This unique identifer is the Execution Request ID. This can be used for tracking purposes.
`executionEngineInfo`	Indicates the status of the Execution Engine after creating the request. If this is not `STARTED`, then the Execution Engine may be experiencing some issues.
`hyperMediaContent`	Can be ignored. Used internally by the ReST APIs as part of the HATEOAS standards.

Examples of all the Batch Entities in POM that can be invoked by the endpoint above, are shown in the table below:

Invocation Request Payload Nightly Flow { "cycleName": "Nightly", "flowName": "Nightly", "requestParameters": "callerId=X,correlationId=123" } Note: The Nightly Cycle contains a single default Nightly Flow. Hence a single invocation will suffice to start the Nightly Flow. Hourly Flow

{
    "cycleName": "Hourly_Cycle_<N>",
    "flowName": "SALESPROCESS_FLOW",
    "requestParameters": "callerId=X,correlationId=456"
}

<N> - This is the cycle number (1 to 24)

Note: The Hourly Cycles comprise of many distinct Batch Flows and for each Batch Flow a separate invocation is required.

Invocation Request Payload

Adhoc Flow { "cycleName": "Adhoc", "flowName": "SALESPROCESS_ADHOC_FLOW", "requestParameters": "callerId=X,correlationId=456" }

Note: The Adhoc Cycle comprises of many distinct Batch Flows and for each Batch Flow a separate invocation is required.

Adhoc Process

{
    "cycleName": "Adhoc",
    "flowName": "Adhoc",
    "processName": "RPM_LOCATION_PROCESS _ADHOC",
    "requestParameters": "callerId=E,correlationId=789"
}

In case of Adhoc Batch Processes, the parameters for Batch Jobs can be overridden by parameters specified as part of the invocation request.

{
    "cycleName": "Adhoc",
    "flowName":"Adhoc   ",
    "processName": "RPM_LOCATION_PROCESS _ADHOC",
    "requestParameters": "jobParams.RPM_JOB=param1|param2"
}

Note: Adhoc Cycles are composed of many discrete individual Batch Processes. For each Batch Process, a separate invocation is required.

Execution Request Status

The endpoint below can be used to check the status of an Execution Request in POM.

HTTP GET Method

Path

https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /executionRequests/ <execution-Id> Note: Previously the private endpoint was exposed for this purpose. https:// <pom-server-host> /ProcessServices/services/private/ executionEngine/schedules/ <schedule-name> /requests/<execution-Id> This is now deprecated. It is advised to use the PUBLIC endpoint as the private endpoints could change without notice.

Parameter	Description
`<pom-server-host>`	This is the POM URL.
`<schedule-name>`	Name of the schedule being invoked.
`<executionId>`	ID of the Execution Request returned by POM.

HTTP Content-Type = application/json Headers Include Authorization header as shown in Oauth Token Generation

Response Body

"executionId": " Execution Request ID",
"scheduleName": " Schedule Name",
"cycleName": " Cycle name", "flowName": " Flow name",
"processName": " Process name",
"requestType": " Request type",
"requestParameters": " Comma-separated key-value pairs",
"executionEngineInfo": " Status of Execution Engine",
"hyperMediaContent": {}

Parameter	Description
`executionId`	ID of the execution request.
`scheduleName`	Name of the schedule.
`cycleName`	Name of the Cycle for which the execution request was created.
`flowName`	Name of the Flow for which the execution request was created
`processName`	Name of the Process. For Nightly/Hourly this is set to`"ALL"`.
`requestParameters`	Parameters associated with the execution request.
`status`	Status of the execution request. Possible Values
	• QUEUED- Request is queued up for execution. • RUNNING- Jobs from this request are being executed.
	• ERROR- One of the job in this request has failed. Note that a failed job would be restarted by POM Admin; there is no need to re-submit the execution request.
	• COMPLETED- All jobs from this request were executed successfully.

Execution Request Details

The endpoint below provides the detailed status of an Execution Request in POM

HTTP Method GET

Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /executionRequests/ <execution-Id> / details

HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation

Response Body Sample Response:

{
  "execRequestDetails": [
    {
      "processName": "ADMIN_API_PURGE_PROCESS",
      "jobName": "ADMIN_API_PURGE_JOB",
      "status": "ERROR",
      "jobRunId": 276845,
      "firstJobInd": "Y",
      "lastJobInd": "Y",
      "errorInfo": "Job Agent call failed : Error message:
Unable to invoke Job Agent, Cause: Unknown",
      "executionId": 101,
      "lastUpdateDate": "2024-05-29 16:56:47"
    }
  ]
}

Execution Requests for Batch Cycle

This endpoint fetches all the Execution Requests for a given Schedule and given Batch Cycle

HTTP Method GET Path https:// <pom-server-host> /ProcessServices/ services/public/ schedules/ <schedule-name> / executionRequests? cycleName =XX <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. cycleName - Mandatory query parameter. This is the name of the Batch Cycle. HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation

Response Body Sample Response

{
   "schedulerDay": 2001,
   "businessDate": "2023-4-18",
   "execRequests": [
      {
         "requestType": "SCHEDULER_REQUEST",
         "flowExecId": 121,
         "executionId": 2343,
         "status": "LOADED",
         "cycleName": "Nightly",
         "flow": "Nightly",
         "totalJobs": 385,
         "completedJobs": 0,
         "loadedJobs": 383,
         "skippedJobs": 2,
         "errorJobs": 0,
         "systemHeldJobs": 0,
         "submittingJobs": 0,
         "submittedJobs": 0
      }
   ]
}

Parameter	Description
`schedulerDay`	Current Scheduler Day ID
`businessDate`	Business Date of the current scheduler day
`execRequests`	Array containing all execution requests
`requestType`	Type of execution request
	• SCHEDULER_REQUEST- Created by the POM Scheduler
	• MANUAL_RUN- Run manually from the POM UI • UNDEFINED- Not defned. Possibly created through programmatic invocation of the API.
`flowExecId`	Unique ID generated for the Flow Execution
`executionId`	Execution ID to track this execution request
`status`	Status of the execution request.
`cycleName`	Name of the Batch Cycle on which the Flow or Process exists.
`flow`	Name of the Flow being executed. For a Process execution, the Flow is`Adhoc`.
`totalJobs`	Total number of Jobs
`completedJobs`	Total number of COMPLETED Jobs
`skippedJobs`	Total number of SKIPPED Jobs
`errorJobs`	Total number of Jobs in ERROR
`submittedJobs`	Total number of SUBMITTED Jobs

Parameter	Description
`submittingJobs`	Total number of SUBMITTING Jobs
`systemHeldJobs`	Total number of SYSTEMHELD Jobs

Nightly Execution Status

This endpoint fetches the status of the Nightly Flow for a given Batch Schedule.

HTTP Method GET Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /status? flow =Nightly <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. flow - Mandatory query parameter. This must be set to Nightly . HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation Response Body { "scheduleName": "Name of the Batch Schedule", "batch": "Will be the name of the Flow - Nightly", "status": "Could be (SCHEDULED, WAITING, ERROR, RUNNING” "message": "Brief description", "businessDate": "Schedule business date in POM", "scheduledStartTime": "Time in UTC at which the Nightly is scheduled to start", "timeToStartInSeconds": Seconds remaining for starting, "targetBatchDurationInMinutes": “Minutes set for the overall Target Batch Duration”, "targetBatchWindowExceeded": “In case the Nightly will take longer than the overall Target Batch Duration, then this will be set to TRUE, else FALSE” }

Examples of all the Nightly Status are shown in the table below:

Scenario Request Payload The Nightly Scheduler Task is { scheduled to RUN "scheduleName": "MERCH", "batch": "Nightly", "status": "SCHEDULED", "message": "The Nightly Flow is scheduled to start in 15h 38m seconds", "businessDate": "2024-12-28", "scheduledStartTime": "2025-01-02 14:45:00", "timeToStartInSeconds": 56280, "targetBatchDurationInMinutes": 150, "targetBatchWindowExceeded": false } Execution Engine suspended { "scheduleName": "MERCH", "batch": "Nightly", "status": "PAUSED", "message": "The Execution Engine has been SUSPENDED, No Jobs will be executed", "businessDate": "2024-12-28", "targetBatchDurationInMinutes": 150, "targetBatchWindowExceeded": false } The Nightly has started and Jobs are { running "scheduleName": "MERCH", "batch": "Nightly", "status": "RUNNING", "message": "The Nightly Flow is currently executing, with 2 jobs remaining", "businessDate": "2024-12-30", "executionRequestId": 8166, "actualStartTime": "2025-01-02 00:58:47", "percentComplete": 71, "targetBatchDurationInMinutes": 3, "targetBatchWindowExceeded": true, "estimatedCompletionTime": "2025-01-02 01:02:27" }

Scenario Request Payload The Nightly has started, but stuck { because some Jobs "scheduleName": "MERCH", are in ERROR status "batch": "Nightly", "status": "ERROR", "message": "There are 1 jobs in ERROR", "businessDate": "2025-01-03", "scheduledStartTime": "2025-01-06 08:13:05", "executionRequestId": 8207, "actualStartTime": "2025-01-06 08:19:33", "targetBatchDurationInMinutes": 3, "targetBatchWindowExceeded": true, "estimatedCompletionTime": "2025-01-06 08:27:12" } The Nightly has started, but stuck as { some Jobs are in "scheduleName": "MERCH", WAITING status "batch": "Nightly", "status": "WAITING", "message": "There are 1 jobs in WAITING status", "businessDate": "2025-01-03", "scheduledStartTime": "2025-01-06 07:31:53", "executionRequestId": 8205, "targetBatchDurationInMinutes": 3, "targetBatchWindowExceeded": true, "estimatedCompletionTime": "2025-01-06 07:41:16" }

Job Instances API

Job Instances refer to Jobs associated with a single Scheduler Day. Each Job Instance is provided a unique Job Run ID, that associates the Job Instance with a Scheduler Day.

Fetch Job Instances

This endpoint provides a detailed list of Job instances for a given schedule and cycle, for the current scheduler day.

HTTP Method	GET
URL	`https://``<pom-server-host>``/ProcessServices/services/public/` `schedules/``<schedule-name>``/jobInstances?cycle=``<cycleName>`
	• `<pom-server-host>`- This is the POM URL.
	• `<schedule-name>`- Name of the schedule being invoked.
	• `<cycleName>`- Mandatory query parameter indicating name of the cycle

HTTP Method GET HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation Request Body None Response Body { "scheduleName": "MERCH", "schedulerDay": 801, "scheduleStatus": "Active", "businessDate": "2024-01-31", "jobs": [ { "jobName": "ALC_DAILY_CLEANUP_JOB", "processName": "ALC_DAILY_CLNUP_PROCESS", "description": "Cleans up all the Work", "cycleName": "Nightly", "flowName": "Nightly", "appName": "ALLOC", "jobRunId": 276846, "status": "LOADED", "externalStatusUpdateMode": "NONE", "skipOnError": false, "jobType": "EXEC", "historicalAvgRunTime": 5, "currAvgRunTime": 0, "lastUpdateDatetime": "2024-05-29 16:56:16" }, { "jobName": "ALC_DASHBOARD_REFRESH_JOB", "processName": "ALC_DASHBOARD_PROCESS", "description": "Refresh the alloc set ", "cycleName": "Nightly", "flowName": "Nightly", "appName": "ALLOC", "jobRunId": 276847, "status": "LOADED", "externalStatusUpdateMode": "NONE", "skipOnError": true, "jobType": "EXEC", "historicalAvgRunTime": 5, "currAvgRunTime": 0, "lastUpdateDatetime": "2024-05-29 16:56:16" } ] }

Get Cycle Summary

This endpoint provides a list of all the Job Executions for the given Cycle. The summary can be downloaded either as a CSV file or a JSON

HTTP Method	GET
URL	`https://``<pom-server-host>``/ProcessServices/services/public/` `schedules/``<schedule-name>``/jobInstances/summary?` `cycleName=``<cycle-name>``&businessDate=``<business-date>` - This is the POM URL. - Name of the schedule being invoked. -Name of the cycle for which the summary is needed - Business Date for which the summary is needed. If not provided, the current business date will be used.Format:-`yyyy-mm-` `dd`
HTTP Headers	`Accept = application/json`(for JSON format),`text/csv`(for CSV format) Include Authorization header as shown in Oauth Token Generation
Request Body	None

HTTP Method GET

Response Body

{
  "cycleName": "Hourly_Cycle_1",
  "cycleNumber": 3,
  "cycleEndTime": "2024-06-04 21:14:30",
  "jobExecutions": [
    {
      "processName": "ASO_ASSORT_PROCESS_01",
      "jobName": "ASO_ASSORT_FCST_START_JOB",
      "flow": "ASO_INTRADAY_CYCLE",
      "jobRunId": 792533,
      "jobExecId": "2604",
      "status": "COMPLETED",
      "description": "ASO_ASSORT_FC_START_JOB",
      "startTime": "2024-06-04 21:04:18",
      "endTime": "2024-06-04 21:06:18",
      "runTime": 0,
      "averageRunTime": 120,
      "priority": 0
    },
    {
      "processName": "ASO_ASSORT_PROCESS_01",
      "jobName": "ASO_ASSORT_OC_FCST_COPY_JOB",
      "flow": "ASO_INTRADAY_CYCLE",
      "jobRunId": 792534,
      "jobExecId": "2605",
      "status": "COMPLETED",
      "startTime": "2024-06-04 21:06:28",
      "endTime": "2024-06-04 21:08:28",
      "runTime": 0,
      "averageRunTime": 120,
      "priority": 0
    },
    {
      "processName": "ASO_ASSORT_ PROCESS_01",
      "jobName": "ASO_ASSORT_FCST_END_JOB",
      "flow": "ASO_INTRADAY_CYCLE",
      "jobRunId": 792535,
      "jobExecId": "2606",
      "status": "COMPLETED",
      "description": "ASO_ASSORT_FCST_END_JOB",
      "startTime": "2024-06-04 21:08:39",
      "endTime": "2024-06-04 21:10:39",
      "runTime": 0,
      "averageRunTime": 120,
      "priority": 0
    }
  ]
}

Fetch Job Executions

This endpoint provides a list of all the Job Executions for the given Job.

HTTP Method GET URL https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /jobInstances/ <job-run-id> / executions - This is the POM URL. - Name of the schedule being invoked. - Unique ID associated with the Job Instance. HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation Request Body None Response Body { "scheduleName": "MERCH", "schedulerDay": 802, "businessDate": "2024-01-31", "executions": [ { "jobRunId": 287093, "jobExecId": 1502, "jobStatus": "COMPLETED", "jobStartTime": "2024-05-29 17:28:52", "jobEndTime": "2024-05-29 17:28:57" }, { "jobRunId": 287093, "jobExecId": 1500, "jobStatus": "COMPLETED", "jobStartTime": "2024-05-29 17:25:18", "jobEndTime": "2024-05-29 17:25:23" } ] }

Fetch Job Execution Log

This endpoint provides the Job log associated with a Job execution.

HTTP Method	GET
URL	`https://``<pom-server-host>``/ProcessServices/services/public/` `schedules/``<schedule-name>``/jobInstances/``<job-run-id>``/` `executions/``<execution-id>``/log` - This is the POM URL. - Name of the schedule being invoked. - Unique ID associated with the Job Instance. - Unique ID associated with a Job Execution.
HTTP Headers	`Accept = /`
	`Accept-Encoding = gzip,deflate,br` Include Authorization header as shown in Oauth Token Generation
Request Body	None
Response Body	Job Log output

Skip Job

This endpoint allows the User to SKIP a Job in POM.

HTTP Method	POST
URL	`https://``<pom-server-host>``/ProcessServices/services/public/` `schedules/``<schedule-name>``/jobInstances/``<job-run-id>``/skip` - This is the POM URL. - Name of the schedule being invoked. - Unique ID associated with the Job Instance.
HTTP Headers	`Content-Type = application/json` Include Authorization header as shown in Oauth Token Generation
Request Body	Comments are necessary to SKIP the Job. An Audit Event is created, when this endpoint is invoked.
	`{` `"comments" : "Skipping the Job "` `}`
Response Body	204 No Content

Rerun Failed Job

This endpoint allows the User to rerun a failed Job in POM. If the status of the Job being attempted to rerun is not ERROR, an exception will be thrown.

HTTP Method POST URL https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /jobInstances/ <job-run-id> /rerun - This is the POM URL. - Name of the schedule being invoked. - Unique ID associated with the Job Instance. HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation Request Body Comments are necessary to RERUN the Job. An Audit Event is created, when this endpoint is invoked. { "comments" : "Restarting the Job on failure" } Response Body 204 No Content

Kill Job

This endpoint allows the User to KILL a running Job in POM. If the status of the Job being killed is not RUNNING, an exception will be thrown.

HTTP Method POST URL https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /jobInstances/ <job-run-id> /kill - This is the POM URL. - Name of the schedule being invoked. - Unique ID associated with the Job Instance. HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation Request Body Comments are necessary to KILL the Job. An Audit Event is created, when this endpoint is invoked. { "comments" : "Killing the Job" } Response Body 204 No Content

External Dependency API

This API operates solely on Batch External Dependencies.

Releasing External Dependency

The endpoint below releases an External Dependency setup in POM. Customers can call this endpoint to synchronize the execution of the Batch Schedule in POM with their other systems.

HTTP Method POST URL https:// <pom-server-host> /ProcessServices/services/private/ schedules/ <schedule-name> /external/jobs/ <ext-dependencyname> /status/ COMPLETED <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. <ext-dependency-name> - Name of the External Dependency set up in POM. Note: Ensure the status COMPLETED is specified in the path correctly, or the External Dependency will not be released. HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation Request Body None Response Body { "value": "true", "links": [], "hyperMediaContent": { "linkRDO": [] } } Parameter Description value Boolean attribute indicating the success or failure of the attempt to release the external dependency. links Can be ignored. Part of the ReST API, HATEOAS standards. hyperMediaContent Can be ignored. Part of the ReST API, HATEOAS standards.

Utilities API

These APIs are general utilities, that have come as requirements from various Customers.

Business Date Alignment

This API provides the ability to adjust the business date of a Batch Schedule. This allows for aligning the business date with other schedules or a customer’s internal processing date.

HTTP Method	POST
Path	`https://``<pom-server-host>``/ProcessServices/services/public/`
	`administration/utilities/alignBusinessDate`
	`<pom-server-host>`- This is the POM URL.
HTTP	`Content-Type = application/json`
Headers	Include Authorization header as shown in Oauth Token Generation

HTTP Method POST

Request Body

  "businessDate": "Business Date in yyyy-mm-dd format",
  "scheduleName": "Schedule Name",
  "advanceDateOnly": "<true|false>",
  "updateDependentSchedules": "<true|false>",
  "comment": "<Comment>"
}

businessDate – Desired business date in yyyy-mm-dd format (API will determine if to move it backward or forward)

scheduleName – Schedule name for which the business date has to be aligned advanceDateOnly – Optional boolean flag to enforce business dates only move forward. If the business date (for the given Schedule or its dependents) has to move backwards, the request will fail. Defaults to false, if not specified. updateDependentSchedules – Optional boolean flag to enforce business date alignment for all Batch Schedules that are dependents of the specified Schedule. It includes both inter-schedule dependencies and execution links. comment – Mandatory field. Provides the reason to align business date and is mainly used for auditing purposes.

Response The response of this endpoint, provides a clear understanding of which Batch Body Schedules were adjusted, what were their previous business dates and what their current business date is.

{
    "instances": [
        {
            "status": "<SCHEDULE_STATUS>",
            "scheduleName": "<SCHEDULE_NAME>",

            "schedulerInstanceId": "<SCHEDULER_DAY>",

            "businessDate": "<BUSINESS_DATE>",

            "previousBusinessDate": "<PREV_BIZ_DATE>",
            "activationTime": "<ACTIVATION_TIME>"

        }
    ]

Parameter	Description
`instances`	Array containing Schedule objects.
`scheduleName`	Name of the Batch Schedule adjusted.
`status`	Status of the Batch Schedule.
`businessDate`	Current business date of the Schedule
`previousBusinessDate`	Previous business date of the Schedule, prior to adjustment.
`activationTime`	The time at which the Scheduler Day with the new business date was created.

Solution Diagram

The endpoint identifies dependent Schedules mainly by using the Inter-Schedule Dependency flag that is set on the System Configuration screen in POM, at a Schedule level and also the execution links.

Once dependent Schedules are identified, the EJB Timers used by the POM Scheduler are cancelled (if configured and in use), prior to moving the business date of the Schedule.

The general flow of this endpoint in moving the business dates of the Schedules is depicted in the flowchart below.

Custom Batch Entities API

The following endpoints are for the creation, updating, and deletion of Custom Batch Entities within POM.

Creating / Updating Custom Flows

This API provides the ability to create / update custom flows.

HTTP PUT Method Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /customFlows <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. HTTP Headers Content-Type = application/json Include Authorization header as shown in Oauth Token Generation

Request Body Sample Request Body

{
  "name": "TEST_CUST1_CFLOW",
  "description": "Custom Flow Description",
  "creationComment": "Created for testing purposes",
  "processes": [
    {
      "name": "TEST_CUSTF1_CPROCESS",
      "description": "Custom Process Description",
      "isFirstProcess": true,
      "jobs": [
        {
          "name": "TEST_CUSTF1_CJOB",
          "description": "Custom Job Description",
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
       "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
          "thresholdRunTime": "4000",
          "modifiableParameters": true,
          "skipOnError": false
        },
        {
          "name": "TEST_CUSTF21_CJOB",
          "description": "Custom Job Description",
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
          "thresholdRunTime": "4000",
          "modifiableParameters": true,
          "skipOnError": false
        }
      ]
   },
    {
      "name": "TEST_CUSTF2_CPROCESS",
      "description": "Custom Process Description",
      "predecessors": [
        "TEST_CUSTF1_CPROCESS"
      ],
      "jobs": [
        {

          "name": "TEST_CUSTF3_CJOB",
          "description": "Custom Job Description",
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
       "thresholdRunTime": "4000",
          "modifiableParameters": true,
          "skipOnError": false
        },
        {
          "name": "TEST_CUSTF41_CJOB",
          "description": "Custom Job Description",
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
          "thresholdRunTime": "4000",
          "modifiableParameters": true,
          "skipOnError": false
        }
      ]
    },
    {
      "name": "TEST_CUSTF3_CPROCESS",
      "description": "Custom Process Description",
      "isLastProcess": true,
      "predecessors": [
        "TEST_CUSTF2_CPROCESS"
      ],
      "jobs": [
        {
          "name": "TEST_CUSTF4_CJOB",
          "description": "Custom Job Description",
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY",

"thresholdRunTime": "4000", "modifiableParameters": true, "skipOnError": false }, { "name": "TEST_CUSTF51_CJOB", "description": "Custom Job Description", "type": "EXEC", "batchName": "dummy", "wrapperName": "dummy", "scriptDirectory": "dummy", "cleanupScript": "dummy", "application": "APP1", "parameters": "A B B C D E F ", "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY", "thresholdRunTime": "4000", "modifiableParameters": true, "skipOnError": false } ] } ] } Response Body { "name": " TEST_CUST1_CFLOW ", "type": "Flow", "user": "POAM_ADMIN", "comment": "Created for testing purposes" }

Deleting Custom Flow

This API provides the ability to delete the given custom flow.

HTTP DELETE Method Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /customFlows/ <flow-name> <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. <flow-name> - Name of the flow to be deleted.

HTTP Headers

Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation Request Body Sample Request Body

{
  " comment": "Deleting custom flow TEST_CUST1_CFLOW”
}

Response 204 No content Body

Fetching All Custom Flows

This API provides the ability to fetch all custom flows.

HTTP GET Method Path

https://<pom-server-host>/ProcessServices/services/public/
schedules/<schedule-name>/customFlows

<pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked.

HTTP Headers Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation

Request Body N/A

Response Body { "flows": [ { "scheduleName": "RI", "displayScheduleName": "RITEST", "name": "TEST_CUST1_CFLOW", "description": "Custom Flow Description", "enabled": false, "useExisting": false, "customEntity": true, "processes": [ { "name": "TEST_CUSTF3_CPROCESS", "description": "Custom Process Description", "enabled": false, "useExisting": false, "customEntity": true, "isFirstProcess": false, "isLastProcess": true, "predecessors": [ "TEST_CUSTF2_CPROCESS" ], "jobs": [ { "name": "TEST_CUSTF4_CJOB", "description": "Custom Job Description", "enabled": false, "useExisting": false, "customEntity": true, "type": "EXEC", "batchName": "dummy", "wrapperName": "dummy", "scriptDirectory": "dummy", "cleanupScript": "dummy", "application": "APP1", "parameters": "A B B C D E F ", "modifiableParameters": false, "skipOnError": false, "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY" }, { "name": "TEST_CUSTF51_CJOB", "description": "Custom Job Description", "enabled": false, "useExisting": false, "customEntity": true, "type": "EXEC", "batchName": "dummy", "wrapperName": "dummy", "scriptDirectory": "dummy", "cleanupScript": "dummy", "application": "APP1",

              "parameters": "A B B C D E F ",
              "modifiableParameters": false,
              "skipOnError": false,
              "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
            }
          ]
        },
        {
          "name": "TEST_CUSTF1_CPROCESS",
          "description": "Custom Process Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "isFirstProcess": true,
          "isLastProcess": false,
          "jobs": [
            {
              "name": "TEST_CUSTF1_CJOB",
              "description": "Custom Job Description",
              "enabled": false,
              "useExisting": false,
              "customEntity": true,
              "type": "EXEC",
              "batchName": "dummy",
              "wrapperName": "dummy",
              "scriptDirectory": "dummy",
              "cleanupScript": "dummy",
              "application": "APP1",
              "parameters": "A B B C D E F ",
              "modifiableParameters": false,
              "skipOnError": false,
              "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
            },
            {
              "name": "TEST_CUSTF21_CJOB",
              "description": "Custom Job Description",
              "enabled": false,
              "useExisting": false,
              "customEntity": true,
              "type": "EXEC",
              "batchName": "dummy",
              "wrapperName": "dummy",
              "scriptDirectory": "dummy",
              "cleanupScript": "dummy",
              "application": "APP1",
              "parameters": "A B B C D E F ",
              "modifiableParameters": false,
              "skipOnError": false,
              "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
            }

          ]
        },
        {
          "name": "TEST_CUSTF2_CPROCESS",
          "description": "Custom Process Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "isFirstProcess": false,
          "isLastProcess": false,
          "predecessors": [
            "TEST_CUSTF1_CPROCESS"
          ],
          "jobs": [
            {
              "name": "TEST_CUSTF3_CJOB",
              "description": "Custom Job Description",
              "enabled": false,
              "useExisting": false,
              "customEntity": true,
              "type": "EXEC",
              "batchName": "dummy",
              "wrapperName": "dummy",
              "scriptDirectory": "dummy",
              "cleanupScript": "dummy",
              "application": "APP1",
              "parameters": "A B B C D E F ",
              "modifiableParameters": false,
              "skipOnError": false,
              "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
            },
            {
              "name": "TEST_CUSTF41_CJOB",
              "description": "Custom Job Description",
              "enabled": false,
              "useExisting": false,
              "customEntity": true,
              "type": "EXEC",
              "batchName": "dummy",
              "wrapperName": "dummy",
              "scriptDirectory": "dummy",
              "cleanupScript": "dummy",
              "application": "APP1",
              "parameters": "A B B C D E F ",
              "modifiableParameters": false,
              "skipOnError": false,
              "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
            }
          ]
        }
      ]

    }
  ]
}

Fetching a Custom Flow

This API provides the ability to fetch details of a given custom flow.

HTTP GET Method Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /customFlows /<flow-name> <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. <flow-name> - Name of the flow to be fetched. HTTP Headers Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation

Request Body N/A

Response Body

{
  "scheduleName": "RI",
  "displayScheduleName": "RITEST",
  "name": "TEST_CUST1_CFLOW",
  "description": "Custom Flow Description",
  "enabled": false,
  "useExisting": false,
  "customEntity": true,
  "processes": [
    {
      "name": "TEST_CUSTF3_CPROCESS",
      "description": "Custom Process Description",
      "enabled": false,
      "useExisting": false,
      "customEntity": true,
      "isFirstProcess": false,
      "isLastProcess": true,
      "predecessors": [
        "TEST_CUSTF2_CPROCESS"
      ],
      "jobs": [
        {
          "name": "TEST_CUSTF4_CJOB",
          "description": "Custom Job Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,
          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        },
        {
          "name": "TEST_CUSTF51_CJOB",
          "description": "Custom Job Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,

          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        }
      ]
    },
    {
      "name": "TEST_CUSTF1_CPROCESS",
      "description": "Custom Process Description",
      "enabled": false,
      "useExisting": false,
      "customEntity": true,
      "isFirstProcess": true,
      "isLastProcess": false,
      "jobs": [
        {
          "name": "TEST_CUSTF1_CJOB",
          "description": "Custom Job Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,
          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        },
        {
          "name": "TEST_CUSTF21_CJOB",
          "description": "Custom Job Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,
          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        }
      ]
    },

    {
      "name": "TEST_CUSTF2_CPROCESS",
      "description": "Custom Process Description",
      "enabled": false,
      "useExisting": false,
      "customEntity": true,
      "isFirstProcess": false,
      "isLastProcess": false,
      "predecessors": [
        "TEST_CUSTF1_CPROCESS"
      ],
      "jobs": [
        {
          "name": "TEST_CUSTF3_CJOB",
          "description": "Custom Job Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,
          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        },
        {
          "name": "TEST_CUSTF41_CJOB",
          "description": "Custom Job Description",
          "enabled": false,
          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,
          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        }
      ]
    }
  ]
}

Creating / Updating Custom Processes

This API provides the ability to create / update custom processes.

HTTP PUT Method Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /customProcesses <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. HTTP Headers Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation

Request Body Sample Request Body

{
  "name": "TEST_CUST1_CPROCESS",
  "description": "Custom Process Description",
  "creationComment": "Created for testing purposes",
  "jobs": [
    {
      "name": "TEST_CUST5_CJOB",
      "description": "Custom Job Description",
      "type": "EXEC",
      "batchName": "dummy",
      "wrapperName": "dummy",
      "scriptDirectory": "dummy",
      "cleanupScript": "dummy",
      "application": "APP1",
      "parameters": "A B B C D E F ",
      "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
      "thresholdRunTime": "4000",
      "modifiableParameters": true,
      "skipOnError": false,
      "customEntity": true
    },
    {
      "name": "TEST_CUST61_CJOB",
      "description": "Custom Job Description",
      "type": "EXEC",
      "batchName": "dummy",
      "wrapperName": "dummy",
      "scriptDirectory": "dummy",
      "cleanupScript": "dummy",
      "application": "APP1",
      "parameters": "A B B C D E F ",
      "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
      "thresholdRunTime": "4000",
      "modifiableParameters": true,
      "skipOnError": false,
      "customEntity": true
    },
    {
      "name": "TEST_CUST71_CJOB",
      "description": "Custom Job Description",
      "type": "EXEC",
      "batchName": "dummy",
      "wrapperName": "dummy",
      "scriptDirectory": "dummy",
      "cleanupScript": "dummy",
      "application": "APP1",
      "parameters": "A B B C D E F ",
      "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY",
      "thresholdRunTime": "4000",
      "modifiableParameters": true,
      "skipOnError": false,

      "customEntity": true
    }
  ]
}

Response Body { "name": "TEST_CUST1_CPROCESS", "type": "Process", "user": "POAM_ADMIN", "comment": "Created for testing purposes" }

Deleting Custom Process

This API provides the ability to delete the given custom process.

HTTP DELETE Method Path https:// <pom-server-host> /ProcessServices/services/public/ schedules/ <schedule-name> /customProcesses/ <process-name> <pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. <process-name> - Name of the process to be deleted. HTTP Headers Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation

Request Body Sample Request Body

{
  " comment": "Delete custom process TEST_CUST1_CPROCESS”
}

Response 204 No content Body

Fetching all Custom Processes

This API provides the ability to fetch all custom processes.

HTTP GET Method

Path

https://<pom-server-host>/ProcessServices/services/public/
schedules/<schedule-name>/customProcesses

<pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. HTTP Headers Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation Request Body N/A

Response Body { "processes": [ { "scheduleName": "RI", "displayScheduleName": "RITEST", "name": "TEST_CUST1_CPROCESS", "description": "Custom Process Description", "enabled": false, "useExisting": false, "customEntity": true, "isFirstProcess": false, "isLastProcess": false, "jobs": [ { "name": "TEST_CUST5_CJOB", "description": "Custom Job Description", "enabled": false, "useExisting": false, "customEntity": true, "type": "EXEC", "batchName": "dummy", "wrapperName": "dummy", "scriptDirectory": "dummy", "cleanupScript": "dummy", "application": "APP1", "parameters": "A B B C D E F ", "modifiableParameters": false, "skipOnError": false, "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY" }, { "name": "TEST_CUST61_CJOB", "description": "Custom Job Description", "enabled": false, "useExisting": false, "customEntity": true, "type": "EXEC", "batchName": "dummy", "wrapperName": "dummy", "scriptDirectory": "dummy", "cleanupScript": "dummy", "application": "APP1", "parameters": "A B B C D E F ", "modifiableParameters": false, "skipOnError": false, "enabledDaysOfTheWeek": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY" }, { "name": "TEST_CUST71_CJOB", "description": "Custom Job Description", "enabled": false,

          "useExisting": false,
          "customEntity": true,
          "type": "EXEC",
          "batchName": "dummy",
          "wrapperName": "dummy",
          "scriptDirectory": "dummy",
          "cleanupScript": "dummy",
          "application": "APP1",
          "parameters": "A B B C D E F ",
          "modifiableParameters": false,
          "skipOnError": false,
          "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        }
      ]
    }
  ]
}

Fetching a Custom Process

This API provides the ability to fetch details of a given custom process.

HTTP GET Method Path

https://<pom-server-host>/ProcessServices/services/public/
schedules/<schedule-name>/customProcesses/<process-name>

<pom-server-host> - This is the POM URL. <schedule-name> - Name of the schedule being invoked. <process-name> - Name of the process to be fetched. HTTP Headers Content-Type = application/json

Include Authorization header as shown in Oauth Token Generation

Request Body N/A

Response Body

{
    "scheduleName": "RI",
    "displayScheduleName": "RITEST",
    "name": "TEST_CUST1_CPROCESS",
    "description": "Custom Process Description",
    "enabled": false,
    "useExisting": false,
    "customEntity": true,
    "isFirstProcess": false,
    "isLastProcess": false,
    "jobs": [
        {
            "name": "TEST_CUST5_CJOB",
            "description": "Custom Job Description",
            "enabled": false,
            "useExisting": false,
            "customEntity": true,
            "type": "EXEC",
            "batchName": "dummy",
            "wrapperName": "dummy",
            "scriptDirectory": "dummy",
            "cleanupScript": "dummy",
            "application": "APP1",
            "parameters": "A B B C D E F ",
            "modifiableParameters": false,
            "skipOnError": false,
            "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        },
        {
            "name": "TEST_CUST61_CJOB",
            "description": "Custom Job Description",
            "enabled": false,
            "useExisting": false,
            "customEntity": true,
            "type": "EXEC",
            "batchName": "dummy",
            "wrapperName": "dummy",
            "scriptDirectory": "dummy",
            "cleanupScript": "dummy",
            "application": "APP1",
            "parameters": "A B B C D E F ",
            "modifiableParameters": false,
            "skipOnError": false,
            "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        },
        {
            "name": "TEST_CUST71_CJOB",
            "description": "Custom Job Description",
            "enabled": false,
            "useExisting": false,
            "customEntity": true,

            "type": "EXEC",
            "batchName": "dummy",
            "wrapperName": "dummy",
            "scriptDirectory": "dummy",
            "cleanupScript": "dummy",
            "application": "APP1",
            "parameters": "A B B C D E F ",
            "modifiableParameters": false,
            "skipOnError": false,
            "enabledDaysOfTheWeek":
"SUNDAY,MONDAY,TUESDAY,WEDNESDAY"
        }
    ]
}

Swagger Implementation

A Swagger URL is available for the aforementioned APIs. The Swagger documentation can be accessed using the following URL pattern:

https://<host>/<subnamesp>/ProcessServices/services/public/swagger

This Swagger interface provides an interactive way to review the API definitions, endpoints, request and response structures, and other implementation details in a centralized location.

For details on obtaining the authentication tokens required to invoke these APIs, refer to the Oauth Token Generation section of this chapter.

In this guide

Guide: POM Implementation Guide
Previous: 1 Introduction
Next: 2 Batch Concepts

3 Integration — POM Implementation Guide · shares MANUAL_RUN, SCHEDULER_REQUEST

Oracle Retail Knowledge Base

Explorer

10 Invoking POM Services

10 Invoking POM Services

Note

Oauth Token Generation

Prerequisite

Invoke IDCS Token Endpoint

Invoking the POM Service

HTTP Method

GET

Path

HTTP Headers

View Batch Cycles for Schedule

Response Body Sample Response

Batch Execution API

Execution Request Creation

HTTP

POST

Method

Request Body

Execution Request Status

Path

Response Body

Execution Request Details

Execution Requests for Batch Cycle

Response Body Sample Response

Nightly Execution Status

Job Instances API

Fetch Job Instances

Get Cycle Summary

Response Body

Fetch Job Executions

Fetch Job Execution Log

Skip Job

Rerun Failed Job

Kill Job

External Dependency API

Releasing External Dependency

Utilities API

Business Date Alignment

HTTP Method POST

Request Body

Solution Diagram

Custom Batch Entities API

Creating / Updating Custom Flows

Deleting Custom Flow

Fetching All Custom Flows

Fetching a Custom Flow

Response Body

Creating / Updating Custom Processes

Deleting Custom Process

Fetching all Custom Processes

Path

Fetching a Custom Process

Response Body

Swagger Implementation

In this guide

Related chapters

Graph View

Table of Contents

Backlinks