Jump to

• Request
• Response
• Examples

Retrieve a content section

get

/api/REST/1.0/assets/contentSection/{id}

Retrieves a content section specified by the id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer
  Id of the content section.

Query Parameters

• depth(optional): string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ContentSection

Type: object

Title: ContentSection

Show Source

• contentHtml(optional): string
  The content section's HTML content.
• contentText(optional): string
  The content section's text content.
• createdAt(optional): string
  Read Only: true

  The date and time the content section was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the content section.
• currentStatus(optional): string
  The content section's current status. This is a read-only property.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the content section.
• forms(optional): array forms
  A list of associated Form assets.
• hyperlinks(optional): array hyperlinks
  A list of hyperlinks contained within the content section.
• id(optional): string
  Read Only: true

  Id of the content section. This is a read-only property.
• images(optional): array images
  A list of associated Image assets.
• name(optional): string
  The name of the content section.
• permissions(optional): string
  The permissions for the content section granted to your current instance. This is a read-only property.
• scope(optional): string
  The content sections's scope: either local or global.
• size(optional): object Size
  Title: Size
• type(optional): string
  The content section's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the content section was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the content section.

{
    "title":"ContentSection",
    "properties":{
        "type":{
            "type":"string",
            "description":"The content section's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the content section. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The content section's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the content section."
        },
        "description":{
            "type":"string",
            "description":"The description of the content section."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the content section granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the content section."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the content section was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the content section."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the content section was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "contentHtml":{
            "type":"string",
            "description":"The content section's HTML content."
        },
        "contentText":{
            "type":"string",
            "description":"The content section's text content."
        },
        "scope":{
            "type":"string",
            "description":"The content sections's scope: either <code>local</code> or <code>global</code>."
        },
        "forms":{
            "type":"array",
            "description":"A list of associated Form assets.",
            "items":{
                "$ref":"#/definitions/FormRest10"
            }
        },
        "images":{
            "type":"array",
            "description":"A list of associated Image assets.",
            "items":{
                "$ref":"#/definitions/ImageFileRest10"
            }
        },
        "hyperlinks":{
            "type":"array",
            "description":"A list of hyperlinks contained within the content section.",
            "items":{
                "$ref":"#/definitions/HyperlinkRest10"
            }
        },
        "size":{
            "$ref":"#/definitions/SizeRest10",
            "description":"Generally contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the content section's desired dimensions."
        }
    }
}

Nested Schema : forms

Type: array

A list of associated Form assets.

Show Source

• Array of: object Form
  Title: Form

{
    "type":"array",
    "description":"A list of associated Form assets.",
    "items":{
        "$ref":"#/definitions/FormRest10"
    }
}

Nested Schema : hyperlinks

Type: array

A list of hyperlinks contained within the content section.

Show Source

• Array of: object Hyperlink
  Title: Hyperlink

{
    "type":"array",
    "description":"A list of hyperlinks contained within the content section.",
    "items":{
        "$ref":"#/definitions/HyperlinkRest10"
    }
}

Nested Schema : images

Type: array

A list of associated Image assets.

Show Source

• Array of: object ImageFile
  Title: ImageFile

{
    "type":"array",
    "description":"A list of associated Image assets.",
    "items":{
        "$ref":"#/definitions/ImageFileRest10"
    }
}

Nested Schema : Size

Type: object

Title: Size

Show Source

• type(optional): string

{
    "title":"Size",
    "properties":{
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Form

Type: object

Title: Form

Show Source

• archived(optional): string
  True if form is archived otherwise False. This is a read-only property.
• createdAt(optional): string
  Read Only: true

  The date and time the form was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the form.
• currentStatus(optional): string
  The form's current status. Example: draft, active, or complete.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the form.
• elements(optional): array elements
  Array consisting of form elements.
• emailAddressFormFieldId(optional): string
  The email address form field entity's unique identifier.
• html(optional): string
  The asset's raw HTML content.
• htmlName(optional): string
  The asset's raw HTML name.
• id(optional): string
  Read Only: true

  Id of the form. This is a read-only property.
• isHidden(optional): 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.
• name(optional): string
  The name of the form.
• permissions(optional): string
  The permissions for the form granted to your current instance. This is a read-only property.
• processingSteps(optional): 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(optional): string
  A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
• style(optional): string
  The asset's main layout style.
• submitFailedLandingPageId(optional): string
  The landing page id of the failed submit.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the form.

{
    "title":"Form",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the form. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form's current status. Example: draft, active, or complete."
        },
        "name":{
            "type":"string",
            "description":"The name of the form."
        },
        "description":{
            "type":"string",
            "description":"The description of the form."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the form granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the form."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the form."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the form was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "htmlName":{
            "type":"string",
            "description":"The asset's raw HTML name."
        },
        "processingType":{
            "type":"string",
            "description":"A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm."
        },
        "emailAddressFormFieldId":{
            "type":"string",
            "description":"The email address form field entity's unique identifier."
        },
        "submitFailedLandingPageId":{
            "type":"string",
            "description":"The landing page id of the failed submit."
        },
        "html":{
            "type":"string",
            "description":"The asset's raw HTML content."
        },
        "style":{
            "type":"string",
            "description":"The asset's main layout style."
        },
        "elements":{
            "type":"array",
            "description":"Array consisting of form elements.",
            "items":{
                "$ref":"#/definitions/FormElementRest10"
            }
        },
        "processingSteps":{
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/definitions/FormProcessingStepRest10"
            }
        },
        "isHidden":{
            "type":"string",
            "description":"Whether the form is an internal form. If <code>true</code>, the form is not exposed outside of Eloqua and any form submissions to this form are deleted."
        },
        "archived":{
            "type":"string",
            "description":"True if form is archived otherwise False. This is a read-only property."
        }
    }
}

Nested Schema : elements

Type: array

Array consisting of form elements.

Show Source

• Array of: object FormElement
  Title: FormElement

{
    "type":"array",
    "description":"Array consisting of form elements.",
    "items":{
        "$ref":"#/definitions/FormElementRest10"
    }
}

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

{
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/definitions/FormProcessingStepRest10"
    }
}

