Skip to content

Latest commit

 

History

History
228 lines (164 loc) · 7.86 KB

ExportApi.md

File metadata and controls

228 lines (164 loc) · 7.86 KB

ExportApi

All URIs are relative to https://api.artik.cloud/v1.1

Method HTTP request Description
exportRequest POST /messages/export Create Export Request
getExportHistory GET /messages/export/history Get Export History
getExportResult GET /messages/export/{exportId}/result Get Export Result
getExportStatus GET /messages/export/{exportId}/status Check Export Status

exportRequest

ExportRequestResponse exportRequest(exportRequestInfo)

Create Export Request

Export normalized messages. The following input combinations are supported:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Get by users</td><td>uids</td><td>Search by a list of User IDs. For each user in the list, the current authenticated user must have read access over the specified user.</td></tr><tr><td>Get by devices</td><td>sdids</td><td>Search by Source Device IDs.</td></tr><tr><td>Get by device types</td><td>uids,sdtids</td><td>Search by list of Source Device Type IDs for the given list of users.</td></tr><tr><td>Get by trial</td><td>trialId</td><td>Search by Trial ID.</td></tr><tr><td>Get by combination of parameters</td><td>uids,sdids,sdtids</td><td>Search by list of Source Device IDs. Each Device ID must belong to a Source Device Type ID and a User ID.</td></tr><tr><td>Common</td><td>startDate,endDate,order,format,url,csvHeaders</td><td>Parameters that can be used with the above combinations.</td></tr></table>

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.ExportApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

ExportApi apiInstance = new ExportApi();
ExportRequestInfo exportRequestInfo = new ExportRequestInfo(); // ExportRequestInfo | ExportRequest object that is passed in the body
try {
    ExportRequestResponse result = apiInstance.exportRequest(exportRequestInfo);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExportApi#exportRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
exportRequestInfo ExportRequestInfo ExportRequest object that is passed in the body

Return type

ExportRequestResponse

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getExportHistory

ExportHistoryResponse getExportHistory(trialId, count, offset)

Get Export History

Get the history of export requests.

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.ExportApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

ExportApi apiInstance = new ExportApi();
String trialId = "trialId_example"; // String | Filter by trialId.
Integer count = 56; // Integer | Pagination count.
Integer offset = 56; // Integer | Pagination offset.
try {
    ExportHistoryResponse result = apiInstance.getExportHistory(trialId, count, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExportApi#getExportHistory");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
trialId String Filter by trialId. [optional]
count Integer Pagination count. [optional]
offset Integer Pagination offset. [optional]

Return type

ExportHistoryResponse

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getExportResult

String getExportResult(exportId)

Get Export Result

Retrieve result of the export query in tgz format. The tar file may contain one or more files with the results.

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.ExportApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

ExportApi apiInstance = new ExportApi();
String exportId = "exportId_example"; // String | Export ID of the export query.
try {
    String result = apiInstance.getExportResult(exportId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExportApi#getExportResult");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
exportId String Export ID of the export query.

Return type

String

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getExportStatus

ExportStatusResponse getExportStatus(exportId)

Check Export Status

Check status of the export query.

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.ExportApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

ExportApi apiInstance = new ExportApi();
String exportId = "exportId_example"; // String | Export ID of the export query.
try {
    ExportStatusResponse result = apiInstance.getExportStatus(exportId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExportApi#getExportStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
exportId String Export ID of the export query.

Return type

ExportStatusResponse

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json