Salesforce

Java API endpoint: upsertEngineTemplate

« Go Back
Information
Java API endpoint: upsertEngineTemplate
000008821
Public
Product Selection
aiWare - API
Article Details

EngineTemplate upsertEngineTemplate(engineID, engineTemplateName, engineTemplate, xCorrelationId)

Create or Update the template of the engine given its ID and template name.

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.EngineApi;

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");

    EngineApi apiInstance = new EngineApi(defaultClient);
    String engineID = "engineID_example"; // String | EngineID of node-red container request
    String engineTemplateName = "engineTemplateName_example"; // String | name of the engine template
    EngineTemplate engineTemplate = new EngineTemplate(); // EngineTemplate | Engine Template
    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 {
      EngineTemplate result = apiInstance.upsertEngineTemplate(engineID, engineTemplateName, engineTemplate, xCorrelationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineApi#upsertEngineTemplate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
engineIDStringEngineID of node-red container request
engineTemplateNameStringname of the engine template
engineTemplateEngineTemplateEngine Template
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

EngineTemplate

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • 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/23/2025 7:18 PM
5/23/2025 7:20 PM
5/23/2025 7:20 PM
Documentation
Documentation
000008821
Translation Information
English

Powered by