All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.factset.sdk.FactSetEstimatesReportBuilder.api.EstimateTablesApi Maven / Gradle / Ivy

Go to download 

package com.factset.sdk.FactSetEstimatesReportBuilder.api;

import com.factset.sdk.FactSetEstimatesReportBuilder.ApiException;
import com.factset.sdk.FactSetEstimatesReportBuilder.ApiClient;
import com.factset.sdk.FactSetEstimatesReportBuilder.ApiResponse;
import com.factset.sdk.FactSetEstimatesReportBuilder.Configuration;
import com.factset.sdk.FactSetEstimatesReportBuilder.Pair;

import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

import com.factset.sdk.FactSetEstimatesReportBuilder.models.ErrorResponse;
import com.factset.sdk.FactSetEstimatesReportBuilder.models.Response;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")

public class EstimateTablesApi {
  private ApiClient apiClient;

  public EstimateTablesApi() {
    this(Configuration.getDefaultApiClient());
  }

  public EstimateTablesApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map getEstimateTablesTableResponseTypeMap = new HashMap();
  static {
    getEstimateTablesTableResponseTypeMap.put(200, new GenericType(){});
    getEstimateTablesTableResponseTypeMap.put(400, new GenericType(){});
    getEstimateTablesTableResponseTypeMap.put(403, new GenericType(){});
    getEstimateTablesTableResponseTypeMap.put(404, new GenericType(){});
    getEstimateTablesTableResponseTypeMap.put(500, new GenericType(){});
  }

  


  /**
   * Get the API client
   *
   * @return API client
   */
  public ApiClient getApiClient() {
    return apiClient;
  }

  /**
   * Set the API client
   *
   * @param apiClient an instance of API client
   */
  public void setApiClient(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Interim/Annual Estimate Table
   * Returns a timeseries grid of Interim and Annual data for a single line item
   * @param id Company Ticker (required)
   * @param metric Requested metric. For more details, visit [Online Assitant Page #15034](https://oa.apps.factset.com/pages/15034). (optional)
   * @return Response
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code  Description  Response Headers 

       
 200  Expected response; returns JSON data containing STACH 2.0 row organized package format   * X-DataDirect-Request-Key - FactSet request ID 
  * Api-Supported-Versions - Supported API versions (semantic versioning) 
  * Api-Version - API version (semantic versioning) 
  

       
 400  Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  * Api-Supported-Versions - Supported API versions (semantic versioning) 
  * Api-Version - API version (semantic versioning) 
  

       
 401  Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 403  User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 404  Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 429  Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 500  Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 503  Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

     

   */
  public Response getEstimateTablesTable(String id, String metric) throws ApiException {
    return getEstimateTablesTableWithHttpInfo(id, metric).getData();
  }

  /**
   * Interim/Annual Estimate Table
   * Returns a timeseries grid of Interim and Annual data for a single line item
   * @param id Company Ticker (required)
   * @param metric Requested metric. For more details, visit [Online Assitant Page #15034](https://oa.apps.factset.com/pages/15034). (optional)
   * @return ApiResponse<Response>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code  Description  Response Headers 

       
 200  Expected response; returns JSON data containing STACH 2.0 row organized package format   * X-DataDirect-Request-Key - FactSet request ID 
  * Api-Supported-Versions - Supported API versions (semantic versioning) 
  * Api-Version - API version (semantic versioning) 
  

       
 400  Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  * Api-Supported-Versions - Supported API versions (semantic versioning) 
  * Api-Version - API version (semantic versioning) 
  

       
 401  Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 403  User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 404  Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 429  Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 500  Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

       
 503  Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.   * X-DataDirect-Request-Key - FactSet request ID 
  

     

   */
  public ApiResponse getEstimateTablesTableWithHttpInfo(String id, String metric) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'id' is set
    if (id == null) {
      throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimateTablesTable");
    }
    
    // create path and map variables
    String localVarPath = "/table";

    // query params
    java.util.List localVarQueryParams = new java.util.ArrayList();
    java.util.Map localVarHeaderParams = new java.util.HashMap();
    java.util.Map localVarCookieParams = new java.util.HashMap();
    java.util.Map localVarFormParams = new java.util.HashMap();

    localVarQueryParams.addAll(apiClient.parameterToPairs("", "id", id));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "metric", metric));

    
    
    
    final String[] localVarAccepts = {
      "application/json"
    };
    final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

    final String[] localVarContentTypes = {
      
    };
    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

    String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };


    ApiResponse<
        
        Response
      
    > apiResponse = apiClient.invokeAPI("EstimateTablesApi.getEstimateTablesTable", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getEstimateTablesTableResponseTypeMap, false);

    return apiResponse;

  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy