GET api/v2.0/AutomationRules/GetContactDataSubsetByRuleScheduleKey?ruleScheduleKey={ruleScheduleKey}&integrationId={integrationId}

Returns the requested subset of Contact Data.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ruleScheduleKey

The Unique Key for a RuleSchedule.

globally unique identifier

Required

dataSubsetType

Data Subset to Retrieve. Currently only supports emailaddress, which should be specified as type 0 in requests.

DataSubsetType

Required

integrationId

Contact's ID in the source database. This is the AMS Key or ID used by the source organization.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

An object containing the FieldNames, Data Results, and Data Record Count.

AutomationRuleDataSubset
NameDescriptionTypeAdditional information
RecordCount

Number of Records returned in the Data object.

integer

None.

Data

Dataset returned.

Collection of Object

None.

FieldNames

Comma-separated list of fields returned in the Data Object.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "RecordCount": 1,
  "Data": [
    {},
    {}
  ],
  "FieldNames": "sample string 2"
}

application/xml, text/xml

Sample:
<AutomationRuleDataSubset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.AutomationRules">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </Data>
  <FieldNames>sample string 2</FieldNames>
  <RecordCount>1</RecordCount>
</AutomationRuleDataSubset>