LinkedPaTemplatesApi

All URIs are relative to https://api.factset.com

Method	HTTP request	Description
createLinkedPATemplates	POST /analytics/engines/pa/v3/linked-templates	Create a linked PA template
deleteLinkedPATemplates	DELETE /analytics/engines/pa/v3/linked-templates/{id}	Delete a linked PA template.
getLinkedPATemplates	GET /analytics/engines/pa/v3/linked-templates	Get linked PA templates
getLinkedPATemplatesById	GET /analytics/engines/pa/v3/linked-templates/{id}	Get linked PA template by id
updateLinkedPATemplates	PUT /analytics/engines/pa/v3/linked-templates/{id}	Update a linked PA template

createLinkedPATemplates

LinkedPATemplatePostSummaryRoot createLinkedPATemplates(linkedPATemplateParametersRoot)

Create a linked PA template

This endpoint creates a template from an existing portfolio analysis tile, allowing the user to replicate and fetch reports settings.

Remarks:

Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation.
Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail".
We cannot override the Locked fields when creating the Component.
Mandatory and locked strings are mutually exclusive.
Multi-horizon frequencies are not supported through this endpoint.

Example

// Import classes:
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.model.*;
import factset.analyticsapi.engines.api.LinkedPaTemplatesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.factset.com");
        
        // Configure HTTP basic authorization: Basic
        HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
        Basic.setUsername("YOUR USERNAME");
        Basic.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: Bearer
        HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setBearerToken("BEARER TOKEN");

        LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
        LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = new LinkedPATemplateParametersRoot(); // LinkedPATemplateParametersRoot | Request Parameters
        try {
            LinkedPATemplatePostSummaryRoot result = apiInstance.createLinkedPATemplates(linkedPATemplateParametersRoot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LinkedPaTemplatesApi#createLinkedPATemplates");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getClientErrorResponse());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
linkedPATemplateParametersRoot	LinkedPATemplateParametersRoot	Request Parameters

Return type

LinkedPATemplatePostSummaryRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Expected response, created a template linked to a PA3 tile.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400	Invalid data provided. Please check the request parameters before attempting again.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401	Missing or invalid authentication.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403	User is forbidden with current credentials	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404	Component not found.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
406	Unsupported Accept header. Header needs to be set to application/json.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
429	Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
500	Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
503	Request timed out. Retry the request in sometime.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.

deleteLinkedPATemplates

deleteLinkedPATemplates(id)

Delete a linked PA template.

This endpoint deletes an existing linked PA template.

Example

// Import classes:
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.model.*;
import factset.analyticsapi.engines.api.LinkedPaTemplatesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.factset.com");
        
        // Configure HTTP basic authorization: Basic
        HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
        Basic.setUsername("YOUR USERNAME");
        Basic.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: Bearer
        HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setBearerToken("BEARER TOKEN");

        LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
        String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template
        try {
            apiInstance.deleteLinkedPATemplates(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LinkedPaTemplatesApi#deleteLinkedPATemplates");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getClientErrorResponse());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Unique identifier for a linked PA template

Return type

null (empty response body)

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
204	Expected response, deleted the linked PA template successfully.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400	Invalid data provided. Please check the request parameters before attempting again.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404	Template not found.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401	Missing or invalid authentication.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403	User is forbidden with current credentials	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
406	Unsupported Accept header. Header needs to be set to application/json.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
429	Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
500	Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
503	Request timed out. Retry the request in sometime.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.

getLinkedPATemplates

LinkedPATemplateSummaryRoot getLinkedPATemplates(directory, documentDirectory, documentName)

Get linked PA templates

This endpoint returns the list of linked PA templates in given path.

Example

// Import classes:
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.model.*;
import factset.analyticsapi.engines.api.LinkedPaTemplatesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.factset.com");
        
        // Configure HTTP basic authorization: Basic
        HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
        Basic.setUsername("YOUR USERNAME");
        Basic.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: Bearer
        HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setBearerToken("BEARER TOKEN");

        LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
        String directory = "Personal:LinkedPATemplates/"; // String | Get linked PA templates in path.
        String documentDirectory = "documentDirectory_example"; // String | Get linked PA templates for documents in document path
        String documentName = "documentName_example"; // String | Get linked PA templates for documents by document name
        try {
            LinkedPATemplateSummaryRoot result = apiInstance.getLinkedPATemplates(directory, documentDirectory, documentName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplates");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getClientErrorResponse());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
directory	String	Get linked PA templates in path.	[optional]
documentDirectory	String	Get linked PA templates for documents in document path	[optional]
documentName	String	Get linked PA templates for documents by document name	[optional]

Return type

LinkedPATemplateSummaryRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expected response, returns a list of templates linked to PA3 tile.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400	Invalid data provided. Please check the request parameters before attempting again.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404	Document not found	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401	Missing or invalid authentication.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403	User is forbidden with current credentials	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
406	Unsupported Accept header. Header needs to be set to application/json.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
429	Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
500	Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
503	Request timed out. Retry the request in sometime.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.

getLinkedPATemplatesById

LinkedPATemplateRoot getLinkedPATemplatesById(id)

Get linked PA template by id

This endpoint fetches the linked PA template settings.

Example

// Import classes:
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.model.*;
import factset.analyticsapi.engines.api.LinkedPaTemplatesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.factset.com");
        
        // Configure HTTP basic authorization: Basic
        HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
        Basic.setUsername("YOUR USERNAME");
        Basic.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: Bearer
        HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setBearerToken("BEARER TOKEN");

        LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
        String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template
        try {
            LinkedPATemplateRoot result = apiInstance.getLinkedPATemplatesById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplatesById");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getClientErrorResponse());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Unique identifier for a linked PA template

Return type

LinkedPATemplateRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expected response, linked PA template details.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400	Invalid data provided. Please check the request parameters before attempting again.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404	Template not found.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401	Missing or invalid authentication.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403	User is forbidden with current credentials	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
406	Unsupported Accept header. Header needs to be set to application/json.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
429	Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
500	Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
503	Request timed out. Retry the request in sometime.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.

updateLinkedPATemplates

LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot)

Update a linked PA template

This endpoint allows the user to change the request body and description from an existing template.

Remarks:

Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation.
Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail".
We cannot override the Locked fields when creating the Component.
Mandatory and locked strings are mutually exclusive.
Multi-horizon frequencies are not supported through this endpoint.

Example

// Import classes:
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.model.*;
import factset.analyticsapi.engines.api.LinkedPaTemplatesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.factset.com");
        
        // Configure HTTP basic authorization: Basic
        HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
        Basic.setUsername("YOUR USERNAME");
        Basic.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: Bearer
        HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setBearerToken("BEARER TOKEN");

        LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
        String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template
        LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot = new LinkedPATemplateUpdateParametersRoot(); // LinkedPATemplateUpdateParametersRoot | Request Parameters
        try {
            LinkedPATemplatePostSummaryRoot result = apiInstance.updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LinkedPaTemplatesApi#updateLinkedPATemplates");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getClientErrorResponse());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Unique identifier for a linked PA template
linkedPATemplateUpdateParametersRoot	LinkedPATemplateUpdateParametersRoot	Request Parameters

Return type

LinkedPATemplatePostSummaryRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expected response, updated a template linked to a PA3 tile.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400	Invalid data provided. Please check the request parameters before attempting again.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404	Template or component not found.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401	Missing or invalid authentication.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403	User is forbidden with current credentials	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
406	Unsupported Accept header. Header needs to be set to application/json.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
429	Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
500	Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
503	Request timed out. Retry the request in sometime.	* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LinkedPaTemplatesApi

createLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLinkedPATemplatesById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

LinkedPaTemplatesApi.md

Latest commit

History

LinkedPaTemplatesApi.md

File metadata and controls

LinkedPaTemplatesApi

createLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLinkedPATemplatesById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateLinkedPATemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details