Jump to

• Request
• Response

Retrieve a list of signature rule mappings

get

/api/REST/2.0/assets/email/signature/rule/{ruleId}/mappings

Retrieves all signature rule mappings for the signature rule specified by the id parameter that match the criteria specified by the request parameters.

Request

Supported Media Types

• application/json

Path Parameters

• ruleId(required): integer
  Id of the signature rule to target.

Query Parameters

• count: integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth: 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 minimal by default.
• lastUpdatedAt: integer
  Unix timestamp for the date and time the external asset was last updated.
• orderBy: string
  Specifies the field by which list results are ordered, and the direction. The direction will default to ASC if not specified. See the URL parameters for information.
• page: integer
  Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
• search: string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : QueryResultRuleMapping

Type: object

Title: QueryResultRuleMapping

Show Source

• elements: array elements
  Array of signature rule mappings.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultRuleMapping",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of signature rule mappings.",
            "items":{
                "$ref":"#/definitions/EmailSignatureRuleMappingRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of signature rule mappings.

Show Source

• Array of: object EmailSignatureRuleMapping
  Title: EmailSignatureRuleMapping

{
    "type":"array",
    "description":"Array of signature rule mappings.",
    "items":{
        "$ref":"#/definitions/EmailSignatureRuleMappingRest20"
    }
}

Nested Schema : EmailSignatureRuleMapping

Type: object

Title: EmailSignatureRuleMapping

Show Source

• matchValue: string
  The value to be used for comparison.
• senderId: string
  The id of the user that will be used as the sender if the contact's field value matches the match value.
• type: string
  The asset's type in Eloqua.

{
    "title":"EmailSignatureRuleMapping",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "matchValue":{
            "type":"string",
            "description":"The value to be used for comparison."
        },
        "senderId":{
            "type":"string",
            "description":"The id of the user that will be used as the sender if the contact's field value matches the match value."
        }
    }
}

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