csvimporttask : CSV Import task object.

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.

Object Reference

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

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Permissions
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

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): action, 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.

action

action

The action to execute.

Type

String.

Valid values are:
  • SAVE
  • START

Create

The default value is START.

Search

The field is not available for search.

Notes

The action is part of the base object.

action is not readable.

admin_name

admin_name

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.

end_time

end_time

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.

file_name

file_name

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.

file_size

file_size

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.

import_id

import_id

The ID of the current import task.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The import_id is part of the base object.

The import_id cannot be updated.

import_id cannot be written.

lines_failed

lines_failed

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.

lines_processed

lines_processed

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.

lines_warning

lines_warning

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.

on_error

on_error

The action to take when an error is encountered.

Type

String.

Valid values are:
  • CONTINUE
  • STOP

Create

The default value is STOP.

Search

The field is not available for search.

Notes

The on_error is part of the base object.

operation

operation

The operation to execute.

Type

String.

Valid values are:
  • CUSTOM
  • DELETE
  • INSERT
  • REPLACE
  • UPDATE

Create

The default value is INSERT.

Search

The field is not available for search.

Notes

The operation is part of the base object.

separator

separator

The separator to be used for the data in the CSV file.

Type

String.

Valid values are:
  • COMMA
  • SEMICOLON
  • SPACE
  • TAB

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.

start_time

start_time

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.

status

status

The status of the import operation

Type

String.

Valid values are:
  • COMPLETED
  • FAILED
  • PENDING
  • RUNNING
  • STOPPED
  • TEST_COMPLETED
  • TEST_FAILED
  • TEST_RUNNING
  • TEST_STOPPED
  • UPLOADED

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.

update_method

update_method

The update method to be used for the operation.

Type

String.

Valid values are:
  • MERGE
  • OVERRIDE

Create

The default value is OVERRIDE.

Search

The field is not available for search.

Notes

The update_method is part of the base object.

Function Calls

stop

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

Fields List

Field Type Req R/O Base Search
action String N N Y 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