Skip to content

SPARBenchmarkApi.md

Latest commit

 

History

History
91 lines (70 loc) · 6.08 KB

SPARBenchmarkApi.md

File metadata and controls

91 lines (70 loc) · 6.08 KB

FactSet.AnalyticsAPI.Engines.Api.SPARBenchmarkApi

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

Method HTTP request Description
GetSPARBenchmarkById GET /analytics/lookups/v2/engines/spar/benchmarks Get SPAR benchmark details

GetSPARBenchmarkById

SPARBenchmark GetSPARBenchmarkById (string id)

Get SPAR benchmark details

This endpoint returns the details of a given SPAR benchmark identifier.

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 GetSPARBenchmarkByIdExample
    {
        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 SPARBenchmarkApi(config);
            var id = id_example;  // string | Benchmark Identifier

            try
            {
                // Get SPAR benchmark details
                SPARBenchmark result = apiInstance.GetSPARBenchmarkById(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SPARBenchmarkApi.GetSPARBenchmarkById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string Benchmark Identifier

Return type

SPARBenchmark

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 list of prefix and return types for the benchmark. * 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 benchmark identifier. * 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 Benchmark identifier 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]