Jump to

• Request
• Response

Search for Dedupe and Match Rules by Name

get

/api/rest/2.0/assets/dedupeRules

and select Either or both using parameters

Request

Supported Media Types

• application/json

Query Parameters

• IsCompleted: boolean
  Field that specifies if a Match Rule or Dedupe Rule is completed or not. Fetches Both if not specified
• IsMatchRule: boolean
  Field that specifies if this is a Match Rule or Dedupe Rule. Fetches Both if not specified
• count: integer
  Max records in a page to be fetched
• page: integer
  Page number to be fetched
• search: string
  Search term
• sourceType: integer
  Source Entity Type E.g. 1 (for contact), endpoint uses it to filter out the result if provided
• targetType: integer
  Target Entity Type E.g. 2 (for Company), endpoint uses it to filter out the result if provided

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultDedupeRule

Type: object

Title: QueryResultDedupeRule

Show Source

• elements: array elements
  Array of the Dedupe Rule fields
• page: integer
  The Specified page
• pageSize: integer
  The Page size
• total: integer
  Total number of Dedupe Rules returned
• type: string
  The Dedupe rule type in Eloqua

{
    "title":"QueryResultDedupeRule",
    "properties":{
        "type":{
            "type":"string",
            "description":"The Dedupe rule type in Eloqua"
        },
        "elements":{
            "type":"array",
            "description":"Array of the Dedupe Rule fields",
            "items":{
                "$ref":"#/definitions/DedupeRuleRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"Total number of Dedupe Rules returned"
        },
        "pageSize":{
            "type":"integer",
            "description":"The Page size"
        },
        "page":{
            "type":"integer",
            "description":"The Specified page"
        }
    }
}

Nested Schema : elements

Type: array

Array of the Dedupe Rule fields

Show Source

• Array of: object DedupeRule
  Title: DedupeRule

{
    "type":"array",
    "description":"Array of the Dedupe Rule fields",
    "items":{
        "$ref":"#/definitions/DedupeRuleRest20"
    }
}

Nested Schema : DedupeRule

Type: object

Title: DedupeRule

Show Source

• createdAt: string
  Read Only: true
• createdBy: string
  Read Only: true
• currentStatus: string
• depth: string
  Read Only: true
• description: string
• folderId: string
  Read Only: true
• id: string
  Read Only: true
• isCompleted: string
• isMatchRule: string
• name: string
• permissions: array permissions
• scheduledFor: string
  Read Only: true
• sourceEntityType: string
• sourceTemplateId: string
• targetEntityType: string
• type: string
• updatedAt: string
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "title":"DedupeRule",
    "properties":{
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "readOnly":true
        },
        "currentStatus":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true
        },
        "sourceTemplateId":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "createdAt":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true
        },
        "depth":{
            "type":"string",
            "readOnly":true
        },
        "sourceEntityType":{
            "type":"string"
        },
        "targetEntityType":{
            "type":"string"
        },
        "isMatchRule":{
            "type":"string"
        },
        "isCompleted":{
            "type":"string"
        }
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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