Common Object Import Tasks

Describe a CommonObjectImportTask

get/commonobjectimporttasks/{commonObjectImportTaskID}

Describe a common object import task by ID.

Related SDK Methods:
Java

CommonObjectImportTasksApi.describeCommonObjectImportTask([param1, param2, ...])

Python

CommonObjectImportTasksApi.describe_common_object_import_task([param1, param2, ...])

JavaScript

CommonObjectImportTasksApi.describeCommonObjectImportTask([param1, param2, ...])

Security
Request
path Parameters
commonObjectImportTaskID
required
integer <int32> \d+

The ID number of the common object import task to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

404

The common object import task does not exist.

Request samples
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();
		}
	}
}

Response samples
application/json
{
  • "commonObjectContent": "string",
  • "type": "directory-lists",
  • "status": "requested",
  • "created": 0,
  • "lastUpdated": 0,
  • "commonObjectMappings": [
    ],
  • "errorCode": 0,
  • "ID": 0,
  • "taskGUID": "string"
}

List CommonObjectImportTasks

get/commonobjectimporttasks

List all common object import tasks.

Related SDK Methods:
Java

CommonObjectImportTasksApi.listCommonObjectImportTasks([param1, param2, ...])

Python

CommonObjectImportTasksApi.list_common_object_import_tasks([param1, param2, ...])

JavaScript

CommonObjectImportTasksApi.listCommonObjectImportTasks([param1, param2, ...])

Security
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

Request samples
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();
		}
	}
}

Response samples
application/json
{
  • "commonObjectImportTasks": [
    ]
}

Create a CommonObjectImportTask

post/commonobjectimporttasks

Create a task to import common objects.

Related SDK Methods:
Java

CommonObjectImportTasksApi.createCommonObjectImportTask([param1, param2, ...])

Python

CommonObjectImportTasksApi.create_common_object_import_task([param1, param2, ...])

JavaScript

CommonObjectImportTasksApi.createCommonObjectImportTask([param1, param2, ...])

Security
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

Common object import task to create.

commonObjectContent
required
string

Common object content zipped and base64-encoded, write only.

type
required
string

Type of the common objects to import. Searchable as Choice.

Enum: "directory-lists" "file-extension-lists" "file-lists" "ip-lists" "mac-lists" "port-lists" "contexts" "stateful-configurations" "schedules"
Responses
200

successful operation

400

The common object import task is invalid.

403

Not authorized to import common objects.

409

A common object import task is still in progress for this type.

413

The given common object content is too large.

Request samples
application/json
{
  • "commonObjectContent": "string",
  • "type": "directory-lists"
}
Response samples
application/json
{
  • "commonObjectContent": "string",
  • "type": "directory-lists",
  • "status": "requested",
  • "created": 0,
  • "lastUpdated": 0,
  • "commonObjectMappings": [
    ],
  • "errorCode": 0,
  • "ID": 0,
  • "taskGUID": "string"
}

Search CommonObjectImportTasks

post/commonobjectimporttasks/search

Search for CommonObjectImportTasks using optional filters.

Related SDK Methods:
Java

CommonObjectImportTasksApi.searchCommonObjectImportTasks([param1, param2, ...])

Python

CommonObjectImportTasksApi.search_common_object_import_tasks([param1, param2, ...])

JavaScript

CommonObjectImportTasksApi.searchCommonObjectImportTasks([param1, param2, ...])

Security
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "commonObjectImportTasks": [
    ]
}