com.factset.sdk.FactSetEntityReportBuilder.api.EntityStructureApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetentityreportbuilder Show documentation
Show all versions of factsetentityreportbuilder Show documentation
FactSet SDK for Java - factsetentityreportbuilder
package com.factset.sdk.FactSetEntityReportBuilder.api;
import com.factset.sdk.FactSetEntityReportBuilder.ApiException;
import com.factset.sdk.FactSetEntityReportBuilder.ApiClient;
import com.factset.sdk.FactSetEntityReportBuilder.ApiResponse;
import com.factset.sdk.FactSetEntityReportBuilder.Configuration;
import com.factset.sdk.FactSetEntityReportBuilder.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetEntityReportBuilder.models.ErrorResponse;
import com.factset.sdk.FactSetEntityReportBuilder.models.Response;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class EntityStructureApi {
private ApiClient apiClient;
public EntityStructureApi() {
this(Configuration.getDefaultApiClient());
}
public EntityStructureApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getEntityStructureStructureResponseTypeMap = new HashMap();
static {
getEntityStructureStructureResponseTypeMap.put(200, new GenericType(){});
getEntityStructureStructureResponseTypeMap.put(400, new GenericType(){});
getEntityStructureStructureResponseTypeMap.put(403, new GenericType(){});
getEntityStructureStructureResponseTypeMap.put(404, new GenericType(){});
getEntityStructureStructureResponseTypeMap.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;
}
/**
* Entity structure
* Returns full entity tree for table and tree display
* @param id Company ticker (required)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns - tree - Entities are represented as tree nodes returned in a flat structure, where each parent node contains a children attribute pointing to its child nodes (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Expected response * Api-Supported-Versions - Supported API major versions
* Api-Version - API version (semantic versioning)
* X-DataDirect-Request-Key - FactSet request ID
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. * Api-Supported-Versions - Supported API major versions
* Api-Version - API version (semantic versioning)
* X-DataDirect-Request-Key - FactSet request ID
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 getEntityStructureStructure(String id, String schema) throws ApiException {
return getEntityStructureStructureWithHttpInfo(id, schema).getData();
}
/**
* Entity structure
* Returns full entity tree for table and tree display
* @param id Company ticker (required)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns - tree - Entities are represented as tree nodes returned in a flat structure, where each parent node contains a children attribute pointing to its child nodes (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Expected response * Api-Supported-Versions - Supported API major versions
* Api-Version - API version (semantic versioning)
* X-DataDirect-Request-Key - FactSet request ID
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. * Api-Supported-Versions - Supported API major versions
* Api-Version - API version (semantic versioning)
* X-DataDirect-Request-Key - FactSet request ID
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 getEntityStructureStructureWithHttpInfo(String id, String schema) 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 getEntityStructureStructure");
}
// create path and map variables
String localVarPath = "/structure";
// 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("", "schema", schema));
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("EntityStructureApi.getEntityStructureStructure", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEntityStructureStructureResponseTypeMap, false);
return apiResponse;
}
}