Retrieve import sync failure data
get
/api/bulk/2.0/syncs/{id}/rejects
Retrieves the rejected records for the specified import sync.
Request
Supported Media Types
- application/json
- text/csv
Path Parameters
-
id(required): integer
Id of the sync.
Query Parameters
-
limit: integer
A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example:
?limit=5. -
links: string
The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
-
offset: integer
Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example:
?offset=1000. -
orderBy: string
Specifies the name of the property to order the results by. The
orderByformat istermASC | DESC. Example:?orderBy=name ASC. -
q: string
A URL parameter that specifies query criteria used to filter results. The
qformat istermoperatorvalue. Use "*" for wildcard values. Example:?q="name=*Test*"will find all the entities where the "name" field contains the string "Test". -
totalResults: boolean
Whether or not the total results are shown, and factored into the
hasMoreproperty in the response. When set tofalse, thetotalResultsproperty will not be returned, and thehasMoreproperty will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default istrue.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : SyncRejectSearchResponse
Type:
objectTitle:
SyncRejectSearchResponseThe response body contains information about the rejected records for the import synchronization.
Show Source
-
count:
integer
Title:
countNumber of results returned in the request. -
hasMore:
boolean
Title:
hasMoreIndicates if there are more results. -
items:
array items
Title:
itemsList of rejected records, with detail on each rejected record, including message, statusCode, recordIndex, and invalidFields. -
limit:
integer
Title:
limitThe maximum number of records returned. Set with thelimitURL parameter, and defaults to 1000 if not specified. -
offset:
integer
Title:
offsetThe requested index from which records are returned. Set with theoffsetURL parameter, and defaults to 0 if not specified. -
totalResults:
integer(int64)
Title:
totalResultsNumber of total results. Returned when thetotalResultsURL parameter is not set tofalse.
Nested Schema : items
Type:
arrayTitle:
itemsList of rejected records, with detail on each rejected record, including message, statusCode, recordIndex, and invalidFields.
Show Source
-
Array of:
object SyncReject
Title:
SyncRejectThe detailed information about the import sychronization data.
Nested Schema : SyncReject
Type:
objectTitle:
SyncRejectThe detailed information about the import sychronization data.
Show Source
-
fieldValues:
object fieldValues
Title:
fieldValuesThe sync's field values. -
invalidFields:
array invalidFields
Title:
invalidFieldsThe sync's invalid fields. -
message:
string
Title:
messageThe sync's message. -
recordIndex:
integer
Title:
recordIndexThe sync's record index. -
statusCode:
string
Title:
statusCodeThe Eloqua status code.
Nested Schema : fieldValues
Type:
objectTitle:
fieldValuesThe sync's field values.
Nested Schema : invalidFields
Type:
arrayTitle:
invalidFieldsThe sync's invalid fields.
Show Source
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
409 Response
There was a conflict. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to retrieve the rejected records for a sync using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve the rejects for the sync with ID#24946:
GET /syncs/24946/rejects?limit=2
Response:
{
"items":[
{
"fieldValues":{
"C_Company":"Company",
"C_Date_1":"not a date",
"C_EmailAddress":"0@bulktest.com"
},
"message":"Invalid data.",
"statusCode":"ELQ-00040",
"recordIndex":1,
"invalidFields":[
"C_Date_1"
]
},
{
"fieldValues":{
"C_Company":"Company",
"C_Date_1":"not a date",
"C_EmailAddress":"1@bulktest.com"
},
"message":"Invalid data.",
"statusCode":"ELQ-00040",
"recordIndex":2,
"invalidFields":[
"C_Date_1"
]
}
],
"totalResults":2,
"limit":1000,
"offset":0,
"count":2,
"hasMore":false
}
cURL Example
Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/syncs/24946/rejects?limit=2