Package com.seeq.api
Class ExportApi
java.lang.Object
com.seeq.api.ExportApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionarchiveExport
(String id) Archive an exportarchiveExportsOlderThan
(String duration) Archive any exports that have not been updated or used in the timeframe provided.archiveExportsOlderThanWithHeadersAndHttpInfo
(String duration, Map<String, String> customHeaders) Archive any exports that have not been updated or used in the timeframe provided.archiveExportsOlderThanWithHttpInfo
(String duration) Archive any exports that have not been updated or used in the timeframe provided.archiveExportWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive an exportArchive an exportcreateExport
(ExportItemsV1 body) Export data in the specified output format.createExportWithHeadersAndHttpInfo
(ExportItemsV1 body, Map<String, String> customHeaders) Export data in the specified output format.Export data in the specified output format.Get the details of an exportgetExports
(Boolean includeArchived, Integer offset, Integer limit) Get a collection of exportsgetExportsWithHeadersAndHttpInfo
(Boolean includeArchived, Integer offset, Integer limit, Map<String, String> customHeaders) Get a collection of exportsgetExportsWithHttpInfo
(Boolean includeArchived, Integer offset, Integer limit) Get a collection of exportsgetExportWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get the details of an exportGet the details of an exportlong
void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) updateExport
(String id, ExportItemsV1 body) Update the details of an exportupdateExportWithHeadersAndHttpInfo
(String id, ExportItemsV1 body, Map<String, String> customHeaders) Update the details of an exportupdateExportWithHttpInfo
(String id, ExportItemsV1 body) Update the details of an export
-
Constructor Details
-
ExportApi
public ExportApi() -
ExportApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveExport
Archive an export- Parameters:
id
- ID of the export to archive (required)- Returns:
- ExportItemsOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveExportWithHttpInfo
public ApiClient.ApiResponse<ExportItemsOutputV1> archiveExportWithHttpInfo(String id) throws ApiException Archive an export- Parameters:
id
- ID of the export to archive (required)- Throws:
ApiException
- if fails to make API call
-
archiveExportWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ExportItemsOutputV1> archiveExportWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive an export- Parameters:
id
- ID of the export to archive (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
archiveExportsOlderThan
Archive any exports that have not been updated or used in the timeframe provided. This may only be performed by administrators.- Parameters:
duration
- Archive any exports older than 'duration' (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
archiveExportsOlderThanWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> archiveExportsOlderThanWithHttpInfo(String duration) throws ApiException Archive any exports that have not been updated or used in the timeframe provided. This may only be performed by administrators.- Parameters:
duration
- Archive any exports older than 'duration' (required)- Throws:
ApiException
- if fails to make API call
-
archiveExportsOlderThanWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> archiveExportsOlderThanWithHeadersAndHttpInfo(String duration, Map<String, String> customHeaders) throws ApiExceptionArchive any exports that have not been updated or used in the timeframe provided. This may only be performed by administrators.- Parameters:
duration
- Archive any exports older than 'duration' (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createExport
Export data in the specified output format. Currently only xlsx and odata are supported.- Parameters:
body
- ExportItem defining the export output format as well a list of ExportItems to be included in the Export (required)- Returns:
- File
- Throws:
ApiException
- if fails to make API call
-
createExportWithHttpInfo
Export data in the specified output format. Currently only xlsx and odata are supported.- Parameters:
body
- ExportItem defining the export output format as well a list of ExportItems to be included in the Export (required)- Throws:
ApiException
- if fails to make API call
-
createExportWithHeadersAndHttpInfo
public ApiClient.ApiResponse<File> createExportWithHeadersAndHttpInfo(ExportItemsV1 body, Map<String, String> customHeaders) throws ApiExceptionExport data in the specified output format. Currently only xlsx and odata are supported.- Parameters:
body
- ExportItem defining the export output format as well a list of ExportItems to be included in the Export (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getExport
Get the details of an export- Parameters:
id
- ID of the export to retrieve (required)- Returns:
- ExportItemsOutputV1
- Throws:
ApiException
- if fails to make API call
-
getExportWithHttpInfo
public ApiClient.ApiResponse<ExportItemsOutputV1> getExportWithHttpInfo(String id) throws ApiException Get the details of an export- Parameters:
id
- ID of the export to retrieve (required)- Throws:
ApiException
- if fails to make API call
-
getExportWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ExportItemsOutputV1> getExportWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet the details of an export- Parameters:
id
- ID of the export to retrieve (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getExports
public ExportPreviewListV1 getExports(Boolean includeArchived, Integer offset, Integer limit) throws ApiException Get a collection of exports- Parameters:
includeArchived
- Whether archived exports should be included (optional, default to false)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- ExportPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getExportsWithHttpInfo
public ApiClient.ApiResponse<ExportPreviewListV1> getExportsWithHttpInfo(Boolean includeArchived, Integer offset, Integer limit) throws ApiException Get a collection of exports- Parameters:
includeArchived
- Whether archived exports should be included (optional, default to false)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getExportsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ExportPreviewListV1> getExportsWithHeadersAndHttpInfo(Boolean includeArchived, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of exports- Parameters:
includeArchived
- Whether archived exports should be included (optional, default to false)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateExport
Update the details of an export- Parameters:
id
- ID of the export to update (required)body
- Settings defining the export (required)- Returns:
- ExportItemsOutputV1
- Throws:
ApiException
- if fails to make API call
-
updateExportWithHttpInfo
public ApiClient.ApiResponse<ExportItemsOutputV1> updateExportWithHttpInfo(String id, ExportItemsV1 body) throws ApiException Update the details of an export- Parameters:
id
- ID of the export to update (required)body
- Settings defining the export (required)- Throws:
ApiException
- if fails to make API call
-
updateExportWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ExportItemsOutputV1> updateExportWithHeadersAndHttpInfo(String id, ExportItemsV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate the details of an export- Parameters:
id
- ID of the export to update (required)body
- Settings defining the export (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-