Nested Schema : FormElement

Type: object

Title: FormElement

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the form element was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the form element.
• currentStatus(optional): string
  The form element's current status.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the form element.
• id(optional): string
  Read Only: true

  Id of the form element. This is a read-only property.
• instructions(optional): string
  The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
• name(optional): string
  Name of the form element.
• permissions(optional): string
  The permissions for the form element granted to your current instance.
• style(optional): string
  The asset's main layout style.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form element was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the form element.

{
    "title":"FormElement",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the form element. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form element's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the form element."
        },
        "description":{
            "type":"string",
            "description":"The description of the form element."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the form element granted to your current instance."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the form element."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form element was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the form element."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the form element was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "instructions":{
            "type":"string",
            "description":"The form element's field instructions. Field instructions are optional instructions that help users fill in fields."
        },
        "style":{
            "type":"string",
            "description":"The asset's main layout style."
        }
    }
}

Nested Schema : FormProcessingStep

Type: object

Title: FormProcessingStep

Show Source

• conditionalComparator(optional): string
  The comparator used to validate a condition. Possible values include: exactly or not exactly.
• conditionalFieldId(optional): string
  The form field id used to compare form fields within a form processing step condition.
• conditionalType(optional): string
  The type of value the comparator is validating. Possible values include: 'form field' or 'static value'.
• createdAt(optional): string
  Read Only: true

  The date and time the form processing step was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the form processing step.
• currentStatus(optional): string
  The form processing step's current status.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the form processing step.
• execute(optional): string
  The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never.
• id(optional): string
  Read Only: true

  Id of the form processing step. This is a read-only property.
• isConditionallyNegated(optional): 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.
• name(optional): string
  Name of the form processing step.
• permissions(optional): string
  The permissions for the form processing step granted to your current instance.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form processing step was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the form processing step.

