Discussions
Eloqua Product Notice: Bulk API – Definition validation on sync creation and new sync log for tempor
Overview
With the arrival of Eloqua release 20D (Nov 2020), when creating a Bulk API sync the definition will be validated and there will be a new Bulk API sync log message when a sync fails because of a temporary error.
What’s changing?
Definition Validation on Sync Creation
With 20D, the definition will be validated on sync creation, and if the definition is not valid, a validation error will be returned.
Example:
First, we will create a definition using a service instance id that currently exists:
Request:
POST /api/Bulk/2.0/contacts/exports
{
"name": "Action_f3689bdfbf2e48deb318019367b4f2a8_pending",
"fields": {
"emailAddress": "{{Contact.Field(C_EmailAddress)}}"
},
"filter": "STATUS('{{ActionInstance(f3689bdfbf2e48deb318019367b4f2a8)}}') = 'pending'"
}
Response:
{
"name": "Action_f3689bdfbf2e48deb318019367b4f2a8_pending",
"fields": {
"emailAddress": "{{Contact.Field(C_EmailAddress)}}"
},
"filter": "STATUS('{{ActionInstance(f3689bdfbf2e48deb318019367b4f2a8)}}') = 'pending'",
"dataRetentionDuration": "PT12H",
"uri": "/contacts/exports/1481",
"createdBy": "API.Test",
"createdAt": "2020-09-15T22:58:23.8705513Z",
"updatedBy": " API.Test",
"updatedAt": "2020-09-15T22:58:23.8705513Z"
}
Now we delete the service instance id f3689bdfbf2e48deb318019367b4f2a8 in Eloqua, and attempt to sync the definition previously created.
With 20D, we will now see a validation error, instead of the sync being created and ending in error:
Request:
POST /api/Bulk/2.0/syncs
{
"syncedInstanceUri": "/contacts/exports/1481"
}
Response: 400 There was a validation error.
{
"failures": [
{
"field": "filter",
"value": "STATUS('{{ActionInstance(f3689bdfbf2e48deb318019367b4f2a8)}}') = 'pending'",
"constraint": "Must reference service instance within a workflow"
}
]
}
New Sync Log Message
With 20D, there will a new sync log message when a Bulk API sync fails because of a temporary error.
Example:
{
"syncUri": "/syncs/2651",
"count": 0,
"severity": "information",
"statusCode": "ELQ-00146",
"message": " Unable to process sync due to a temporary error.",
"createdAt": "2020-09-01T22:45:55.1570000Z"
}
Timeline
With the arrival of Eloqua release 20D (Nov 2020), when creating a Bulk API sync the definition will be validated and there will be a new Bulk API sync log message when a sync fails because of a temporary error. Check the Eloqua Release Center for specific dates and times.
Next Steps
Definition Validation on Sync Creation
Prepare for the definition to be validated upon sync creation.
New Sync Log Message
Prepare for the new sync log message that will indicate when a sync fails because of a temporary error. When receiving this error message, the Bulk API sync should be retried.
Additional Resources
View changes for Eloqua's APIs including, new features, significant recent changes, and platform notices, on the Eloqua Developer Changelog.
If you have questions, post a discussion on Code It!
Group Product Manager, CX - Marketing: Eloqua