Run an Existing Schedule

Run an existing task

Method

/API3/tasks/reRunTask

  • 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
    • Domain Admin
    • Pro

Method Signature

Input Parameters

Name

taskId

Type

string

Description

The task's system ID

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Notes

Use the 'findSchedule' to find a schedule. For that schedule, use 'getExecutions' to get a list of instances of that schedule that have run. Within the 'execution', retrieve the list of tasks to run.

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/reRunTask" \
 -d ''

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 taskId parameter object for the call
        String taskId = taskId_example; // Create the input object for the operation, type: String 

        try {
            ModifiedItemsResult result = apiInstance.reRunTask(taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksServiceApi#reRunTask");
            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 taskId = taskId_example; // {String} 

api.reRunTask(taskId).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 reRunTaskExample
{
    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 taskId parameter object for the call
        var taskId = taskId_example;  // Create the input object for the operation, type: String | 

        try {
            // Run an existing task
            ModifiedItemsResult result = apiInstance.reRunTask(taskId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling TasksServiceApi.reRunTask: " + 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 taskId parameter object for the call
    taskId = taskId_example # String | 

    try:
        # Run an existing task
        api_response = api_instance.re_run_task(taskId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TasksServiceApi->reRunTask: %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();
$taskId = taskId_example; // String | 

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