Bulk jobs are a fast and efficient way to enter data at initial setup and to incorporate large-scale changes, such as changing agent skill groups between shifts and hiring multiple new agents.
You can use the Bulk Job API to list the bulk jobs currently defined in the database, define new bulk jobs, and view or delete records of existing bulk jobs.
URL
https://<server>/unifiedconfig/config/bulkjob
Operations
- create: Creates one bulk job.
- delete: Permanently deletes one bulk job.
- get: Returns one bulk job using the URL https://<server>/unifiedconfig/config/bulkjob/<id>.
- list: Retrieves a list of bulk jobs.
Parameters
- refURL: The refURL of the bulk job. See Shared parameters.
- description: See Shared parameters.
- fileContent: The content of the bulk CSV file. The size of the file must not exceed 3MB. For information about the CSV file data, see the "Manage Bulk Jobs"
section of the Packaged CCE Administration Guide.
- createDateTime: The time the bulk job was submitted. It indicates the time in milliseconds elapsed from the zero epoch value of January 1, 1970, 00:00:00 GMT. Read-only.
- jobHostName: The Windows computer name of the data server that initiated the bulk job. Read-only.
- startDateTime: The time the bulk job began executing. Read-only.
- endDateTime: The time the bulk job completed or failed. Read-only.
- jobState: The current state of the job. Read-only.
- 1: Queued
- 2: Processing
- 3: Succeeded
- 4: Failed
- 5: Cancelled
- 6: Partially succeeded
- jobType: The job type. Read-only.
- 1: Dialed Number
- 2: Agent
- 3: Call Type
- 4: Skill Group
- logFile: A URL to download the log file for the bulk job. Read-only.
- csvFile: A URL to download the CSV file that was originally uploaded in the fileContent parameter. Read-only.
Search and sort values
The following table shows the parameters that are searched and the
parameters that are sortable.
Search parameters |
Sort parameters |
|
- description
- jobType
- jobState
- jobHostName
- createDateTime
- startDateTime
- endDateTime
|
See Search and Sort.
Example get response
Example response for a dialed number create job that completed successfully:
<bulkJob>
<changeStamp>0</changeStamp>
<refURL>http://<server>/unifiedconfig/config/bulkjob/(id)</refURL>
<jobHostName>DS1</jobHostName>
<createDateTime>1330441858360</createDateTime>
<startDateTime>1330441858361</createDateTime>
<endDateTime>1330441858368</endDateTime>
<jobState>3</jobState>
<jobType>1</jobType>
<description>dn create bulk job</description>
<logFile><refURL>http://<server>/unifiedconfig/config/bulkjob/(id)/log</refURL></logFile>
<csvFile><refURL>http://<server>/unifiedconfig/config/bulkjob/(id)/csv</refURL></csvFile>
</bulkJob>