機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

リード・キャンペーンの作成

post

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns

リクエスト

パス・パラメータ

• leadsUniqID(required): string
  これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• CampaignId: integer (int64)
  タイトル: Campaign ID

  キャンペーンの一意の識別子。
• CampaignNumber: string
  タイトル: Campaign Number

  最大長: 30

  キャンペーン番号の代替識別子。
• LeadCampaignNumber: string
  タイトル: Lead Campaign Number

  最大長: 30

  リード・キャンペーンの代替識別子。 この表の公開サロゲート・キー。
• LeadId: integer (int64)
  タイトル: Lead ID

  リードの一意の識別子。 リード・ヘッダーへの参照キーです。
• LeadNumber: string
  タイトル: Lead Number

  最大長: 30

  現在のリードの代替識別子。
• PrimaryFlag: boolean
  タイトル: Primary

  キャンペーンがリードに対してプライマリかどうかを示します。

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the campaign is primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CampaignId"
                ]
            }
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"campaigns"
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the campaign number.",
            "nullable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for the current lead.",
            "nullable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead. It is the reference key to lead header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadCampaignNumber":{
            "title":"Lead Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the lead campaign. Public surrogate key for this table.",
            "nullable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : leads-LeadCampaigns-item-response

タイプ: object

ソースを表示

• CampaignEndDate: string (date-time)
  タイトル: End Date

  読取り専用: true

  マーケティング統合キャンペーンが終了する日付。
• CampaignId: integer (int64)
  タイトル: Campaign ID

  キャンペーンの一意の識別子。
• CampaignName: string
  タイトル: Campaign Name

  読取り専用: true

  最大長: 100

  現在のリードが属するキャンペーン。
• CampaignNumber: string
  タイトル: Campaign Number

  最大長: 30

  キャンペーン番号の代替識別子。
• CampaignStartDate: string (date-time)
  タイトル: Start Date

  読取り専用: true

  マーケティング統合キャンペーンが開始する日付。
• CampaignStatus: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  デフォルト値: ORA_DRAFT

  マーケティング統合キャンペーンのステータス。
• CampaignType: string
  タイトル: Type

  読取り専用: true

  最大長: 30

  マーケティング統合キャンペーンのタイプ。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  見込み客キャンペーン・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  このレコードが作成された日時。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  リード・キャンペーン・データが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  見込み客キャンペーン・レコードを最後に更新したユーザー。
• LeadCampaignId: integer (int64)
  タイトル: Lead Campaign ID

  読取り専用: true

  リード・キャンペーンの一意の識別子。
• LeadCampaignNumber: string
  タイトル: Lead Campaign Number

  最大長: 30

  リード・キャンペーンの代替識別子。 この表の公開サロゲート・キー。
• LeadId: integer (int64)
  タイトル: Lead ID

  リードの一意の識別子。 リード・ヘッダーへの参照キーです。
• LeadNumber: string
  タイトル: Lead Number

  最大長: 30

  現在のリードの代替識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PrimaryFlag: boolean
  タイトル: Primary

  キャンペーンがリードに対してプライマリかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lead campaign record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the lead campaign record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when marketing integration campaign starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of marketing integration campaign.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the campaign is primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CampaignId"
                ]
            },
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign Name",
            "maxLength":100,
            "type":"string",
            "description":"The campaign to which the current lead belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for the current lead.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadCampaignId":{
            "title":"Lead Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the lead campaign.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadCampaignNumber":{
            "title":"Lead Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the lead campaign. Public surrogate key for this table.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"campaigns"
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the campaign number.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when marketing integration campaign ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead. It is the reference key to lead header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the lead campaign data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of marketing integration campaign.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

CampaignStatusVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STATUS

参照リソースは、標準参照コードの表示に使用されます。

CampaignTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_TYPE

参照リソースは、標準参照コードの表示に使用されます。

「トップに戻る」