GET api/v2.0/AutomationRules/GetContactData?ruleScheduleKey={ruleScheduleKey}&maxRecords={maxRecords}&continuationToken={continuationToken}&fieldList={fieldList}

Returns a page of the requested Contact Data fields.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ruleScheduleKey

The UniqueIdentifier for the Automation Rule to look up.

 globally unique identifier

Required
maxRecords

Maximum Number of records to return. Has a default value of 50 (if not specified in the call) and must be less than 200.

 integer

Default value is 50
continuationToken

The last ContactKey seen. If not provided, will start at the first Contact Record in the database's sort order.

 string

None.
fieldList

List of fields to return.

 string

Default value is ContactKey,LegacyContactKey,UpdatedOn

Body Parameters

None.

Response Information

Resource Description

The requested Page of Contact Data fields.

ContactDataPage
NameDescriptionTypeAdditional information
RecordCount

Number of records being returned.

 integer

None.
ContactData

List of Key/Value Pair Contact data. Will be comprised of the requested fields and their values. If a requested field does not exist in the Contact record, it will be returned as null.

 Collection of Object

None.

Response Formats

application/json, text/json

Sample: 
{
  "RecordCount": 1,
  "ContactData": [
    {},
    {}
  ]
}

application/xml, text/xml

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