Get Master Flow Execution Progress logs

This returns the full progress log of a Master Flow execution

Method

/API3/dataSources/getMasterFlowProgressLogs

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

Method Signature

Input Parameters

Name

request

Object Type

MasterFlowProgressLogRequest

Description

Describes request for the progress logs of masterflow execution

Output Response

Successful Result Code

200

Response List Type

MasterFlowProgressLogItem[]

Description of Response Type

Item in the Progress log of a master flow execution. Note that the response is returned as a list of items of this object type.

Notes

This function should be used in conjunction with other functions that can launch the execution of a master flow.

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/dataSources/getMasterFlowProgressLogs" \
 -d '{
  "scheduleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "taskId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'

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

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

public class DataSourcesServiceApiExample {
    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
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the request parameter object for the call
        MasterFlowProgressLogRequest request = ; // Create the input object for the operation, type: MasterFlowProgressLogRequest 

        try {
            // "array[MasterFlowProgressLogItem]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[MasterFlowProgressLogItem] result = apiInstance.getMasterFlowProgressLogs(request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#getMasterFlowProgressLogs");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

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

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

const request = ; // {MasterFlowProgressLogRequest} 

api.getMasterFlowProgressLogs(request).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 getMasterFlowProgressLogsExample
{
    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 DataSourcesServiceApi();
        // Initialize the request parameter object for the call
        var request = new MasterFlowProgressLogRequest(); // MasterFlowProgressLogRequest | 

        try {
            // This returns the full progress log of a Master Flow execution
            // "array[MasterFlowProgressLogItem]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[MasterFlowProgressLogItem] result = apiInstance.getMasterFlowProgressLogs(request);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.getMasterFlowProgressLogs: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
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 = DataSourcesServiceApi(api_client)
    # Initialize the request parameter object for the call
    request =  # MasterFlowProgressLogRequest | 

    try:
        # This returns the full progress log of a Master Flow execution
        api_response = api_instance.get_master_flow_progress_logs(request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->getMasterFlowProgressLogs: %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\DataSourcesServiceApi();
$request = ; // MasterFlowProgressLogRequest | 

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