Delete Schedules

{ deleteSchedules }

Soft deletes schedules from the active tasks scheduler.

Method

/API3/tasks/deleteSchedules

  • 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

    scheduleId

    Object Type

    string [ ]

    Description

    The schedules' system IDs

    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

    The schedules will not be permanently deleted. Instead it will only be set to status deleted.

    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/deleteSchedules" \
 -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 scheduleId parameter object for the call
        array[String] scheduleId = ; // Create the input object for the operation, type: array[String] 

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

api.deleteSchedules(scheduleId).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 deleteSchedulesExample
{
    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 scheduleId parameter object for the call
        var scheduleId = new array[String](); // array[String] | 

        try {
            // Soft deletes schedules from the active tasks scheduler.
            ModifiedItemsResult result = apiInstance.deleteSchedules(scheduleId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling TasksServiceApi.deleteSchedules: " + 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 scheduleId parameter object for the call
    scheduleId =  # array[String] | 

    try:
        # Soft deletes schedules from the active tasks scheduler.
        api_response = api_instance.delete_schedules(scheduleId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TasksServiceApi->deleteSchedules: %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();
$scheduleId = ; // array[String] | 

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