Monitor

Back Next

Get Schedule API

You can use the Get Schedule API to request details about the process schedules in the organization.

If the REST API call is successful, the API returns the status code 200 in the response body. For more information about REST API responses, see

Data Integration REST API Reference

You can use the Get Schedule API to perform the following tasks:

APIs	Description
GET <Informatica Cloud Application Integration URL>/active-bpel/restadmin/scheduler/schedules/?tenantContextId=<organization ID>	View a list of process schedules that run on the Cloud Server within a specific organization.
GET <Informatica Cloud Application Integration URL>/active-bpel/restadmin/scheduler/schedules/?tenantContextId=<organization ID>&name=<scheduleName>	View a specific process schedule that runs on the Cloud Server within a specific organization.
GET http://<agentName>:<httpPortNumber>/process-engine/restadmin/scheduler/schedules	View a list of process schedules that run on a specific Secure Agent.
GET http://<agentName>:<httpPortNumber>/process-engine/restadmin/scheduler/schedules?name=<scheduleName>	View details of a specific process schedule that runs on a specific Secure Agent.

The following example shows a sample response when you view the process schedules:

{
"totalRowCount": 1,
"completeRowCount": true,
"schedulerInitialized": true,
"scheduledItems": {
"scheduledItem": [
{
"tenantContextId": "fDe0qZ1yc48bB2mRUmUYIN",
"name": "ProcessScheduleTest",
"ipdService": true,
"once": null,
"intraday": {
"executeEvery": {
"value": 30,
"interval": "SECONDS"
},
"onlyBetween": {
"betweenStart": "2021-09-17T06:38:25.000+00:00",
"betweenEnd": "2021-09-17T06:39:35.000+00:00"
}
},
"daily": null,
"weekly": null,
"monthly": null,
"runOptions": "SKIP",
"serviceName": "fDe0qZ1yc48bB2mRUmUYIN/ProcessSchedule",
"inputDocument": null,
"scheduleId": "623407279198179328",
"enabled": true,
"lastProcessId": "0",
"lastExecution": null,
"nextExecution": "2021-09-17T06:38:27.706+00:00",
"planId": "623407273670086656"
}
]
}
}

Process scheduler REST APIs

Download Guide

Watch

Comments

Cloud Application Integration Homepage