{
    "title":"FormProcessingStep",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the form processing step. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form processing step's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the form processing step."
        },
        "description":{
            "type":"string",
            "description":"The description of the form processing step."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the form processing step granted to your current instance."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the form processing step."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form processing step was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the form processing step."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the form processing step was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "execute":{
            "type":"string",
            "description":"The conditions for which this form processing step will execute. Possible values include: <code>always</code>, <code>conditionally</code>, and <code>never</code>."
        },
        "conditionalType":{
            "type":"string",
            "description":"The type of value the comparator is validating. Possible values include: 'form field' or 'static value'."
        },
        "conditionalFieldId":{
            "type":"string",
            "description":"The form field id used to compare form fields within a form processing step condition."
        },
        "conditionalComparator":{
            "type":"string",
            "description":"The comparator used to validate a condition. Possible values include: <code>exactly</code> or <code>not exactly</code>."
        },
        "isConditionallyNegated":{
            "type":"string",
            "description":"The conditions for which the processing step will execute. If <code>yes</code>, the processing step will execute when the conditions are met. If <code>no</code>, the processing step will execute when the conditions are not met."
        }
    }
}

Nested Schema : Hyperlink

Type: object

Title: Hyperlink

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the hyperlink was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the hyperlink.
• currentStatus(optional): string
  The hyperlink's current status.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the hyperlink.
• href(optional): string
  Href value of the hyperlink.
• hyperlinkType(optional): string
  The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
• id(optional): string
  Read Only: true

  Id of the hyperlink. This is a read-only property.
• name(optional): string
  Name of the hyperlink.
• permissions(optional): string
  The permissions for the hyperlink granted to your current instance.
• referencedEntityId(optional): string
  Id of the referenced entity.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the hyperlink was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the hyperlink.

{
    "title":"Hyperlink",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the hyperlink. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The hyperlink's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the hyperlink."
        },
        "description":{
            "type":"string",
            "description":"The description of the hyperlink."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the hyperlink granted to your current instance."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the hyperlink."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the hyperlink was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the hyperlink."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the hyperlink was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "href":{
            "type":"string",
            "description":"Href value of the hyperlink."
        },
        "hyperlinkType":{
            "type":"string",
            "description":"The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL."
        },
        "referencedEntityId":{
            "type":"string",
            "description":"Id of the referenced entity."
        }
    }
}

Nested Schema : ImageFile

Type: object

Title: ImageFile

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the image was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the image.
• currentStatus(optional): string
  The image's current status.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the image.
• fullImageUrl(optional): string
  The image's complete URL. This is a read-only property.
• id(optional): string
  Read Only: true

  Id of the image. This is a read-only property.
• name(optional): string
  The name of the image.
• permissions(optional): string
  The permissions for the image granted to your current instance. This is a read-only property.
• size(optional): object Size
  Title: Size
• thumbnailUrl(optional): string
  The image's thumbnail URL. This is a read-only property.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the image was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the image.

{
    "title":"ImageFile",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the image. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The image's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the image."
        },
        "description":{
            "type":"string",
            "description":"The description of the image."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the image granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the image."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the image was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the image."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the image was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "fullImageUrl":{
            "type":"string",
            "description":"The image's complete URL. This is a read-only property."
        },
        "size":{
            "$ref":"#/definitions/SizeRest10",
            "description":"The size of the image. Contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the image's desired dimensions."
        },
        "thumbnailUrl":{
            "type":"string",
            "description":"The image's thumbnail URL. This is a read-only property."
        }
    }
}

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.

Back to Top

Examples

Retrieve the content section asset with Id #2:

GET /api/REST/1.0/assets/contentSection/2?depth=complete
			

Response:

{
    "type":"ContentSection",
    "id":"5",
    "createdAt":"1402929831",
    "createdBy":"10",
    "depth":"complete",
    "folderId":"320",
    "name":"BP - Right Column Top (No Theme)",
    "updatedAt":"1402929831",
    "updatedBy":"10",
    "contentHtml":"<table><tr><td>Example text.</td></tr></table>",
    "contentText":"Example text.",
    "forms":[],
    "hyperlinks":[],
    "images":[
        {
            "type":"ImageFile",
            "currentStatus":"unmatched",
            "id":"-1",
            "name":"image.jpg",
            "fullImageUrl":"image.jpg"
        }
    ],
    "scope":"global",
    "size":{
        "type":"Size",
        "width":"0",
        "height":"0"
    }
}
			

Back to Top