Retrieve a form
get
/api/rest/2.0/assets/form/{id}
Retrieves the form specified by the
id
parameter.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the form.
Query Parameters
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Form
Type:
object
Title:
Show Source
Form
-
archived:
string
True if form is archived otherwise False. This is a read-only property.
-
createdAt:
string
Read Only:
true
The date and time the form was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login ID of the user who created the form. -
createdByName:
string
The name of the user who created the form.
-
currentStatus:
string
The form's current status. Example: draft, active, or complete.
-
customCSS:
string
The custom style applied to the form.
-
defaultKeyFieldMapping:
object FormFieldUpdateMapping
Title:
FormFieldUpdateMapping
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the form.
-
elements:
array elements
Array consisting of form elements.
-
externalIntegrationUrl:
string
The external integration URL used for integrating external forms.
-
folderId:
string
Read Only:
true
The ID of the containing folder. -
formJson:
string
Form metadata in JSON. Applicable only to responsive forms. Not required to be set when creating and updating forms. We recommend omitting this parameter when creating and updating forms, and letting Eloqua set it by default. When creating a form and including this parameter, this must be set to
{\"type\":\"responsiveForm\",\"version\":\"1\"}
. -
html:
string
The asset's raw HTML content.
-
htmlName:
string
The asset's raw HTML name.
-
id:
string
Read Only:
true
Id of the form. -
isFormSpamProtectionEnabled:
string
Indicates whether spam protection is enabled on the form.
-
isHidden:
string
Whether the form is an internal form. If true, the form is not exposed outside of Eloqua and any form submissions to this form are deleted.
-
isResponsive:
string
Indicates whether the form is responsive. Returns
true
for a responsive form,false
for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property. -
name:
string
The name of the form.
-
permissions:
array permissions
The permissions for the form granted to your current instance. This is a read-only property.
-
processingSteps:
array processingSteps
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
-
processingType:
string
A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
-
scheduledFor:
string
Read Only:
true
This property is not used. -
size:
object Size
Title:
Size
-
sourceTemplateId:
string
Id of the source template.
-
style:
string
The asset's main layout style.
-
submitFailedLandingPageId:
string
The landing page ID of the failed submit.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form was last updated. -
updatedBy:
string
Read Only:
true
The login ID of the user that last updated the form. -
updatedByName:
string
The name of the user who last updated the form.
Nested Schema : FormFieldUpdateMapping
Type:
object
Title:
Show Source
FormFieldUpdateMapping
-
createdAt:
string
Read Only:
true
The date and time the form field update mapping was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the form field update mapping. -
createdByName:
string
The name of the user who created the form field update mapping.
-
currentStatus:
string
The form field update mapping's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the field comparison criteria.
-
folderId:
string
Read Only:
true
Id of the folder. This is a read-only property. -
id:
string
Read Only:
true
Id of the form field update mapping. -
name:
string
The name of the form field update mapping.
-
permissions:
array permissions
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the form field update mapping is scheduled. -
sourceFormFieldId:
string
Id of the source form field.
-
sourceTemplateId:
string
Id of the source template. This is a read-only property.
-
targetEntityFieldId:
string
Id of the target field.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form field update mapping was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the form field update mapping. -
updatedByName:
string
The name of the user who last updated the form field update mapping.
-
updateType:
string
The update type of the form field update mapping.
Nested Schema : elements
Type:
array
Array consisting of form elements.
Show Source
-
Array of:
object FormElement
Title:
FormElement
Nested Schema : permissions
Type:
array
The permissions for the form granted to your current instance. This is a read-only property.
Show Source
Nested Schema : processingSteps
Type:
array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
Show Source
-
Array of:
object FormProcessingStep
Title:
FormProcessingStep
Nested Schema : Size
Type:
object
Title:
Show Source
Size
-
height:
string
The height dimensions of the asset expressed in pixels.
-
type:
string
The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
-
width:
string
The width dimensions of the asset expressed in pixels.
Nested Schema : permissions
Type:
array
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FormElement
Type:
object
Title:
Show Source
FormElement
-
createdAt:
string
Read Only:
true
The date and time the form element was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login ID of the user who created the form element. -
createdByName:
string
The name of the user who created the form element.
-
currentStatus:
string
The form element's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the form element.
-
folderId:
string
Read Only:
true
The ID of the associated folder. -
id:
string
Read Only:
true
The ID of the form element. This is a read-only property. -
instructions:
string
The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
-
name:
string
Name of the form element.
-
permissions:
array permissions
The permissions for the form element granted to your current instance.
-
scheduledFor:
string
Read Only:
true
The date the form element is scheduled. -
sourceTemplateId:
string
The ID of the form element.
-
style:
string
The asset's main layout style.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form element was last updated. -
updatedBy:
string
Read Only:
true
The login ID of the user that last updated the form element. -
updatedByName:
string
The name of the user who last updated the form element.
Nested Schema : permissions
Type:
array
The permissions for the form element granted to your current instance.
Show Source
Nested Schema : FormProcessingStep
Type:
object
Title:
Show Source
FormProcessingStep
-
condition:
object ProcessingStepCondition
Title:
ProcessingStepCondition
-
createdAt:
string
Read Only:
true
The date and time the form processing step was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login ID of the user who created the form processing step. -
createdByName:
string
The name of the user who created the form processing step.
-
currentStatus:
string
The form processing step's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the form processing step.
-
execute:
string
The conditions for which this form processing step will execute. Possible values include:
always
,conditionally
, andnever
. -
folderId:
string
Read Only:
true
Id of the associated folder. -
hasValidationIssue:
string
ProcessingStep_Field_HasValidationIssue_Description
-
id:
string
Read Only:
true
Id of the form processing step. This is a read-only property. -
name:
string
Name of the form processing step.
-
permissions:
array permissions
The permissions for the form processing step granted to your current instance.
-
scheduledFor:
string
Read Only:
true
The date the form processing step is scheduled. -
sourceTemplateId:
string
The ID of the source template.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form processing step was last updated. -
updatedBy:
string
Read Only:
true
The login ID of the user that last updated the form processing step. -
updatedByName:
string
The name of the user who last updated the form processing step.
Nested Schema : ProcessingStepCondition
Type:
object
Title:
Show Source
ProcessingStepCondition
-
conditionalFieldCriteria:
array conditionalFieldCriteria
The conditional field criteria for the form processing step condition.
-
isConditionallyNegated:
string
The conditions for which the processing step will execute. If yes, the processing step will execute when the conditions are met. If no, the processing step will execute when the conditions are not met.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : permissions
Type:
array
The permissions for the form processing step granted to your current instance.
Show Source
Nested Schema : conditionalFieldCriteria
Type:
array
The conditional field criteria for the form processing step condition.
Show Source
-
Array of:
object FieldComparisonCriteria
Title:
FieldComparisonCriteria
Nested Schema : FieldComparisonCriteria
Type:
object
Title:
Show Source
FieldComparisonCriteria
-
condition:
object Condition
Title:
Condition
-
createdAt:
string
Read Only:
true
The date and time the field comparison criteria was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the field comparison criteria. -
createdByName:
string
The name of the user who created the field comparison criteria.
-
currentStatus:
string
The field comparison criteria's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the field comparison criteria.
-
fieldId:
string
The id of the field comparison criteria.
-
folderId:
string
Read Only:
true
Id of the folder. This is a read-only property. -
id:
string
Read Only:
true
Id of the field comparison criteria. -
name:
string
The name of the field comparison criteria.
-
permissions:
array permissions
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the field comparison criteria is scheduled. -
sourceTemplateId:
string
Id of the source template. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the field comparison criteria was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the field comparison criteria. -
updatedByName:
string
The name of the user who last updated the field comparison criteria.
Nested Schema : Condition
Type:
object
Title:
Show Source
Condition
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : permissions
Type:
array
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
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.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to retrieve a form using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve the form asset with Id #63:
GET /api/REST/2.0/assets/form/63
Response:
{
"type": "Form",
"currentStatus": "Draft",
"id": "63",
"createdAt": "1548835153",
"createdBy": "35",
"depth": "complete",
"folderId": "4124",
"name": "Demo Design Editor",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1548835684",
"updatedBy": "35",
"archived": "false",
"customCSS": "<style type=\"text/css\" media=\"screen\"> /* RESET */.elq-form * { margin: 0; padding: 0;}.elq-form input,textarea {\t-webkit-box-sizing:content-box;\t-moz-box-sizing:content-box;\tbox-sizing:content-box;}.elq-form input[type=text],.elq-form textarea,.elq-form select[multiple=multiple] {\tborder: 1px solid #A6A6A6;} .elq-form button,input[type=reset],input[type=button],input[type=submit],input[type=checkbox],input[type=radio],select {\t-webkit-box-sizing:border-box;\t-moz-box-sizing:border-box;\tbox-sizing:border-box;}/* GENERIC */.elq-form input {\theight: 16px;\tline-height: 16px;}.elq-form .item-padding {\tpadding:6px 5px 9px 9px;}.elq-form .pp-group {\tpadding:0px 5px 0px 9px;}.elq-form .pp-field {\tpadding:6px 0px 9px 0px;}.elq-form .field-wrapper.individual { float: left; width: 100%;\tclear: both;}.elq-form .field-p {\tposition: relative;\tmargin: 0;\tpadding: 0;}.elq-form .zIndex-fix {\tposition: absolute;\tz-index: 1;\ttop: 0;\tleft: 0;\tright: 0;\tbottom: 0;}.elq-form .field-design {\tposition:absolute;\tz-index:2;\ttop:0;\tleft:0;\tright:0;\tbottom:0;\tmargin:0;\tpadding:0;}.elq-form .no-fields-prompt {\tfloat: left;\twidth: 100%;\theight: 150px;\tpadding-top: 50px;\tclear: both;}/* SECTION BREAKS */.elq-form .section-break {\tfloat:left;\twidth: 97%;\tmargin-right:2%;\tmargin-left:1%;\tpadding-bottom:6px;}.elq-form .section-break .heading {\twidth:100%;\tfont-weight: bold;\tmargin:0;\tpadding:0;}/* LABEL */.elq-form .required {\tcolor: red !important;\tdisplay: inline;\tfloat: none;\tfont-weight: bold;\tmargin: 0pt 0pt 0pt;\tpadding: 0pt 0pt 0pt;}/* FIELD GROUP */.elq-form .field-group {\tfloat: left;\tclear: both;}.elq-form .field-group.large {\twidth:100%;}.elq-form .field-group.medium {\twidth:51%;}.elq-form .field-group.small {\twidth:31%;}.elq-form .field-group .label {\tfloat:left;\twidth:97%;\tmargin-right:2%;\tmargin-left:1%;\tpadding-bottom:6px;\tfont-weight: bold;}.elq-form .field-group .field-style {\tfloat: left;}.elq-form .progressive-profile .pp-inner {\tfloat: left;\tclear: both;}.elq-form .progressive-profile .pp-inner.large {\twidth:100%;}.elq-form .progressive-profile .pp-inner.medium {\twidth:51%;}.elq-form .progressive-profile .pp-inner.small {\twidth:31%;}/* RADIO */.elq-form .radio-option {\tdisplay: inline-block;}.elq-form .radio-option .label {\tdisplay:block;\tfloat:left;\tpadding-right:10px;\tpadding-left:22px;\ttext-indent:-22px;}.elq-form .radio-option .input {\tvertical-align:middle;\tmargin-right:7px;}.elq-form .radio-option .inner {\tvertical-align:middle;}/* CHECKBOX */.elq-form .checkbox-span {\tdisplay:inline-block;}.elq-form .checkbox-label {\tmargin-left:4px;}/* INPUT */.elq-form .accept-default {\twidth:100%;}/* SIZING */.elq-form .field-style {\tmargin-right:2%;\tmargin-left:2%;}.elq-form .field-style._25 {\twidth:21%;}.elq-form .field-style._50 {\twidth:46%;}.elq-form .field-style._50_left {\tclear:left;\twidth:46%;}.elq-form .field-style._75 {\twidth:71%;}.elq-form .field-style._100 {\twidth:96%;}.elq-form .field-size-top-small {\twidth:30%;}.elq-form .field-size-top-medium {\twidth:75%;}.elq-form .field-size-top-large {\twidth:100%;}.elq-form .field-size-left-small {\twidth:21%;}.elq-form .field-size-left-medium {\twidth:46%;}.elq-form .field-size-left-large {\twidth:60%;}/* INSTRUCTIONS */.elq-form .instructions.default {\tcolor:#444444;\tdisplay:block;\tfont-size:10px;\tpadding:6px 0pt 3px;}.elq-form .instructions.group {\tfloat:left;\twidth:97%;\tmargin-right:2%;\tmargin-left:2%;\tpadding:6px 0pt 3px;\tcolor:#444444;\tdisplay:block;\tfont-size:10px;}.elq-form .instructions.left-single {\tmargin:0 0 0 33%;}.elq-form .instructions-other { margin:0;}/* POSITIONING */.elq-form .label-position.left {\tdisplay:block; line-height:150%; padding:1px 0pt 3px; float:left; width:31%; margin:0pt 15px 0pt 0pt; word-wrap:break-word; overflow-wrap: break-word;}.elq-form .label-position.top {\tdisplay:block; line-height:150%; padding:1px 0pt 3px; white-space:normal;}.elq-form .label-position.alignment-left {\ttext-align: left;}.elq-form .label-position.alignment-right {\ttext-align: right;}/* LIST ORDER */.elq-form .list-order {\tdisplay:block;}.elq-form .list-order.oneColumn {\tmargin:0pt 7px 0pt 0pt;\twidth:100%;\tclear:both;}.elq-form .list-order.twoColumn {\tfloat:left;\tmargin:0pt 7px 0pt 0pt;\twidth:38%;}.elq-form .list-order.threeColumn {\tfloat:left;\tmargin:0pt 7px 0pt 0pt;\twidth:30%;}.elq-form .list-order.oneColumnLeft {\tfloat:left;\tmargin:0pt 7px 0pt 0pt;\twidth:100%;}.elq-form .list-order.twoColumnLeft {\tfloat:left;\tmargin:0pt 7px 0pt 0pt;\twidth:38%;}.elq-form .list-order.threeColumnLeft {\tfloat:left;\tmargin:0pt 7px 0pt 0pt;\twidth:30%;}/* GRID STYLE */.elq-form .grid-style { display:inline; float:left; margin-left:2%; margin-right:2%;}.elq-form .grid-style._25 { width:21%;}.elq-form .grid-style._50 { width:46%;}.elq-form .grid-style._75 { width:71%;}.elq-form .grid-style._100 { width:96%; }</style>",
"defaultKeyFieldMapping": {
"type": "FormFieldUpdateMapping",
"sourceFormFieldId": "361",
"targetEntityFieldId": "100001"
},
"elements": [
{
"type": "FormFieldGroup",
"id": "13",
"depth": "complete",
"name": "StarBoat Registration Form",
"instructions": "",
"style": "{\"textType\":\"header\",\"fieldSize\":\"large\",\"guid\":\"458B537B18ACAE11D710FBCF031E75CE\"}"
},
{
"type": "FormField",
"id": "361",
"name": "Email Address",
"instructions": "Email Address is mandatory",
"style": "{\"fieldSize\":\"large\",\"guid\":\"123F7A81ED022F9E9938A113F61439BC\"}",
"createdFromContactFieldId": "100001",
"dataType": "text",
"displayType": "text",
"fieldMergeId": "23",
"htmlName": "emailAddress",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2491",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "IsRequiredCondition"
},
"isEnabled": "true",
"message": "This field is required"
},
{
"type": "FieldValidation",
"id": "2492",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "IsEmailAddressCondition"
},
"isEnabled": "true",
"message": "A valid email address is required"
}
]
},
{
"type": "FormField",
"id": "362",
"name": "Title",
"style": "{\"fieldSize\":\"large\",\"guid\":\"C60D1397DC89B2D18D42FAEC4EC29018\"}",
"createdFromContactFieldId": "100016",
"dataType": "text",
"displayType": "text",
"htmlName": "title",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2493",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2494",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2495",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "363",
"name": "First Name",
"style": "{\"fieldSize\":\"large\",\"guid\":\"83CE0C20A8A22AB7C7275FD02BFE7EB9\"}",
"createdFromContactFieldId": "100002",
"dataType": "text",
"displayType": "text",
"fieldMergeId": "20",
"htmlName": "firstName",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2496",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2497",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2498",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "364",
"name": "Last Name",
"style": "{\"fieldSize\":\"large\",\"guid\":\"822D594DA8FA303A2238120797C5363F\"}",
"createdFromContactFieldId": "100003",
"dataType": "text",
"displayType": "text",
"fieldMergeId": "22",
"htmlName": "lastName",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2499",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2500",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2501",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "365",
"name": "Address 1",
"style": "{\"fieldSize\":\"large\",\"guid\":\"CE34A7044925A57BD26788BD4ADE622C\"}",
"createdFromContactFieldId": "100006",
"dataType": "text",
"displayType": "text",
"htmlName": "address1",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2502",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2503",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2504",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "366",
"name": "Address 2",
"style": "{\"fieldSize\":\"large\",\"guid\":\"7FAA0B6BDFF31E233515326F8352ADF3\"}",
"createdFromContactFieldId": "100007",
"dataType": "text",
"displayType": "text",
"htmlName": "address2",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2505",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2506",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2507",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "367",
"name": "Zip or Postal Code",
"style": "{\"fieldSize\":\"large\",\"guid\":\"BC956DFF1D9424DC654EB9984E8B6880\"}",
"createdFromContactFieldId": "100011",
"dataType": "text",
"displayType": "text",
"htmlName": "zipPostal",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2508",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2509",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2510",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "368",
"name": "Country",
"style": "{\"fieldSize\":\"large\",\"guid\":\"260621010D842233140A97737DB59FF5\"}",
"createdFromContactFieldId": "100012",
"dataType": "text",
"displayType": "singleSelect",
"fieldMergeId": "4",
"htmlName": "country",
"optionListId": "4",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2511",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2512",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
}
]
},
{
"type": "FormField",
"id": "369",
"name": "Business Phone",
"instructions": "Business Phone is mandatory",
"style": "{\"fieldSize\":\"large\",\"guid\":\"2585D2949B8F474696D3CD71662B4391\"}",
"createdFromContactFieldId": "100013",
"dataType": "text",
"displayType": "text",
"htmlName": "busPhone",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2513",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2514",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2515",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
},
{
"type": "FieldValidation",
"id": "2516",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "IsRequiredCondition"
},
"isEnabled": "true",
"message": "This field is required"
}
]
},
{
"type": "FormField",
"id": "370",
"name": "Fax",
"style": "{\"fieldSize\":\"large\",\"guid\":\"DC199F7974BE280AB64A44C0F362B5D4\"}",
"createdFromContactFieldId": "100015",
"dataType": "text",
"displayType": "text",
"htmlName": "fax",
"useGlobalSubscriptionStatus": "False",
"validations": [
{
"type": "FieldValidation",
"id": "2517",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventUrlCondition"
},
"isEnabled": "true",
"message": "Value must not contain any URL's"
},
{
"type": "FieldValidation",
"id": "2518",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "PreventXSSCondition"
},
"isEnabled": "true",
"message": "Value must not contain any HTML"
},
{
"type": "FieldValidation",
"id": "2519",
"depth": "complete",
"description": "Form Field Validation Rule",
"name": "Form Field Validation Rule",
"condition": {
"type": "TextLengthCondition",
"maximum": "35",
"minimum": "0"
},
"isEnabled": "true",
"message": "Invalid length for field value"
}
]
},
{
"type": "FormField",
"id": "360",
"name": "GO",
"style": "{\"fieldSize\":\"large\",\"submitButtonStyleType\":\"standard\",\"guid\":\"A2A6EDD6022207653BD0EE7749ABF133\",\"submitButtonAlignStyle\":\"center\"}",
"dataType": "text",
"displayType": "submit",
"htmlName": "submit",
"useGlobalSubscriptionStatus": "False",
"validations": [
]
}
],
"formJson": "{\"type\":\"responsiveForm\",\"version\":\"1\"}",
"htmlName": "DemoDesignEditor",
"isHidden": "false",
"isResponsive": "true",
"processingSteps": [
{
"type": "FormStepCreateUpdateContactFromFormField",
"id": "243",
"name": "Create / Update Contact, Prospect or Company",
"execute": "always",
"keyFieldId": "100001",
"mappings": [
{
"type": "FormFieldUpdateMapping",
"sourceFormFieldId": "370",
"targetEntityFieldId": "100015",
"updateType": "useFieldRule"
}
]
},
{
"type": "FormStepRedirectToWebPage",
"id": "244",
"name": "Redirect to Webpage",
"execute": "always",
"landingPageId": {
"type": "ProcessingStepValueWithLookup",
"constantValue": "7",
"valueType": "constant"
}
}
],
"processingType": "externalWebsite",
"size": {
"type": "Size",
"width": "0",
"height": "0"
},
"style": "{\"fieldSize\":\"medium\",\"labelPosition\":\"top\"}",
"submitFailedLandingPageId": "6"
}
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/rest/2.0/assets/form/63