Get the Status of the Bulk Insert job

Table of Contents

Overview

This API fetches the status and progress details of a specific bulk insert job specified by the job_id in the request URL.

Request Details

Request URL

https://<base_url>/creator/v2.1/bulk/<account_owner_name>/<app_link_name>/form/<form_link_name>/insert/<job_id>

Request method

GET

Header

KeyValueDescription
Authorization

Zoho-oauthtoken10

00.8cb99dxxxxx

xxxxxxxx9be93.9b

8xxxxxxxxxxxxxxxf

An authentication token (oauthtoken) allows users to access apps and APIs without entering their login credentials each time.
environmentdevelopment/stageSpecifies the environment.

Scope

scope=ZohoCreator.bulk.READ

where,

base_urlthe base URL of your Creator account
For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC.
account_owner_namethe username of the Creator account's owner
app_link_namethe link name of the target application
form_link_namethe link name of the target form
job_idunique identifier of the bulk insert job

Response Structure

detailsJSON 

  • object - Contains the details of the bulk job.
  • code (integer) - Indicates the success or failure of the API request.
  • api_status (string) - Specifies the current status of the bulk job. Possible values include "Ready-to-upload", "In-progress", "Aborted", "Completed", or "Failed".
Note: To know more about the Bulk API limits, refer this page.

Sample Request

CurlDelugeJavaJavaScriptPython
Copiedcurl "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert/3888833000000114027" \
  -X GET \
  -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeUrl [
  url: "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert/3888833000000114027",
  type: GET,
  connection: "creatorconnection"
];
CopiedHttpUrl.Builder urlBuilder = HttpUrl.parse(
  "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert/3888833000000114027"
).newBuilder();

Request request = new Request.Builder()
  .url(urlBuilder.toString())
  .method("GET", null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
  .build();

Response response = client.newCall(request).execute();
Copiedlet api_headers = {
  "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
};

fetch("https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert/3888833000000114027", {
  method: "GET",
  headers: api_headers
});
Copiedapi_headers = {
  "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

response = requests.get(
  "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert/3888833000000114027",
  headers=api_headers
)

Sample Response

Copied{
    "code": 3000,
    "data": {
        "api_status": "IN_PROGRESS",
        "record_details": {
            "total_records": 1,
            "failed_records": 0,
            "unprocessed_records": 0,
            "success_records": 1
        }
    }
}