CreateJobForEngineResponse createJobForEngine(engineID, xCorrelationId, contentType, fileName, inputFileName, parameterJSON, templateName)
This API create a job for the 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.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 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
String contentType = "contentType_example"; // String | mimetype of the input file
File fileName = new File("/path/to/file"); // File | the input file contents
String inputFileName = "inputFileName_example"; // String | the original filename of the input file
String parameterJSON = "parameterJSON_example"; // String | JSON stringified of map of field names and values if specified in job template
String templateName = "templateName_example"; // String | the engine job template to process the input file
try {
CreateJobForEngineResponse result = apiInstance.createJobForEngine(engineID, xCorrelationId, contentType, fileName, inputFileName, parameterJSON, templateName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling EngineApi#createJobForEngine");
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 |
|---|
| engineID | String | EngineID of node-red container request | |
| 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] |
| contentType | String | mimetype of the input file | [optional] |
| fileName | File | the input file contents | [optional] |
| inputFileName | String | the original filename of the input file | [optional] |
| parameterJSON | String | JSON stringified of map of field names and values if specified in job template | [optional] |
| templateName | String | the engine job template to process the input file | [optional] |
Return type
CreateJobForEngineResponse
Authorization
api_key
- Content-Type: multipart/form-data
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|
| 204 | Returns job ID | * 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 - |