Get Bulk Write Job Details

Purpose

To get the details of a bulk write job performed previously.

Request URL

https://recruit.zoho.com/recruit/bulk/v2/write/{job_id}

job_id - The unique ID of the bulk write job.

Request Method

GET

Scope

scope=ZohoRecruit.bulk.CREATE
(or)
scope=ZohoRecruit.bulk.ALL

Response Structure

Attribute

Data Type

Description

status

String

Specifies the current status of the bulk write job. Example: "status": "ADDED" or "IN PROGRESS" or "COMPLETED".

character_encoding

String

Specifies the character encoding for the bulk write job. System detects the character encoding automatically. However, if you specify, it will take precedence.

resource Show properties

JSON Object

Contains the details about the module selected, the field mappings, and the ID of the file used for this job.

resource Properties

Attributes

Data Type

Description

status

String

Specifies the status of the bulk write job for that module. Example: "status": "ADDED", "IN PROGRESS", "COMPLETED", "SKIPPED", or "FAILED".

type

String

Specifies the type of module that you want to import. The value is data.

module

String

Specifies the API name of the module that is imported

field_mappings Show properties

JSON Object

Refer the field_mappings properties table for information on field_mappings JSON object.

field_mappings Properties

Attributes	Data Type	Description
api_name	String	Specifies the field API name of the field you want to import from the module
index	Integer	The column index of the field you have mapped to the Zoho Recruit module. When you specify a non-existing index value, the system throws an error.
find_by	String	Specifies the API name of the unique field or primary field(record ID) in the module. System uses this field API name to find the existing records in Zoho Recruit.
default_value	JSON Object	The default value with which the system replaces any partial or empty file column in the CSV file.

file Show properties

JSON Object

Refer the file properties table for information on file JSON object.

file Properties

Attributes	Data Type	Description
status	String	Specifies the status of the bulk write job for that file. Example: "status": "ADDED", "IN PROGRESS", "COMPLETED", "SKIPPED, or "FAILED".
name	String	Specifies the name of the CSV file which will get downloaded.
added_count	Integer	Specifies the number of records added or imported.
skipped_count	Integer	Specifies the number of records skipped due to some issues. The Error column in the CSV file will have details about why the record was skipped during import.
updated_count	Integer	Specifies the number of records updated during bulk update
total_count	Integer	Specifies the total number of records inserted, updated, or skipped during bulk import.

Integer

Specifies the unique identifier of the bulk write job.

result

JSON Object

download_url: Represents the download URL from which you can download the result(CSV file) of the bulk write job.

created_by

JSON Object

Specifies the ID and Name of the user who initiated the bulk read job. Sample - "created_by": { "id": "1000000031045", "name": "Patricia Boyle" },

operation

String

Specifies the type of bulk write operation performed. Sample: "operation": "insert".

created_time

ISO8601

Specifies the time period of when the bulk write job was initialized.

Note:

To know more about the Bulk Write API limits, go here.

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/bulk/v2/write/"111111000002308098"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response for Job Added

Copied{
  "status": "ADDED",
  "resource": [
    {
      "status": "INPROGRESS",
      "type": "data",
      "module": "Job Openings",
      "field_mappings": [
        {
          "api_name": "Job_Opening_Name",
          "index": 1,
          "format": null,
          "find_by": null,
          "default_value": null
        },
        {
          "api_name": "Stage",
          "index": 132,
          "format": null,
          "find_by": null,
          "default_value": null
        }
      ],
      "file": {
        "status": "INPROGRESS"
      }
    }
  ],
  "id": "111111000002308098",
  "created_by": {
    "id": "111111000000035795",
    "name": "Patricia Boyle"
  },
  "operation": "insert",
  "created_time": "2019-01-30T02:21:32-12:00"
}

Sample Response for Job In Progress

Copied{
  "status": "INPROGRESS",
  "character_encoding": "UTF-8",
  "resource": [
    {
      "status": "INPROGRESS",
      "type": "data",
      "module": "Job Openings",
      "field_mappings": [
        {
          "api_name": "Job_Openings_Name",
          "index": 1,
          "format": null,
          "find_by": null,
          "default_value": null
        },
        {
          "api_name": "Stage",
          "index": 2,
          "format": null,
          "find_by": null,
          "default_value": null
        }
      ],
      "file": {
        "status": "INPROGRESS",
        "name": "Interviews.csv",
        "added_count": 0,
        "skipped_count": 100,
        "updated_count": 0,
        "total_count": 100
      }
    }
  ],
  "id": "111111000002308051",
  "created_by": {
    "id": "111111000000035795",
    "name": "Patricia Boyle"
  },
  "operation": "insert",
  "created_time": "2019-01-30T02:18:15-12:00"
}

Sample Response for Job Completed

Copied{
  "status": "COMPLETED",
  "character_encoding": "UTF-8",
  "resource": [
    {
      "status": "COMPLETED",
      "type": "data",
      "module": "Job Openings",
      "field_mappings": [
        {
          "api_name": "Job_Opening_Name",
          "index": 1,
          "format": null,
          "find_by": null,
          "default_value": null
        },
        {
          "api_name": "Stage",
          "index": 2,
          "format": null,
          "find_by": null,
          "default_value": null
        }
      ],
      "file": {
        "status": "COMPLETED",
        "name": "Interviews.csv",
        "added_count": 0,
        "skipped_count": 100,
        "updated_count": 0,
        "total_count": 100
      }
    }
  ],
  "id": "111111000002308051",
  "result": {
    "download_url": "/v2/recruit/org6196138/bulk-write/111111000002308051/111111000002308051.zip"
  },
  "created_by": {
    "id": "111111000000035795",
    "name": "Patricia Boyle"
  },
  "operation": "insert",
  "created_time": "2019-01-30T02:18:15-12:00"
}

Sample Response for Job Failed

Copied{
  "status": "FAILED",
  "resource": [
    {
      "status": "FAILED",
      "message": "File index not found. Stage - 132",
      "type": "data",
      "module": "Job Openings",
      "field_mappings": [
        {
          "api_name": "Job_Opening_Name",
          "index": 1,
          "format": null,
          "find_by": null,
          "default_value": null
        },
        {
          "api_name": "Stage",
          "index": 132,
          "format": null,
          "find_by": null,
          "default_value": null
        }
      ],
      "file": {
        "status": "FAILED"
      }
    }
  ],
  "id": "111111000002308098",
  "created_by": {
    "id": "111111000000035795",
    "name": "Patricia Boyle"
  },
  "operation": "insert",
  "created_time": "2019-01-30T02:21:32-12:00"
}