機械翻訳について

ジャンプ先

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

リード競合相手の作成

post

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

リクエスト

パス・パラメータ

• 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

ソースを表示

• Comments: string
  タイトル: Comments

  最大長: 2000

  見込み客に関連付けられている競合相手のコメントを示します。
• CompetitorPartyId: integer (int64)
  タイトル: Competitor Party ID

  競合相手の一意の識別子。
• LeadCompetitorId: integer (int64)
  タイトル: Lead Competitor ID

  リード競合相手の一意の識別子。
• LeadCompetitorNumber: string
  タイトル: Lead Competitor Number

  最大長: 30

  リード競合相手の代替識別子。 この表の公開サロゲート・キー。
• LeadId: integer (int64)
  タイトル: Lead Identifier

  リードの一意の識別子。
• LeadNumber: string
  タイトル: Lead Number

  最大長: 30

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

  競合相手がリードのプライマリかどうかを示します。
• ThreatLevelCode: string
  タイトル: Threat Level Code

  最大長: 30

  見込み客に関連付けられている競合会社の脅威レベルを示します。

{
    "type":"object",
    "properties":{
        "CompetitorPartyId":{
            "title":"Competitor Party ID",
            "type":"integer",
            "description":"The unique identifier of the competitor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            }
        },
        "LeadCompetitorId":{
            "title":"Lead Competitor ID",
            "type":"integer",
            "description":"The unique identifier of the lead competitor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryFlag":{
            "title":"PrimaryFlag",
            "type":"boolean",
            "description":"Indicates whether the competitor is a primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CompetitorPartyId"
                ]
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Indicates the comments of the competitor associated with the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadCompetitorNumber":{
            "title":"Lead Competitor Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the lead competitor. Public surrogate key for this table.",
            "nullable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":true
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ThreatLevelCode":{
            "title":"Threat Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the threat level of the competitor associated with the lead.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• Comments: string
  タイトル: Comments

  最大長: 2000

  見込み客に関連付けられている競合相手のコメントを示します。
• CompetitorPartyId: integer (int64)
  タイトル: Competitor Party ID

  競合相手の一意の識別子。
• CompetitorPartyName: string
  タイトル: Competitor Party Name

  読取り専用: true

  最大長: 360

  見込み客の競合会社の名前。
• CompetitorPartyNumber: string
  タイトル: Competitor Party Number

  読取り専用: true

  最大長: 30

  リードの競合相手の代替識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  見込み客競合会社レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

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

  読取り専用: true

  見込み客競合会社データが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  見込み客競合会社レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  営業リード競合相手レコードを最後に更新したユーザーのログイン。
• LeadCompetitorId: integer (int64)
  タイトル: Lead Competitor ID

  リード競合相手の一意の識別子。
• LeadCompetitorNumber: string
  タイトル: Lead Competitor Number

  最大長: 30

  リード競合相手の代替識別子。 この表の公開サロゲート・キー。
• LeadId: integer (int64)
  タイトル: Lead Identifier

  リードの一意の識別子。
• LeadNumber: string
  タイトル: Lead Number

  最大長: 30

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

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

  競合相手がリードのプライマリかどうかを示します。
• ThreatLevelCode: string
  タイトル: Threat Level Code

  最大長: 30

  見込み客に関連付けられている競合会社の脅威レベルを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lead competitor record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompetitorPartyId":{
            "title":"Competitor Party ID",
            "type":"integer",
            "description":"The unique identifier of the competitor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadCompetitorId":{
            "title":"Lead Competitor ID",
            "type":"integer",
            "description":"The unique identifier of the lead competitor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the lead competitor record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"PrimaryFlag",
            "type":"boolean",
            "description":"Indicates whether the competitor is a primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CompetitorPartyId"
                ]
            },
            "x-queryable":true
        },
        "CompetitorPartyName":{
            "title":"Competitor Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the competitor of the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Indicates the comments of the competitor associated with the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadCompetitorNumber":{
            "title":"Lead Competitor Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the lead competitor. Public surrogate key for this table.",
            "nullable":false,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorPartyNumber":{
            "title":"Competitor Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for competitor of the lead.",
            "nullable":false,
            "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 Identifier",
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ThreatLevelCode":{
            "title":"Threat Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the threat level of the competitor associated with the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the lead competitor data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the sales lead competitor record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

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

リンク

CompetitorThreatLevelVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL%2CBindLookupCode%3D{ThreatLevelCode}

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

「トップに戻る」