Salesforce

Java API endpoint: getServerTypeEngineRunningDetail

« Go Back
Information
Java API endpoint: getServerTypeEngineRunningDetail
000008318
Public
Product Selection
aiWare - API
Article Details

GetServerTypeRunningEngineDetailResponse getServerTypeEngineRunningDetail(serverTypeID, engineID, xCorrelationId)

This gets the detail of server type - running engine.

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);
    UUID serverTypeID = new UUID(); // UUID | ID of Server Type
    UUID engineID = new UUID(); // UUID | ID of Engine
    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
    try {
      GetServerTypeRunningEngineDetailResponse result = apiInstance.getServerTypeEngineRunningDetail(serverTypeID, engineID, xCorrelationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminApi#getServerTypeEngineRunningDetail");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
serverTypeIDUUIDID of Server Type
engineIDUUIDID of Engine
xCorrelationIdStringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional]

Return type

GetServerTypeRunningEngineDetailResponse

Authorization

api_key

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Successful operation* X-Aiware-Version -
* X-Correlation-Id -
400Invalid argument. Please see the error response for more information.* X-Aiware-Version -
* X-Correlation-Id -
401Not authorized* X-Aiware-Version -
* X-Correlation-Id -
403Forbidden* X-Aiware-Version -
* X-Correlation-Id -
404Not Found* X-Aiware-Version -
* X-Correlation-Id -
405The request is not allowed.* X-Aiware-Version -
* X-Correlation-Id -
429Too Many Requests* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -
501Not Implemented* X-Aiware-Version -
* X-Correlation-Id -
503System Unavailable* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -

Additional Technical Documentation Information
Properties
5/20/2025 10:10 PM
5/20/2025 10:10 PM
5/20/2025 10:10 PM
Documentation
Documentation
000008318
Translation Information
English

Powered by