Product Notice: Eloqua Application API Retrieve batch form submission details endpoints changes

JodyMooney-Oracle

Overview

With the arrival of Eloqua release 21B (May 2021), we are changing the default depth for the Application API Retrieve batch form submission details endpoints to minimal. Currently, the default depth is complete.

 

What’s changing?

With 21B, we are changing the default depth to minimal for the following endpoints:

2.0

• Retrieve batch form submission details by batchCorrelationId: GET /api/REST/2.0/data/form/{formId}/batchCorrelation/formData/{batchCorrelationId}
• Retrieve batch form submission details by batchId: GET /api/REST/2.0/data/form/{formId}/batch/formData/{batchId}

 

Examples:

Before 21B, the default depth when retrieving batch form submission details is complete:

Request:

GET /api/REST/2.0/data/form/5361/batchCorrelation/formData/27894480-fdd8-4c0d-960a-d0dae172e625

OR

GET /api/REST/2.0/data/form/5361/batch/formData/2324

Response: 200 OK

 

{

   "type": "AsyncFormSubmissionBatch",

   "id": "2324",

   "batchCorrelationId": "27894480-fdd8-4c0d-960a-d0dae172e625",

   "callbackUrl": "https://example.com",

   "currentBatchStatus": "Success",

   "depth": "complete",

   "elements": [

       {

           "type": "FormData",

           "currentStatus": "Success",

           "id": "221893",

           "fieldValues": [

               {

                   "type": "FieldValue",

                   "id": "31564",

                   "value": "John"

               },

               {

                   "type": "FieldValue",

                   "id": "31565",

                   "value": "Smith"

               },

               {

                   "type": "FieldValue",

                   "id": "31566",

                   "value": "[email protected]"

               }

           ],

           "submittedAt": "1614101183",

           "correlationId": "9ae01d54-d721-410c-942c-443ca6a799e3",

           "processedAt": "1614101186",

           "rowId": 365213

       },

       {

           "type": "FormData",

           "currentStatus": "Success",

           "id": "221894",

           "fieldValues": [

               {

                   "type": "FieldValue",

                   "id": "31564",

                   "value": "John"

               },

               {

                   "type": "FieldValue",

                   "id": "31565",

                   "value": "Test"

               },

               {

                   "type": "FieldValue",

                   "id": "31566",

                   "value": "[email protected]"

               }

           ],

           "submittedAt": "1614101183",

           "correlationId": "a40d7ae5-4c13-42f2-98c7-7a567354e653",

           "processedAt": "1614101186",

           "rowId": 365214

       }

   ],

   "processingStatus": "Success"

}

 

After 21B, the default depth when retrieving batch form submission details will be minimal:

 

Request:

GET /api/REST/2.0/data/form/5361/batchCorrelation/formData/27894480-fdd8-4c0d-960a-d0dae172e625

OR

GET /api/REST/2.0/data/form/5361/batch/formData/2324

 

Response: 200 OK

 

{

   "type": "AsyncFormSubmissionBatch",

   "id": "2324",

   "batchCorrelationId": "27894480-fdd8-4c0d-960a-d0dae172e625",

   "callbackUrl": " https://example.com",

   "currentBatchStatus": "Success",

   "depth": "minimal",

   "processingStatus": "Success"

}

 

Timeline

With the arrival of Eloqua release 21B (May 2021), we are changing the default depth for the Application API Retrieve batch form submission details endpoints to minimal. Check the Eloqua Release Center for specific dates and times.

 

Next Steps

If you are using either of the Retrieve batch form submission details endpoints, be prepared for the default depth to change from complete to minimal.

If requiring complete depth add the depth query parameter set to complete to the request:

GET /api/REST/2.0/data/form/5361/batchCorrelation/formData/27894480-fdd8-4c0d-960a-d0dae172e625?depth=complete

GET /api/REST/2.0/data/form/5361/batch/formData/2324?depth=complete

 

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 Developer Tools!

 

FAQ

Q: What endpoints are impacted by this change?

A: The following endpoints are impacted:

·     2.0

• Retrieve batch form submission details by batchCorrelationId: GET /api/REST/2.0/data/form/{formId}/batchCorrelation/formData/{batchCorrelationId}

-- New default depth is minimal

• Retrieve batch form submission details by batchId: GET /api/REST/2.0/data/form/{formId}/batch/formData/{batchId}

-- New default depth is minimal

 

Q: Why is the default depth being changed?

A: In the scenario that the Retrieve batch form submission details endpoint is being used to poll for status the depth should be minimal, so the default is being set to match this use case and require complete depth to be specified when needed. Note, it is always recommended to use the callbackUrl to be notified of status, but if polling is needed the new default depth of minimal should always be used, along with an exponential backoff retry.