net.leanix.api

Class ExportsApi

java.lang.Object

net.leanix.api.ExportsApi

public class ExportsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ExportsApi()
ExportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
JobResponse	createExportFile() createExportFile Creates an excel export file by using the given graphQL query and table configuration
JobResponse	createFullExport(String exportType, String startDate, String endDate) createFullExport Creates a full export of the workspace data, or an export of the changelog, depending on given type
void	downloadExportFile(String workspaceId, String key) downloadExportFile Returns the download file for the given ID
ApiClient	getApiClient()
ExportListResponse	getExports(String exportType, UUID userId, Integer pageSize, String cursor, String sorting, String sortDirection) getExports Lists all exports of the given type in the workspace of the authorized user
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExportsApi

public ExportsApi()

ExportsApi

public ExportsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createExportFile

public JobResponse createExportFile()
                             throws ApiException

createExportFile Creates an excel export file by using the given graphQL query and table configuration

Returns:

JobResponse

Throws:

ApiException - if fails to make API call

createFullExport

public JobResponse createFullExport(String exportType,
                                    String startDate,
                                    String endDate)
                             throws ApiException

createFullExport Creates a full export of the workspace data, or an export of the changelog, depending on given type

Parameters:

exportType - The type of the export, must be either SNAPSHOT, AUDIT_LOG or AUDIT_LOG_LEGACY (optional)

startDate - The start date of the audit log export in ISO-8601 format. (optional)

endDate - The end date of the audit log export in ISO-8601 format. If left empty today is assumed (optional)

Returns:

JobResponse

Throws:

ApiException - if fails to make API call

downloadExportFile

public void downloadExportFile(String workspaceId,
                               String key)
                        throws ApiException

downloadExportFile Returns the download file for the given ID

Parameters:

workspaceId - the ID of the workspace to retrieve the download for (required)

key - a one time use key identifying the download to retrieve (required)

Throws:

ApiException - if fails to make API call

getExports

public ExportListResponse getExports(String exportType,
                                     UUID userId,
                                     Integer pageSize,
                                     String cursor,
                                     String sorting,
                                     String sortDirection)
                              throws ApiException

getExports Lists all exports of the given type in the workspace of the authorized user

Parameters:

exportType - Comma separated list of types of exports to return, if left empty AUDIT_LOG and SNAPSHOT, and AUDIT_LOG_LEGACY exports are returned (optional)

userId - Retrieve exports initiated by the given user (optional)

pageSize - Number of Exports to return, maximum is 100 (optional, default to 40)

cursor - Marks the position of the first element that should be returned (optional)

sorting - the field to sort the results by (optional, default to createdAt)

sortDirection - the direction of the sorting (optional, default to ASC)

Returns:

ExportListResponse

Throws:

ApiException - if fails to make API call