GetApplicationsResponse getApplications(xCorrelationId, applicationStatusQueryOptional, applicationTypeQueryOptional, offset, limit, internalApplicationID, applicationID, orderBy)
Get the list of applications deployed and available on aiWARE.
Example
// Import classes:
import com.veritone.aiware.ApiClient;
import com.veritone.aiware.ApiException;
import com.veritone.aiware.Configuration;
import com.veritone.aiware.auth.*;
import com.veritone.aiware.models.*;
import com.veritone.aiware.edge.AdminApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.aiware.com/edge/v1");
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi(defaultClient);
String xCorrelationId = "xCorrelationId_example"; // String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request
ApplicationStatusEnum applicationStatusQueryOptional = new ApplicationStatusEnum(); // ApplicationStatusEnum | status
ApplicationTypeEnum applicationTypeQueryOptional = new ApplicationTypeEnum(); // ApplicationTypeEnum | type
Long offset = 56L; // Long | the number of data to skip before getting the result set
Long limit = 10lL; // Long | the number of items to return.
UUID internalApplicationID = new UUID(); // UUID | Internal ID of Application
UUID applicationID = new UUID(); // UUID | ID of Application
String orderBy = "orderBy_example"; // String | The value should be in [applicationName, createdTime]
try {
GetApplicationsResponse result = apiInstance.getApplications(xCorrelationId, applicationStatusQueryOptional, applicationTypeQueryOptional, offset, limit, internalApplicationID, applicationID, orderBy);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#getApplications");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|
| xCorrelationId | String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | [optional] |
| applicationStatusQueryOptional | ApplicationStatusEnum | status | [optional] [enum: active, approved, deleted, disabled, draft, pending, rejected] |
| applicationTypeQueryOptional | ApplicationTypeEnum | type | [optional] [enum: queue_service, http_service] |
| offset | Long | the number of data to skip before getting the result set | [optional] |
| limit | Long | the number of items to return. | [optional] [default to 10l] |
| internalApplicationID | UUID | Internal ID of Application | [optional] |
| applicationID | UUID | ID of Application | [optional] |
| orderBy | String | The value should be in [applicationName, createdTime] | [optional] |
Return type
GetApplicationsResponse
Authorization
api_key
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|
| 200 | List of applications | * X-Aiware-Version - * X-Correlation-Id - |
| 400 | Invalid argument. Please see the error response for more information. | * X-Aiware-Version - * X-Correlation-Id - |
| 401 | Not authorized | * X-Aiware-Version - * X-Correlation-Id - |
| 403 | Forbidden | * X-Aiware-Version - * X-Correlation-Id - |
| 404 | Not Found | * X-Aiware-Version - * X-Correlation-Id - |
| 405 | The request is not allowed. | * X-Aiware-Version - * X-Correlation-Id - |
| 429 | Too Many Requests | * Retry-After - * X-Aiware-Version - * X-Correlation-Id - |
| 501 | Not Implemented | * X-Aiware-Version - * X-Correlation-Id - |
| 503 | System Unavailable | * Retry-After - * X-Aiware-Version - * X-Correlation-Id - |