Monitor

Back Next

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 }

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
}

Process scheduler REST APIs

Download Guide

Watch

Comments

Cloud Application Integration Homepage