• Home
• com.factset.sdk
• paengine
• 3.1.0
• source code
• DocumentsApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.factset.sdk.PAEngine.api.DocumentsApi Maven / Gradle / Ivy

package com.factset.sdk.PAEngine.api;

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

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

import com.factset.sdk.PAEngine.models.ClientErrorResponse;
import com.factset.sdk.PAEngine.models.DocumentDirectoriesRoot;

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

public class DocumentsApi {
  private ApiClient apiClient;

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

  public DocumentsApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map getPA3DocumentsResponseTypeMap = new HashMap();
  static {
    getPA3DocumentsResponseTypeMap.put(200, new GenericType(){});
    getPA3DocumentsResponseTypeMap.put(400, new GenericType(){});
    getPA3DocumentsResponseTypeMap.put(404, 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;
  }

  /**
   * Get PA3 documents and sub-directories in a directory
   * This endpoint looks up all PA3 documents and sub-directories in a given directory.
   * @param path The directory to get the documents and sub-directories in (required)
   * @return DocumentDirectoriesRoot
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns a list of PA3 documents and directories 
  * 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 query parameter or value provided 
  * 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 
 Path 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 some time 
  * 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. 
  
     
   */
  public DocumentDirectoriesRoot getPA3Documents(String path) throws ApiException {
    return getPA3DocumentsWithHttpInfo(path).getData();
  }

  /**
   * Get PA3 documents and sub-directories in a directory
   * This endpoint looks up all PA3 documents and sub-directories in a given directory.
   * @param path The directory to get the documents and sub-directories in (required)
   * @return ApiResponse<DocumentDirectoriesRoot>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns a list of PA3 documents and directories 
  * 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 query parameter or value provided 
  * 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 
 Path 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 some time 
  * 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. 
  
     
   */
  public ApiResponse getPA3DocumentsWithHttpInfo(String path) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'path' is set
    if (path == null) {
      throw new ApiException(400, "Missing the required parameter 'path' when calling getPA3Documents");
    }
    
    // create path and map variables
    String localVarPath = "/analytics/engines/pa/v3/documents/{path}"
      .replaceAll("\\{" + "path" + "\\}", apiClient.escapeString(path.toString()));

    // 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();


    
    
    
    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<
        
        DocumentDirectoriesRoot
      
    > apiResponse = apiClient.invokeAPI("DocumentsApi.getPA3Documents", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getPA3DocumentsResponseTypeMap, false);

    return apiResponse;

  }
}