Skip to content

ColumnsApi.md

Latest commit

 

History

History
176 lines (138 loc) · 12.9 KB

ColumnsApi.md

File metadata and controls

176 lines (138 loc) · 12.9 KB

FactSet.AnalyticsAPI.Engines.Api.ColumnsApi

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

Method HTTP request Description
GetPAColumnById GET /analytics/lookups/v2/engines/pa/columns/{id} Get PA column settings
GetPAColumns GET /analytics/lookups/v2/engines/pa/columns Get PA columns

GetPAColumnById

Column GetPAColumnById (string id)

Get PA column settings

This endpoint returns the default settings of a PA column.

Example

using System.Collections.Generic;
using System.Diagnostics;
using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

namespace Example
{
    public class GetPAColumnByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.factset.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnsApi(config);
            var id = id_example;  // string | Unique identifier for a column

            try
            {
                // Get PA column settings
                Column result = apiInstance.GetPAColumnById(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ColumnsApi.GetPAColumnById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string Unique identifier for a column

Return type

Column

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Expected response, returns settings of a PA column. * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400 Invalid column Id. * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404 Column 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPAColumns

Dictionary<string, ColumnSummary> GetPAColumns (string name = null, string category = null, string directory = null)

Get PA columns

This endpoint lists all the PA columns that can be applied to a calculation.

Example

using System.Collections.Generic;
using System.Diagnostics;
using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

namespace Example
{
    public class GetPAColumnsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.factset.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnsApi(config);
            var name = name_example;  // string | Column name (optional)  (default to "")
            var category = category_example;  // string | Column category (optional)  (default to "")
            var directory = directory_example;  // string | The directory to get the columns in (optional)  (default to "")

            try
            {
                // Get PA columns
                Dictionary<string, ColumnSummary> result = apiInstance.GetPAColumns(name, category, directory);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ColumnsApi.GetPAColumns: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
name string Column name [optional] [default to ""]
category string Column category [optional] [default to ""]
directory string The directory to get the columns in [optional] [default to ""]

Return type

Dictionary<string, ColumnSummary>

Authorization

Basic

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 PA columns * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.

[Back to top] [Back to API list] [Back to Model list] [Back to README]