リード編集履歴取得API

マーケティングプラットフォームのリード編集履歴情報を参照するためのAPIです。

メソッド名

visitor.getChangelog

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/visitor/changelog

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=
order	オプション	並び順の項目指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照
direction	オプション	並び順を指定する「asc」（昇順）または「desc」（降順）
limit	オプション	1回のリクエストで取得するレコード数（最大1000）
offset	オプション	レコードのオフセット

検索条件・並び順に指定可能なカラム

カラム名	検索条件	並び順	内容
Id	○	○	リード編集履歴項目ID
VisitorChangeLogId	○	○	リード編集履歴ID
VisitorId	○	○	リードID
OriginalVisitorId	○	○	マージされる前のリードID
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
ItemName	○	○	項目名
OldValue	○	×	編集前の値
NewValue	○	×	編集後の値
ReasonTypeId	○	○	変更要因種別ID
ReasonId	○	○	変更要因データID ReasonTypeIdが1の場合、リードマージ履歴IDです
LastupdateUserId	○	○	更新者ユーザーID

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：VisitorChangeLog ★ データ型：VisitorChangeLogType

カラム名	データ型	内容
Id	string	リード編集履歴項目ID
VisitorChangeLogId	string	リード編集履歴ID
VisitorId	string	リードID
OriginalVisitorId	string	マージされる前のリードID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
ItemName	string	項目名
OldValueList	ChangeLogOldValueListType	編集前の値（OldValue）のリスト OldValueの内容は Value : ValueDesc
NewValueList	ChangeLogNewValueListType	編集後の値（NewValue）のリスト NewValueの内容は Value : ValueDesc
ReasonType	ReasonTypeType	変更要因種別 ReasonTypeId : ReasonTypeName 1 : リード手動マージ
ReasonId	string	変更要因データID ReasonTypeIdが1の場合、リードマージ履歴IDです
LastupdateUserId	string	更新者ユーザーID

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<VisitorChangeLogList xmlns="http://smartseminar.jp/" version="1.45">
    <VisitorChangeLog>
        <ReasonType>
            <ReasonTypeName>リード手動マージ</ReasonTypeName>
            <ReasonTypeId>1</ReasonTypeId>
        </ReasonType>
        <Id>43</Id>
        <VisitorChangeLogId>8</VisitorChangeLogId>
        <NewValueList>
            <NewValue>
                <Value>1</Value>
                <ValueDesc>選択肢１</ValueDesc>
            </NewValue>
            <NewValue>
                <Value>5</Value>
                <ValueDesc>選択肢４</ValueDesc>
            </NewValue>
            <NewValue>
                <Value>9</Value>
                <ValueDesc>選択肢８</ValueDesc>
            </NewValue>
            <NewValue>
                <Value>11</Value>
                <ValueDesc>選択肢１０</ValueDesc>
            </NewValue>
        </NewValueList>
        <LastupdateUserId>1</LastupdateUserId>
        <ReasonId>1</ReasonId>
        <DateUpdate>2016-09-06T12:14:39+09:00</DateUpdate>
        <DateRegist>2016-09-06T12:14:39+09:00</DateRegist>
        <OriginalVisitorId>6</OriginalVisitorId>
        <ItemName>attribute4</ItemName>
        <OldValueList>
            <OldValue>
                <Value>1</Value>
                <ValueDesc>選択肢１</ValueDesc>
            </OldValue>
            <OldValue>
                <Value>11</Value>
                <ValueDesc>選択肢１０</ValueDesc>
            </OldValue>
        </OldValueList>
        <VisitorId>6</VisitorId>
    </VisitorChangeLog>
</VisitorChangeLogList>

制限事項

なし