List CommonObjectImportTasks
List all common object import tasks.
CommonObjectImportTasksApi.listCommonObjectImportTasks([param1, param2, ...])
CommonObjectImportTasksApi.list_common_object_import_tasks([param1, param2, ...])
CommonObjectImportTasksApi.listCommonObjectImportTasks([param1, param2, ...])
successful operation
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.CommonObjectImportTasksApi; import com.trendmicro.deepsecurity.model.CommonObjectImportTasks; public class ListCommonObjectImportTasksExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values CommonObjectImportTasksApi instance = new CommonObjectImportTasksApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours CommonObjectImportTasks result = instance.listCommonObjectImportTasks(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling CommonObjectImportTasksApi.listCommonObjectImportTasks"); e.printStackTrace(); } } }
- 200
{- "commonObjectImportTasks": [
- {
- "commonObjectContent": "string",
- "type": "directory-lists",
- "status": "requested",
- "created": 0,
- "lastUpdated": 0,
- "commonObjectMappings": [
- {
- "importTo": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}, - "importFrom": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}
}
], - "errorCode": 0,
- "ID": 0,
- "taskGUID": "string"
}
]
}
Create a CommonObjectImportTask
Create a task to import common objects.
CommonObjectImportTasksApi.createCommonObjectImportTask([param1, param2, ...])
CommonObjectImportTasksApi.create_common_object_import_task([param1, param2, ...])
CommonObjectImportTasksApi.createCommonObjectImportTask([param1, param2, ...])
header Parameters
Request Body schema: application/json
Common object import task to create.
successful operation
The common object import task is invalid.
Not authorized to import common objects.
A common object import task is still in progress for this type.
The given common object content is too large.
- Payload
- Java
- Python
- JavaScript
{- "commonObjectContent": "string",
- "type": "directory-lists"
}
- 200
{- "commonObjectContent": "string",
- "type": "directory-lists",
- "status": "requested",
- "created": 0,
- "lastUpdated": 0,
- "commonObjectMappings": [
- {
- "importTo": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}, - "importFrom": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}
}
], - "errorCode": 0,
- "ID": 0,
- "taskGUID": "string"
}
Describe a CommonObjectImportTask
Describe a common object import task by ID.
CommonObjectImportTasksApi.describeCommonObjectImportTask([param1, param2, ...])
CommonObjectImportTasksApi.describe_common_object_import_task([param1, param2, ...])
CommonObjectImportTasksApi.describeCommonObjectImportTask([param1, param2, ...])
successful operation
The common object import task does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.CommonObjectImportTasksApi; import com.trendmicro.deepsecurity.model.CommonObjectImportTask; public class DescribeCommonObjectImportTaskExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values CommonObjectImportTasksApi instance = new CommonObjectImportTasksApi(); Integer commonObjectImportTaskID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours CommonObjectImportTask result = instance.describeCommonObjectImportTask(commonObjectImportTaskID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling CommonObjectImportTasksApi.describeCommonObjectImportTask"); e.printStackTrace(); } } }
- 200
{- "commonObjectContent": "string",
- "type": "directory-lists",
- "status": "requested",
- "created": 0,
- "lastUpdated": 0,
- "commonObjectMappings": [
- {
- "importTo": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}, - "importFrom": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}
}
], - "errorCode": 0,
- "ID": 0,
- "taskGUID": "string"
}
Search CommonObjectImportTasks
Search for CommonObjectImportTasks using optional filters.
CommonObjectImportTasksApi.searchCommonObjectImportTasks([param1, param2, ...])
CommonObjectImportTasksApi.search_common_object_import_tasks([param1, param2, ...])
CommonObjectImportTasksApi.searchCommonObjectImportTasks([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
- Payload
- Java
- Python
- JavaScript
{- "maxItems": 0,
- "searchCriteria": [
- {
- "fieldName": "string",
- "booleanTest": true,
- "numericTest": "less-than",
- "numericValue": 0,
- "numericValueList": [
- 0
], - "stringTest": "equal",
- "stringValue": "string",
- "stringWildcards": true,
- "choiceTest": "equal",
- "choiceValue": "string",
- "firstDateValue": 0,
- "firstDateInclusive": true,
- "lastDateValue": 0,
- "lastDateInclusive": true,
- "nullTest": true,
- "versionTest": "less-than",
- "versionValue": "string",
- "idValue": 0,
- "idTest": "less-than",
- "idValueList": [
- 0
]
}
], - "sortByObjectID": true
}
- 200
{- "commonObjectImportTasks": [
- {
- "commonObjectContent": "string",
- "type": "directory-lists",
- "status": "requested",
- "created": 0,
- "lastUpdated": 0,
- "commonObjectMappings": [
- {
- "importTo": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}, - "importFrom": {
- "commonObjectID": 0,
- "commonObjectName": "string"
}
}
], - "errorCode": 0,
- "ID": 0,
- "taskGUID": "string"
}
]
}