com.factset.sdk.FactSetPrivateMarkets.api.DataItemsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetprivatemarkets Show documentation
Show all versions of factsetprivatemarkets Show documentation
FactSet SDK for Java - factsetprivatemarkets
The newest version!
package com.factset.sdk.FactSetPrivateMarkets.api;
import com.factset.sdk.FactSetPrivateMarkets.ApiException;
import com.factset.sdk.FactSetPrivateMarkets.ApiClient;
import com.factset.sdk.FactSetPrivateMarkets.ApiResponse;
import com.factset.sdk.FactSetPrivateMarkets.Configuration;
import com.factset.sdk.FactSetPrivateMarkets.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetPrivateMarkets.models.ErrorResponse;
import com.factset.sdk.FactSetPrivateMarkets.models.FieldsResponse;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class DataItemsApi {
private ApiClient apiClient;
public DataItemsApi() {
this(Configuration.getDefaultApiClient());
}
public DataItemsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getFieldsResponseTypeMap = new HashMap();
static {
getFieldsResponseTypeMap.put(200, new GenericType(){});
getFieldsResponseTypeMap.put(400, new GenericType(){});
getFieldsResponseTypeMap.put(401, new GenericType(){});
getFieldsResponseTypeMap.put(403, new GenericType(){});
getFieldsResponseTypeMap.put(415, new GenericType(){});
getFieldsResponseTypeMap.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;
}
/**
* Available private company fields, metrics, and ratios.
* Returns list of available Private Company fields that can be used in the `fields` parameter of related endpoints. These are related to FactSet Private Company standardized data.
* @param category Filters the list of available fields per endpoint - * **FINANCIALS** = Financials endpoint data items, such as Assets, Liabilities, and EBITDA. * **NON_PERIODIC** = Non-Periodic endpoint data items, such as ISO Currency, Current CEO, and Investor List. (optional)
* @return FieldsResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Private Company data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public FieldsResponse getFields(String category) throws ApiException {
return getFieldsWithHttpInfo(category).getData();
}
/**
* Available private company fields, metrics, and ratios.
* Returns list of available Private Company fields that can be used in the `fields` parameter of related endpoints. These are related to FactSet Private Company standardized data.
* @param category Filters the list of available fields per endpoint - * **FINANCIALS** = Financials endpoint data items, such as Assets, Liabilities, and EBITDA. * **NON_PERIODIC** = Non-Periodic endpoint data items, such as ISO Currency, Current CEO, and Investor List. (optional)
* @return ApiResponse<FieldsResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Private Company data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public ApiResponse getFieldsWithHttpInfo(String category) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/factset-private-markets/v1/fields";
// 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("", "category", category));
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<
FieldsResponse
> apiResponse = apiClient.invokeAPI("DataItemsApi.getFields", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getFieldsResponseTypeMap, false);
return apiResponse;
}
}