Skip to content

Latest commit

 

History

History
418 lines (319 loc) · 30.3 KB

File metadata and controls

418 lines (319 loc) · 30.3 KB

fds.analyticsapi.engines.ComponentsApi

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

Method HTTP request Description
get_pa_component_by_id GET /analytics/lookups/v2/engines/pa/components/{id} Get PA component by id
get_pa_components GET /analytics/lookups/v2/engines/pa/components Get PA components
get_spar_components GET /analytics/lookups/v2/engines/spar/components Get SPAR components
get_vault_component_by_id GET /analytics/lookups/v2/engines/vault/components/{id} Get Vault component by id
get_vault_components GET /analytics/lookups/v2/engines/vault/components Get Vault components

get_pa_component_by_id

PAComponent get_pa_component_by_id(id)

Get PA component by id

This endpoint returns the default settings of a PA component.

Example

  • Basic Authentication (Basic):
from __future__ import print_function
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
    host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fds.analyticsapi.engines.ComponentsApi(api_client)
    id = 'id_example' # str | Unique identifier for a PA component

    try:
        # Get PA component by id
        api_response = api_instance.get_pa_component_by_id(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComponentsApi->get_pa_component_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str Unique identifier for a PA component

Return type

PAComponent

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Expected response, returns the default settings of a PA component. * 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-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 PA component 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.
* 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.
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-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 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-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.
* 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.
* 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.

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

get_pa_components

dict(str, ComponentSummary) get_pa_components(document)

Get PA components

This endpoint returns the list of PA components in a given PA document.

Example

  • Basic Authentication (Basic):
from __future__ import print_function
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
    host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fds.analyticsapi.engines.ComponentsApi(api_client)
    document = 'document_example' # str | Document Name

    try:
        # Get PA components
        api_response = api_instance.get_pa_components(document)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComponentsApi->get_pa_components: %s\n" % e)

Parameters

Name Type Description Notes
document str Document Name

Return type

dict(str, ComponentSummary)

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 components. * 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-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 query parameter provided or Invalid PA document name. * 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-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.
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-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 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-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.
* 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.
* 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.

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

get_spar_components

dict(str, ComponentSummary) get_spar_components(document)

Get SPAR components

This endpoint returns the list of SPAR components in a given SPAR document.

Example

  • Basic Authentication (Basic):
from __future__ import print_function
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
    host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fds.analyticsapi.engines.ComponentsApi(api_client)
    document = 'document_example' # str | Document Name

    try:
        # Get SPAR components
        api_response = api_instance.get_spar_components(document)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComponentsApi->get_spar_components: %s\n" % e)

Parameters

Name Type Description Notes
document str Document Name

Return type

dict(str, ComponentSummary)

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 SPAR components. * 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-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 query parameter provided or Invalid SPAR document name. * 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-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.
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-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 SPAR 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-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.
* 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.
* 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.

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

get_vault_component_by_id

VaultComponent get_vault_component_by_id(id)

Get Vault component by id

This endpoint returns the default settings of a Vault component.

Example

  • Basic Authentication (Basic):
from __future__ import print_function
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
    host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fds.analyticsapi.engines.ComponentsApi(api_client)
    id = 'id_example' # str | Unique identifier for a vault component

    try:
        # Get Vault component by id
        api_response = api_instance.get_vault_component_by_id(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComponentsApi->get_vault_component_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str Unique identifier for a vault component

Return type

VaultComponent

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Expected response, returns the default settings of a Vault component. * 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-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 Vault component 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.
* 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.
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-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 Vault 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-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.
* 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.
* 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.

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

get_vault_components

dict(str, ComponentSummary) get_vault_components(document)

Get Vault components

This endpoint returns the list of Vault components in a given Vault document.

Example

  • Basic Authentication (Basic):
from __future__ import print_function
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
    host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fds.analyticsapi.engines.ComponentsApi(api_client)
    document = 'document_example' # str | Document Name

    try:
        # Get Vault components
        api_response = api_instance.get_vault_components(document)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComponentsApi->get_vault_components: %s\n" % e)

Parameters

Name Type Description Notes
document str Document Name

Return type

dict(str, ComponentSummary)

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 Vault components. * 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-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 query parameter provided or invalid Vault document name. * 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-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.
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-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 Vault 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-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.
* 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.
* 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.

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