Updates a model's process date

Updates the 'last process date' for a selected semantic/data model.

Method

/API3/dataSources/updateModelProcessDate

  • API Section: /API3/dataSources
  • 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

Method Signature

Input Parameters

Name

processDateObject

Object Type

ModelProcessDateObject

Description

The connection string id and the new model process date to be updated.

Output Response

Successful Result Code

200

Response Type

ModelProcessDateResult

Description of Response Type

The result from updating a model's process date

Notes

Use this method to update last process date for any semantic model in the system - external (e.e SAP BW, MS OLAP) or internal Pyramid model. Use this capability in conjunction with 'on demand' schedules - to trigger executions of all related item schedules that are contingent on an updated process data for a 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/dataSources/updateModelProcessDate" \
 -d '{
  "runOnDemandSchedules" : true,
  "connectionStringId" : "connectionStringId",
  "modelProcessDate" : "2000-01-23T04:56:07.000+00:00"
}'

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

        try {
            ModelProcessDateResult result = apiInstance.updateModelProcessDate(processDateObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#updateModelProcessDate");
            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 processDateObject = ; // {ModelProcessDateObject} 

api.updateModelProcessDate(processDateObject).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 updateModelProcessDateExample
{
    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 processDateObject parameter object for the call
        var processDateObject = new ModelProcessDateObject(); // ModelProcessDateObject | 

        try {
            // Updates the 'last process date' for a selected semantic/data model.
            ModelProcessDateResult result = apiInstance.updateModelProcessDate(processDateObject);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.updateModelProcessDate: " + 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 processDateObject parameter object for the call
    processDateObject =  # ModelProcessDateObject | 

    try:
        # Updates the 'last process date' for a selected semantic/data model.
        api_response = api_instance.update_model_process_date(processDateObject)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->updateModelProcessDate: %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();
$processDateObject = ; // ModelProcessDateObject | 

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