機械翻訳について

すべてのリード・チーム・メンバーの取得

get

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

リクエスト

パス・パラメータ
  • これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定した主キーを持つリード・チームを検索します。
      ファインダ変数:
      • LeadTeamId; integer;リード・チームの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccessLevelCode; string; リソース階層内の組織のリード・チーム・メンバー、マネージャおよび管理者に付与されるアクセス・レベル。
    • AddedOnDateTime; string;リソースがリード・リソースに追加された日付またはテリトリがリード・テリトリに追加された日付に基づく、リード・チーム・メンバーの作成日時。
    • City; string;リソースの市。
    • ConflictId; integer;競合識別子。
    • Country; string;リソースの国コード。
    • CreatedBy; string; リード・チーム・メンバーを作成したユーザーのユーザー識別子。
    • CreationDate; string; リード・チーム・メンバーの作成日時。
    • EmailAddress; string; リソースの電子メール・アドレス。
    • FunctionCode; string;リード・チーム・メンバーの機能またはロールのコード。
    • FunctionalRole; string;リード・チーム・メンバーの機能またはロールのコード。
    • LastUpdateDate; string; リード・チームが最後に更新された日付。
    • LastUpdateLogin; string;見込み客チームを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; リード・チームを最後に更新したユーザー。
    • LeadId; integer;リードの一意の識別子。
    • LeadNumber; string;リードの代替の一意の識別子。
    • LeadResourceId; integer;リード・リソースの一意の識別子。
    • LeadTeamId; integer;リード・チームの一意の識別子。
    • PartyId; integer;パーティの一意の識別子。
    • PartyName; string;リソースの名前。
    • PartyNumber; string;リソースの代替識別子。
    • PrimaryFlag; boolean。リード・チーム・メンバーがリードの所有者であるかどうかを示します。
    • PrimaryPhoneNumber;文字列。リソースのプライマリ形式の電話番号。
    • PrimaryPhonePurpose; string;リソースの電話機の主な目的。
    • ResourceId; integer;リード・チーム・メンバーのリソース・パーティ識別子。
    • State; string;リソースの状態。
    • TerritoryFunctionCode; string;テリトリのビジネス機能のコード。
    • TerritoryName; string;テリトリの名前。
    • TerritoryNumber; string;テリトリの番号。
    • TerritoryVersionId; number;テリトリ・ベース割当を介してリードに割り当てられたリソースのテリトリのバージョン識別子。
    • TypeCode; string;テリトリのタイプのコード。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : leads-MklLeadTeam
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : leads-MklLeadTeam-item-response
タイプ: object
ソースを表示
  • タイトル: Access
    読取り専用: true
    最大長: 30
    デフォルト値: FULL
    リソース階層内の組織のリード・チーム・メンバー、マネージャおよび管理者に付与されるアクセス・レベル。
  • タイトル: Join Date
    リソースがリード・リソースに追加された日付またはテリトリがリード・テリトリに追加された日付に基づく、リード・チーム・メンバーの作成日時。
  • タイトル: City
    読取り専用: true
    最大長: 60
    リソースの市区町村。
  • 読取り専用: true
    デフォルト値: 1
    競合識別子。
  • タイトル: Country
    読取り専用: true
    最大長: 2
    リソースの国コード。
  • 読取り専用: true
    最大長: 64
    見込み客チーム・メンバーを作成したユーザーのユーザー識別子。
  • 読取り専用: true
    見込み客チーム・メンバーの作成日時。
  • タイトル: Primary Email
    読取り専用: true
    最大長: 320
    リソースの電子メール・アドレス。
  • タイトル: Primary Phone
    読取り専用: true
    リソースの書式設定された電話番号。
  • タイトル: Function
    読取り専用: true
    最大長: 30
    リード・チーム・メンバーの機能またはロールのコード。
  • タイトル: Function
    読取り専用: true
    最大長: 30
    リード・チーム・メンバーの機能またはロールのコード。
  • 読取り専用: true
    見込み客チームが最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    見込み客チームを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    見込み客チームを最後に更新したユーザーのログイン。
  • リードの一意の識別子。
  • タイトル: Lead Number
    読取り専用: true
    最大長: 30
    リードの代替一意識別子。
  • 読取り専用: true
    リード・リソースの一意の識別子。
  • リード・チームの一意の識別子。
  • Links
  • 読取り専用: true
    見込み客チーム・メンバーが見込み客の所有者であるかどうかを示します。
  • タイトル: Party ID
    読取り専用: true
    パーティの一意識別子
  • タイトル: Name
    読取り専用: true
    最大長: 360
    リソースの名前。
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    リソースの代替識別子。
  • 読取り専用: true
    最大長: 1
    デフォルト値: false
    見込み客チーム・メンバーが見込み客の所有者であるかどうかを示します。
  • 読取り専用: true
    最大長: 40
    リソースのプライマリ書式付き電話番号。
  • タイトル: Role
    読取り専用: true
    最大長: 30
    リソースの電話の主な目的。
  • リード・チーム・メンバーのリソース・パーティ識別子です。
  • 読取り専用: true
    最大長: 255
    リソースのロール名。
  • タイトル: State
    読取り専用: true
    最大長: 60
    リソースの状態。
  • タイトル: Territory Function
    読取り専用: true
    最大長: 30
    テリトリのビジネス機能のコード。
  • タイトル: Territory Name
    読取り専用: true
    最大長: 60
    テリトリの名前。
  • タイトル: Number
    読取り専用: true
    最大長: 30
    テリトリの番号。
  • 読取り専用: true
    リード・チーム・メンバーがテリトリ所有者であるかどうかを示します。
  • テリトリ・ベース割当を介してリードに割り当てられたリソースのテリトリのバージョン識別子。
  • タイトル: Type
    読取り専用: true
    最大長: 30
    デフォルト値: PRIME
    テリトリ・タイプのコード。
「トップに戻る」