This object represents a CSV import task, if the task was created but not started by an import operation, it can be started by modifying it and assigning the value ‘START’ to the ‘action’ field.
References to csvimporttask are object references. The name part of a csvimporttask object reference has the following components:
- The import id.
Example: csvimporttask/ZG5zLm5ldHdvcmtfdmlldyQxMTk:1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): admin_name, end_time, file_name, file_size, import_id, lines_failed, lines_processed, lines_warning, on_error, operation, separator, start_time, status, update_method.
The action to execute.
Type
String.
Create
The default value is START.
Search
The field is not available for search.
Notes
action is not readable.
The login name of the administrator.
Type
String.
Search
The field is not available for search.
Notes
The admin_name is part of the base object.
The admin_name cannot be updated.
admin_name cannot be written.
The end time of this import operation.
Type
Timestamp.
Search
The field is not available for search.
Notes
The end_time is part of the base object.
The end_time cannot be updated.
end_time cannot be written.
The name of the file used for the import operation.
Type
String.
Search
The field is not available for search.
Notes
The file_name is part of the base object.
The file_name cannot be updated.
file_name cannot be written.
The size of the file used for the import operation.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The file_size is part of the base object.
The file_size cannot be updated.
file_size cannot be written.
The ID of the current import task.
Type
Unsigned integer.
Search
The field is available for search via
Notes
The import_id is part of the base object.
The import_id cannot be updated.
import_id cannot be written.
The number of lines that encountered an error.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The lines_failed is part of the base object.
The lines_failed cannot be updated.
lines_failed cannot be written.
The number of lines that have been processed.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The lines_processed is part of the base object.
The lines_processed cannot be updated.
lines_processed cannot be written.
The number of lines that encountered a warning.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The lines_warning is part of the base object.
The lines_warning cannot be updated.
lines_warning cannot be written.
The action to take when an error is encountered.
Type
String.
Create
The default value is STOP.
Search
The field is not available for search.
Notes
The on_error is part of the base object.
The operation to execute.
Type
String.
Create
The default value is INSERT.
Search
The field is not available for search.
Notes
The operation is part of the base object.
The separator to be used for the data in the CSV file.
Type
String.
Search
The field is not available for search.
Notes
The separator is part of the base object.
The separator cannot be updated.
separator cannot be written.
The start time of the import operation.
Type
Timestamp.
Search
The field is not available for search.
Notes
The start_time is part of the base object.
The start_time cannot be updated.
start_time cannot be written.
The status of the import operation
Type
String.
Search
The field is not available for search.
Notes
The status is part of the base object.
The status cannot be updated.
status cannot be written.
This function stops the current CSV import task.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| action | String | N | N | N | N/A |
| admin_name | String | N | Y | Y | N/A |
| end_time | Timestamp | N | Y | Y | N/A |
| file_name | String | N | Y | Y | N/A |
| file_size | Unsigned int | N | Y | Y | N/A |
| import_id | Unsigned int | N | Y | Y | = |
| lines_failed | Unsigned int | N | Y | Y | N/A |
| lines_processed | Unsigned int | N | Y | Y | N/A |
| lines_warning | Unsigned int | N | Y | Y | N/A |
| on_error | String | N | N | Y | N/A |
| operation | String | N | N | Y | N/A |
| separator | String | N | Y | Y | N/A |
| start_time | Timestamp | N | Y | Y | N/A |
| status | String | N | Y | Y | N/A |
| update_method | String | N | N | Y | N/A |
ciscoise:endpoint : Cisco ISE Endpoint object.
