Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Mass Updater > Get Mass Action Result

Get Mass Action Result

This reference describes how to get information about the result of a mass action through the REST API. See Mass Updater for more information about mass actions.

Request

  • Production: GET https://api.zuora.com/rest/v1/bulk/{bulk-key}
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/bulk/{bulk-key}

Request Header

The Accept request header is optional. Only JSON is returned.

Request Parameters

bulk-key

required

path

String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.

Response

Response Body

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

actionType

Type of mass action.

inputSize

Size of the input file in bytes.

uploadedBy

Email of the person who uploaded the mass action file.

uploadedOn

Date and time that the mass action file was uploaded. The format is yyyy-MM-dd hh:mm:ss.

status

Status of the mass action. The following table describes the mass action statuses.

Status Description

Pending

Mass action has not yet started being processed.

Processing

Mass action is in progress.

Stopping

Mass action is in the process of stopping, but has not yet stopped.

Stopped

Mass action has stopped.

Completed

Mass action was successfully completed. There may still be failed records.

Failed

Mass action failed. No records are processed. No response file is created.

startedOn

Date and time that Zuora started processing the mass action. The format is yyyy-MM-dd hh:mm:ss.

endedOn

Date and time that the mass action was completed. The format is yyyy-MM-dd hh:mm:ss.

outputSize

Size of the response file in bytes.

outputURL

URL to download the response file. The response file is a zipped .csv file. 

The response file is identical to the file you uploaded to perform the mass action, with additional columns providing information about the outcome of each record. See the Supported Mass Actions articles for more information about the response file for each type of mass action.

This field only returns a value when the mass action status is Completed or Stopped. Otherwise, this field is null.

outputType

Type of output for the response file. The following table describes the output type.

Output Type Description

(url:.csv.zip)

URL pointing to a zipped .csv file.

totalCount

Total number of records in the uploaded mass action file.

When the mass action status is Pending, this field is null.

processedCount

Total number of processed records. This field is equal to the sum of errorCount and successCount.

This field is updated in real time. When the mass action status is Processing, this field returns the number of records that have been processed so far. When the mass action status is Pending, this field is null.

errorCount

Total number of failed records.

This field is updated in real time. When the mass action status is Processing, this field returns the number of records that have failed so far. When the mass action status is Pending, this field is null.

successCount

Total number of successful records.

This field is updated in real time. When the mass action status is Processing, this field returns the number of records that have succeeded so far. When the mass action status is Pending, this field is null.

Example

HTTP Request

GET https://api.zuora.com/rest/v1/bulk/402892f04c97b89a014c97bb30a50003

JSON Response

{
    "actionType": "UpdateAccountingCode",
    "inputSize": 354,
    "uploadedBy": "john.doe@acme.com",
    "uploadedOn": "2015-04-07 14:22:09",
    "status": "Completed",
    "startedOn": "2015-04-07 14:22:11",
    "endedOn": "2015-04-07 14:32:01",
    "outputSize": 350,
    "outputURL": "https://api.zuora.com/apps/api/file/402892c84c9285b1014c9293f5320007",
    "outputType": "(url:.csv.zip)",
    "totalCount": 3,
    "processedCount": 3,
    "errorCount": 1,
    "successCount": 2,
    "success": true
}
Last modified

Tags

This page has no custom tags.

Classifications

(not set)