Monitor

Back Next

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 } 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": {} } } 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 } The serviceName is the API name of the process.

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

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
}

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

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": {}
    }
}

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
}

The serviceName is the API name of the process.

Process scheduler REST APIs

Download Guide

Watch

Comments

Cloud Application Integration Homepage