com.factset.sdk.FactSetRBICS.api.EntityFocusApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetrbics Show documentation
Show all versions of factsetrbics Show documentation
FactSet SDK for Java - factsetrbics
The newest version!
package com.factset.sdk.FactSetRBICS.api;
import com.factset.sdk.FactSetRBICS.ApiException;
import com.factset.sdk.FactSetRBICS.ApiClient;
import com.factset.sdk.FactSetRBICS.ApiResponse;
import com.factset.sdk.FactSetRBICS.Configuration;
import com.factset.sdk.FactSetRBICS.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetRBICS.models.EntityFocusRequest;
import com.factset.sdk.FactSetRBICS.models.EntityFocusResponse;
import com.factset.sdk.FactSetRBICS.models.ErrorResponse;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class EntityFocusApi {
private ApiClient apiClient;
public EntityFocusApi() {
this(Configuration.getDefaultApiClient());
}
public EntityFocusApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getRbicsEntityFocusResponseTypeMap = new HashMap();
static {
getRbicsEntityFocusResponseTypeMap.put(200, new GenericType(){});
getRbicsEntityFocusResponseTypeMap.put(400, new GenericType(){});
getRbicsEntityFocusResponseTypeMap.put(401, new GenericType(){});
getRbicsEntityFocusResponseTypeMap.put(403, new GenericType(){});
getRbicsEntityFocusResponseTypeMap.put(415, new GenericType(){});
getRbicsEntityFocusResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getRbicsEntityFocusForListResponseTypeMap = new HashMap();
static {
getRbicsEntityFocusForListResponseTypeMap.put(200, 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 RBICS classification for the Focus industry
* Gets RBICS classifications for the Focus industry for a short list of companies. Full history is included if _date_ parameter is not specified. RBICS Focus offers a single-sector mapping of about 48,000 of the most liquid and publicly-traded companies based on their primary lines of business; it uses revenues as the key factor in determining a company’s primary line of business, by mapping a company to the lowest-level sector from which it derives 50% or more of its revenues. The RBICS Extended Universe – Industry Group is not currently supported through the RBICS API.
* @param ids List of Company identifiers. Accepted identifiers include Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet Permanent Ids, such as -R, -L, or -E.<p>**ids limit = 2500 per request**</p> Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p> (required)
* @param date Effective date for data expressed in YYYY-MM-DD format. If no date is requested, the default behavior is to return the full history for the requested entity. (optional)
* @param levels List of RBICS industry levels to include in the response. **By default if left blank, all levels are returned.** (optional)
* @param includeNames Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names. (optional, default to true)
* @return EntityFocusResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Successful Response producing an array of Entity Focus Objects - 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 EntityFocusResponse getRbicsEntityFocus(java.util.List ids, String date, java.util.Set levels, Boolean includeNames) throws ApiException {
return getRbicsEntityFocusWithHttpInfo(ids, date, levels, includeNames).getData();
}
/**
* Get RBICS classification for the Focus industry
* Gets RBICS classifications for the Focus industry for a short list of companies. Full history is included if _date_ parameter is not specified. RBICS Focus offers a single-sector mapping of about 48,000 of the most liquid and publicly-traded companies based on their primary lines of business; it uses revenues as the key factor in determining a company’s primary line of business, by mapping a company to the lowest-level sector from which it derives 50% or more of its revenues. The RBICS Extended Universe – Industry Group is not currently supported through the RBICS API.
* @param ids List of Company identifiers. Accepted identifiers include Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet Permanent Ids, such as -R, -L, or -E.<p>**ids limit = 2500 per request**</p> Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p> (required)
* @param date Effective date for data expressed in YYYY-MM-DD format. If no date is requested, the default behavior is to return the full history for the requested entity. (optional)
* @param levels List of RBICS industry levels to include in the response. **By default if left blank, all levels are returned.** (optional)
* @param includeNames Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names. (optional, default to true)
* @return ApiResponse<EntityFocusResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Successful Response producing an array of Entity Focus Objects - 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 getRbicsEntityFocusWithHttpInfo(java.util.List ids, String date, java.util.Set levels, Boolean includeNames) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ids' is set
if (ids == null) {
throw new ApiException(400, "Missing the required parameter 'ids' when calling getRbicsEntityFocus");
}
// create path and map variables
String localVarPath = "/factset-rbics/v1/entity-focus";
// 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("csv", "ids", ids));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "date", date));
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "levels", levels));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "includeNames", includeNames));
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<
EntityFocusResponse
> apiResponse = apiClient.invokeAPI("EntityFocusApi.getRbicsEntityFocus", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getRbicsEntityFocusResponseTypeMap, false);
return apiResponse;
}
/**
* Get RBICS classification for the Focus industry
* Gets RBICS classifications for the Focus industry for a long list of companies. Full history is included if _date_ parameter is not specified. RBICS Focus offers a single-sector mapping of about 48,000 of the most liquid and publicly-traded companies based on their primary lines of business; it uses revenues as the key factor in determining a company’s primary line of business, by mapping a company to the lowest-level sector from which it derives 50% or more of its revenues. The RBICS Extended Universe – Industry Group is not currently supported through the RBICS API.
* @param entityFocusRequest Request Body to request a list of RBICS Entity Focus objects. (required)
* @return EntityFocusResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Successful Response producing an array of Entity Focus Objects -
*/
public EntityFocusResponse getRbicsEntityFocusForList(EntityFocusRequest entityFocusRequest) throws ApiException {
return getRbicsEntityFocusForListWithHttpInfo(entityFocusRequest).getData();
}
/**
* Get RBICS classification for the Focus industry
* Gets RBICS classifications for the Focus industry for a long list of companies. Full history is included if _date_ parameter is not specified. RBICS Focus offers a single-sector mapping of about 48,000 of the most liquid and publicly-traded companies based on their primary lines of business; it uses revenues as the key factor in determining a company’s primary line of business, by mapping a company to the lowest-level sector from which it derives 50% or more of its revenues. The RBICS Extended Universe – Industry Group is not currently supported through the RBICS API.
* @param entityFocusRequest Request Body to request a list of RBICS Entity Focus objects. (required)
* @return ApiResponse<EntityFocusResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Successful Response producing an array of Entity Focus Objects -
*/
public ApiResponse getRbicsEntityFocusForListWithHttpInfo(EntityFocusRequest entityFocusRequest) throws ApiException {
Object localVarPostBody = entityFocusRequest;
// verify the required parameter 'entityFocusRequest' is set
if (entityFocusRequest == null) {
throw new ApiException(400, "Missing the required parameter 'entityFocusRequest' when calling getRbicsEntityFocusForList");
}
// create path and map variables
String localVarPath = "/factset-rbics/v1/entity-focus";
// 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 = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
EntityFocusResponse
> apiResponse = apiClient.invokeAPI("EntityFocusApi.getRbicsEntityFocusForList", localVarPath, "POST", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getRbicsEntityFocusForListResponseTypeMap, false);
return apiResponse;
}
}