Run On Demand Schedules

{ runOnDemandSchedules }

Runs all 'On-Demand' schedules for the selected model.

Method

/API3/tasks/runOnDemandSchedules

  • API Section: /API3/tasks
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Input Parameters

    Name

    scheduleOnDemandObject

    Object Type

    ModelScheduleOnDemandObject

    Description

    Details of the model that will be the target of the on-demand execution.

    Output Response

    Successful Result Code

    200

    Response Type

    ModelScheduleOnDemandResult

    Description of Response Type

    A listing of on-demand schedules triggered by the change

    Notes

    This function will only operate against items that have employed the 'on-demand' schedule mechanism for Publications, Alerts and Subscriptions. The mechanism will only affect those item schedules that are fully or partially attached to the selected model.

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    TypeScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/tasks/runOnDemandSchedules" \
 -d '{
  "connectionStringId" : "connectionStringId"
}'

    import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.TasksServiceApi;

import java.util.*;
import java.time.*;

public class TasksServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TasksServiceApi apiInstance = new TasksServiceApi();
        // Initialize the scheduleOnDemandObject parameter object for the call
        ModelScheduleOnDemandObject scheduleOnDemandObject = ; // Create the input object for the operation, type: ModelScheduleOnDemandObject 

        try {
            ModelScheduleOnDemandResult result = apiInstance.runOnDemandSchedules(scheduleOnDemandObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksServiceApi#runOnDemandSchedules");
            e.printStackTrace();
        }
    }
}

    import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.TasksServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const scheduleOnDemandObject = ; // {ModelScheduleOnDemandObject} 

api.runOnDemandSchedules(scheduleOnDemandObject).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


    using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class runOnDemandSchedulesExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new TasksServiceApi();
        // Initialize the scheduleOnDemandObject parameter object for the call
        var scheduleOnDemandObject = new ModelScheduleOnDemandObject(); // ModelScheduleOnDemandObject | 

        try {
            // Runs all 'On-Demand' schedules for the selected model. 
            ModelScheduleOnDemandResult result = apiInstance.runOnDemandSchedules(scheduleOnDemandObject);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling TasksServiceApi.runOnDemandSchedules: " + e.Message );
        }
    }
}


    import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import TasksServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = TasksServiceApi(api_client)
    # Initialize the scheduleOnDemandObject parameter object for the call
    scheduleOnDemandObject =  # ModelScheduleOnDemandObject | 

    try:
        # Runs all 'On-Demand' schedules for the selected model. 
        api_response = api_instance.run_on_demand_schedules(scheduleOnDemandObject)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TasksServiceApi->runOnDemandSchedules: %s\n" % e)
    <?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TasksServiceApi();
$scheduleOnDemandObject = ; // ModelScheduleOnDemandObject | 

try {
    $result = $api_instance->runOnDemandSchedules($scheduleOnDemandObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksServiceApi->runOnDemandSchedules: ', $e->getMessage(), PHP_EOL;
}
?>