Eloqua Application API Create form data endpoint – New processingStepErrors property (Nov 2018 – Early Preview 18C)

Version 2

    Overview

     

    With the arrival of Eloqua release 18D (Nov 16 - 17, 2018), the processingStepErrors property, a list of processing step errors, will be returned when processing step errors occur when using the Create form data for a single form Application API endpoint. This feature can be enabled for Early Preview with Eloqua release 18C. To have this feature enabled, please log in to My Oracle Support and create a service request.

     

    What’s changing?

     

    Currently, when submitting form data via API there are no details provided related the processing step execution.

     

    With 18D, the processingStepErrors property will be added to the response if there are processing step errors when using the Create form data for a single form Application API endpoint – POST /api/REST/1.0/data/form/{id}.

     

    Notes:

    • The processingStepErrors property will only be returned if there are processing step errors. If no processing step errors occur, the processingStepErrors property will not be returned.
    • The processingStepErrors property will only be returned in the response to the Create form data for a single form Application API endpoint – POST /api/REST/1.0/data/form/{id}, and will not be returned with the Retrieve form data for a single form Application API endpoint – GET /api/REST/1.0/data/form/{id}
    • The processingStepErrors contains a list of “ProcessingStepError” objects.

     

    ProcessingStepError Properties

     

    Name

    Data Type

    Description

    processingStepId

    string

    UniqueId of the processing step in which error has occurred

    processingStepTypeId

    string

    Type of the processing step

    processingStepDisplayName

    string

    Display Name of processing step

    errorCode

    integer

    One of the codes defined below

    errorMessage

    string

    Short message describing error message

    errorDescription

    string

    Detailed information on what failed and sometimes why

     

    Error Codes, Messages, and Descriptions

     

    Error Type

    errorCode

    errorMessage

    errorDescription example

    Generic Error

    1000

    ProcessingStep: Generic Error

    Email address is duplicated

    Validation Error

    1001

    Type of the processing step

    EmailAddress must be a valid email address

     

     

    Example

     

    After 18D, processingStepErrors is returned if any processing step errors occur:

     

    Form id 4040 has an Email Address field that is not included in form submission

     

    Request:

     

    POST/api/REST/1.0/data/form/4040

    {

      "fieldValues": [

        {

          "type": "FieldValue",

          "id": "25093",

          "value": "John"

        }

      ]

    }

     

    Response: 201 Created

    {

      "id": "94729",

      "fieldValues": [

        {

          "type": "FieldValue",

          "id": "25093",

          "value": "John"

        }

      ],

    "processingStepErrors": [

        {

          "type": "ProcessingStepError",

          "errorCode": 1001,

          "errorDescription": "EmailAddress must be a valid email address.",

          "errorMessage": "ProcessingStep: Validation Error",

          "processingStepDisplayName": "Create / Update Contact, Prospect or Company",

          "processingStepId": "10119",

          "processingStepTypeId": "2000"

        }

      ]

    }

     

     

    Timeline

     

    With the arrival of Eloqua release 18D (Nov 16 - 17, 2018), the processingStepErrors property, a list of processing step errors, will be returned when processing step errors occur when using the Create form data for a single form Application API endpoint. This feature can be enabled for Early Preview with Eloqua release 18C. Release 18D is anticipated to arrive between Nov 16 - 17, 2018. Check the Eloqua Release Center for specific dates and times.

     

    Next Steps

     

    If submitting form data via the Application API, prepare for the processingStepErrors property, a list of processing step errors, to be returned when processing step errors occur.

     

    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!

     

     

    FAQ

     

    Q: What endpoints are impacted by this change?

    A: The Create form data for a single form Application API endpoint – POST /api/REST/1.0/data/form/{id}.

     

    Q: Will the processingStepErrors property be returned when retrieving form data?

    A: No, the Retrieve form data for a single form Application API endpoint, GET /api/REST/1.0/data/form/{id}, will not return the processingStepErrors property.

     

    Q: How can I enable the feature for Early Preview in 18C?

    A: To have this feature enabled before 18D, please log in to My Oracle Support and create a service request.