キャンペーン・メンバーの作成
post
/crmRestApi/resources/11.13.18.05/campaignMembers
リクエスト
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
CampaignCampaignNumber: string
タイトル:
Campaign Number最大長:30キャンペーン・メンバーが属するキャンペーンの一意の識別子。 -
CampaignId: integer (int64)
タイトル:
Campaign Identifierキャンペーンの一意の識別子。 -
CampaignMemberId: integer (int64)
タイトル:
Campaign Member IDキャンペーン・メンバーの一意の識別子。 -
CampaignMemberNumber: string
タイトル:
Campaign Member Number最大長:30キャンペーン・メンバーの代替キー識別子。 -
ContactId: integer (int64)
タイトル:
Contact IDキャンペーン・メンバーに関連付けられたパーティの一意の識別子。 -
CreatedByModule: string
タイトル:
Created by Module最大長:60デフォルト値:ORA_WSキャンペーン・メンバーを作成できるモジュール。 -
CurrencyCode: string
タイトル:
Currency最大長:15USDやGBPなど、キャンペーン・メンバーに関連付けられた通貨を示すコード。 -
EmailAddress: string
タイトル:
Email最大長:320キャンペーン・メンバーの電子メール・アドレス。 -
LeadId: integer (int64)
タイトル:
Lead IDキャンペーン・メンバーに関連付けられたリードの一意の識別子。 -
LeadLeadNumber: string
タイトル:
Lead Number最大長:30キャンペーン・メンバーに関連付けられたリードの一意の代替識別子。 -
MemberResponseDate: string (date-time)
タイトル:
Response Dateキャンペーン・メンバーのレスポンスを受信した日付。 -
MemberStatus: string
タイトル:
Member Status最大長:30デフォルト値:ORA_SENTキャンペーン・メンバーのステータス。 -
SourceSystemCampMemberId: string
タイトル:
Source System Campaign Member ID最大長:100ソース・システム内のキャンペーン・メンバーの一意の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : campaignMembers-item-response
タイプ:
ソースを表示
object-
Active: string
タイトル:
Is Active読取り専用:true最大長:1デフォルト値:Yキャンペーン・メンバーがアクティブかどうかを示します。 -
CampaignCampaignName: string
タイトル:
Name読取り専用:true最大長:100キャンペーン・メンバーが属するキャンペーンの名前。 -
CampaignCampaignNumber: string
タイトル:
Campaign Number最大長:30キャンペーン・メンバーが属するキャンペーンの一意の識別子。 -
CampaignEndDate: string (date-time)
タイトル:
End Date読取り専用:trueマーケティング統合キャンペーンが終了する日付。 -
CampaignId: integer (int64)
タイトル:
Campaign Identifierキャンペーンの一意の識別子。 -
CampaignMemberId: integer (int64)
タイトル:
Campaign Member IDキャンペーン・メンバーの一意の識別子。 -
CampaignMemberNumber: string
タイトル:
Campaign Member Number最大長:30キャンペーン・メンバーの代替キー識別子。 -
CampaignStartDate: string (date-time)
タイトル:
Start Date読取り専用:trueマーケティング統合キャンペーンが開始する日付。 -
CampaignStatus: string
タイトル:
Status読取り専用:true最大長:30デフォルト値:ORA_DRAFTマーケティング統合キャンペーンのステータス。 -
CampaignType: string
タイトル:
Type読取り専用:true最大長:30マーケティング統合キャンペーンのタイプ。 -
ContactEmail: string
タイトル:
Contact Email読取り専用:true最大長:320キャンペーン・メンバーに関連付けられた担当者の電子メール・アドレス。 -
ContactId: integer (int64)
タイトル:
Contact IDキャンペーン・メンバーに関連付けられたパーティの一意の識別子。 -
ContactPartyName: string
タイトル:
Contact Name読取り専用:true最大長:360キャンペーン・メンバーに関連付けられた担当者パーティの名前。 -
ContactPartyNumber: string
タイトル:
Contact Number読取り専用:true最大長:30キャンペーン・メンバーに関連付けられた担当者の一意の代替識別子。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64キャンペーン・メンバーを作成したユーザー。 -
CreatedByModule: string
タイトル:
Created by Module最大長:60デフォルト値:ORA_WSキャンペーン・メンバーを作成できるモジュール。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueキャンペーン・メンバーが作成された日付。 -
CurrencyCode: string
タイトル:
Currency最大長:15USDやGBPなど、キャンペーン・メンバーに関連付けられた通貨を示すコード。 -
DeleteFlag: boolean
タイトル:
Can Be Deleted読取り専用:trueログイン・ユーザーがキャンペーン・メンバーを削除できるかどうかを示します。 -
EmailAddress: string
タイトル:
Email最大長:320キャンペーン・メンバーの電子メール・アドレス。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:trueキャンペーン・メンバーが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64キャンペーン・メンバーを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32キャンペーン・メンバーを最後に更新したユーザーのログイン。 -
LeadAccountName: string
タイトル:
Lead Account読取り専用:true最大長:360キャンペーン・メンバーに関連付けられた見込み客の取引先名。 -
LeadEmail: string
タイトル:
Lead Email読取り専用:true最大長:320キャンペーン・メンバーに関連付けられたリードのEメール・アドレス。 -
LeadId: integer (int64)
タイトル:
Lead IDキャンペーン・メンバーに関連付けられたリードの一意の識別子。 -
LeadLeadName: string
タイトル:
Lead Name読取り専用:true最大長:250キャンペーン・メンバーに関連付けられている見込み客の名前。 -
LeadLeadNumber: string
タイトル:
Lead Number最大長:30キャンペーン・メンバーに関連付けられたリードの一意の代替識別子。 -
LeadOwnerName: string
タイトル:
Lead Owner読取り専用:true最大長:360キャンペーン・メンバーに関連付けられたリードの所有者名。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
MemberResponseDate: string (date-time)
タイトル:
Response Dateキャンペーン・メンバーのレスポンスを受信した日付。 -
MemberStatus: string
タイトル:
Member Status最大長:30デフォルト値:ORA_SENTキャンペーン・メンバーのステータス。 -
MemberStatusLookupMeaning: string
タイトル:
Member Status読取り専用:true最大長:80キャンペーン・メンバーのステータスに対する表示ラベル。 -
SourceSystemCampMemberId: string
タイトル:
Source System Campaign Member ID最大長:100ソース・システム内のキャンペーン・メンバーの一意の識別子。 -
UpdateFlag: boolean
タイトル:
Can Be Updated読取り専用:trueログイン・ユーザーがキャンペーン・メンバーを更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- CampaignStatusVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STATUS
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CampaignStatus;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- CampaignTypeVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_TYPE
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CampaignType;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- CreatedByModuleVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMP_CREATED_BY_MOD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CreatedByModule;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- CurrencyCodeVA
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
- 表示属性: 名前
- MemberStatusVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPMEMBER_STATUS
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: MemberStatus;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ: