Monitor > Process Schedules > Process scheduler REST APIs
  

Process scheduler REST APIs

Application Integration includes process scheduler REST APIs to manage scheduled processes.
You can use REST APIs to view, create, update, and delete process schedules. The APIs support basic authentication and session ID authorization.

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"
}
]
}
}

Create Schedule API

You can use the Create Schedule API to create a process schedule that runs on the Cloud Server or on Secure Agents.
If the REST API call is successful, the API returns the status code 204 in the response body. For more information about REST API responses, see Data Integration REST API Reference.
You can use the Create Schedule API to perform the following tasks:
APIs
Description
POST <Informatica Cloud Application Integration URL>/active-bpel/restadmin/scheduler/schedules
Create a process schedule based on an Informatica Process Designer (IPD) service. Set ipdService to true to create a process schedule based on a BPEL service.
The following snippet shows a sample payload when you make an API request:
{
"tenantContextId": "9kCHfynWgUBfPh8D1FcYyL",
"name": "APICreatedSchedule5",
"ipdService": true,
"once": null,
"intraday": {
"executeEvery": {
"value": 30,
"interval": "SECONDS"
},
"onlyBetween": null
},
"daily": null,
"weekly": null,
"monthly": null,
"runOptions": "SKIP",
"serviceName": "Process6-16",
"inputDocument": null
}
Note: The serviceName is the API name of the process.
POST <Informatica Cloud Application Integration URL>/active-bpel/restadmin/scheduler/schedules
Create a process schedule based on a Business Process Execution Language (BPEL) service. Set ipdService to false to create a process schedule based on a BPEL service.
The following snippet shows a sample payload when you make an API request:
{
"tenantContextId": "9kCHfynWgUBfPh8D1FcYyL",
"name": "APIBpelSchedule2",
"ipdService": false,
"once": null,
"intraday": {
"executeEvery": {
"value": 30,
"interval": "SECONDS"
},
"onlyBetween": null
},
"daily": null,
"weekly": null,
"monthly": null,
"runOptions": "SKIP",
"serviceName": "9kCHfynWgUBfPh8D1FcYyL/Process6-16",
"inputDocument": {
"any": "<spi:initiate xmlns:spi=\"http://schemas.informatica.com/spi/types/2013/12/spi-interface/\" xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:avos=\"http://schemas.active-endpoints.com/appmodules/screenflow/2010/10/avosScreenflow.xsd\">\n\t\t\t</spi:initiate>",
"otherAttributes": {}
}
}
Note: The serviceName is the API name of the process.
POST http://<agentName>:<httpPortNumber>/process-engine/restadmin/scheduler/schedules
Create a process schedule that runs on a specific Secure Agent. You must include the agent name in the request.
The following snippet shows a sample payload when you make an API request:
{
"tenantContextId": "$public",
"name": "agentSch1",
"ipdService": true,
"once": null,
"intraday": {
"executeEvery": {
"value": 30,
"interval": "SECONDS"
},
"onlyBetween": null
},
"daily": null,
"weekly": null,
"monthly": null,
"runOptions": "SKIP",
"serviceName": "ProcessScheduledAgent",
"inputDocument": null
}
Note: The serviceName is the API name of the process.

Update Schedule API

You can use the Update Schedule API to update a process schedule that runs on the Cloud Server or on Secure Agents.
If the REST API call is successful, the API returns the status code 204 in the response body. For more information about REST API responses, see Data Integration REST API Reference.
You can use the Update Schedule API to perform the following tasks:
APIs
Description
PUT <Informatica Cloud Application Integration URL>/active-bpel/restadmin/scheduler/schedules
Update a process schedule that runs on the Cloud Server.
The following snippet shows a sample payload when you make an API request:
https://<Cloud Application Integration POD URL>/active-bpel/restadmin/scheduler/schedules

{
"scheduleId": "<scheduleId>",
"name": "<scheduleName>",
"runOptions": "SKIP",
"serviceName": "<process API Name>",
"ipdService": "true",
"tenantContextId": "<orgId>",
"enabled": true,
"once": null,
"intraday": {
"executeEvery": {
"value": 1,
"interval": "MINUTES"
},
"onlyBetween": null
},
"inputDocument": null
}
PUT http://<agentName>:<httpPortNumber>/process-engine/restadmin/scheduler/schedules
Update a process schedule that runs on a specific Secure Agent.
https://<Cloud Application Integration POD URL>/active-bpel/restadmin/scheduler/schedules

{
"scheduleId": "<scheduleId>",
"name": "<scheduleName>",
"runOptions": "SKIP",
"serviceName": "<process API Name>",
"ipdService": "true",
"tenantContextId": "$public",
"enabled": true,
"once": null,
"intraday": {
"executeEvery": {
"value": 1,
"interval": "MINUTES"
},
"onlyBetween": null
},
"inputDocument": null
}

Delete Schedule API

You can use the Delete Schedule API to delete all process schedules on the Cloud Server or on Secure Agents.
If the REST API call is successful, the API returns the status code 204 in the response body. For more information about REST API responses, see Data Integration REST API Reference.
You can use the Delete Schedule API to perform the following tasks:
APIs
Description
DELETE <Informatica Cloud Application Integration URL>/active-bpel/restadmin/scheduler/schedules
Delete a process schedule that runs on the Cloud Server.
The following snippet shows a sample payload when you make an API request:
{
"scheduleId": [926347078765268992]
}
DELETE http://<agentName>:<httpPortNumber>/process-engine/restadmin/scheduler/schedules
Delete a process schedule that runs on a specific Secure Agent.
The following snippet shows a sample payload when you make an API request:
{
"scheduleId": [104]
}
You can pass more than one schedule ID that are separated by commas. If even one schedule ID is invalid, none of the process schedules will be deleted.