Find a Schedule

{ findSchedule }

Returns a schedule based on the search criteria

Method

/API3/tasks/findSchedule
  • API Section: /API3/tasks
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    searchCriteria

    Object Type

    Description

    The search criteria object for finding a schedule.

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    The schedule listing object.. Note that the response is returned as a list of items of this object type.

    Notes

    Schedules are available for different types of content: data flow processing, publications, alerts etc.

    Examples

    Code Snippets

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

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/tasks/findSchedule" \
     -d '{
      "scheduleType" : "PRINTING",
      "searchCriteria" : {
        "searchMatchType" : "Contains",
        "searchValue" : "searchValue"
      }
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.TasksServiceApi;
    
    import java.util.*;
    
    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 searchCriteria parameter object for the call
            ScheduleSearchCriteria searchCriteria = ; // ScheduleSearchCriteria | 
    
            try {
                // "array[ScheduleViewObject]" is only psaudo-code to symbolize list of type and not the actual usage 
                array[ScheduleViewObject] result = apiInstance.findSchedule(searchCriteria);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling TasksServiceApi#findSchedule");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.TasksServiceApi("http://Your.Server.URL")
    const searchCriteria = ; // {ScheduleSearchCriteria} 
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.findSchedule(searchCriteria, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class findScheduleExample
    {
        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 searchCriteria parameter object for the call
            var searchCriteria = new ScheduleSearchCriteria(); // ScheduleSearchCriteria | 
    
            try {
                // Returns a schedule based on the search criteria
                // "array[ScheduleViewObject]" is only psaudo-code to symbolize array of type and not the actual usage 
                array[ScheduleViewObject] result = apiInstance.findSchedule(searchCriteria);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TasksServiceApi.findSchedule: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    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' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.TasksServiceApi(api_client)
        # Initialize the searchCriteria parameter object for the call
        searchCriteria =  # ScheduleSearchCriteria | 
    
        try:
            # Returns a schedule based on the search criteria
            api_response = api_instance.find_schedule(searchCriteria)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling TasksServiceApi->findSchedule: %s\n" % e)
    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();
    $searchCriteria = ; // ScheduleSearchCriteria | 
    
    try {
        $result = $api_instance->findSchedule($searchCriteria);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling TasksServiceApi->findSchedule: ', $e->getMessage(), PHP_EOL;
    }
    ?>