機械翻訳について

すべてのアカウント・ロールアップの取得

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup

リクエスト

パス・パラメータ
  • アカウント・パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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 :指定した主キーでアカウント・ロールアップを検索します。
      ファインダ変数:
      • OrganizationProfileId :組織プロファイルの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CallsMade; number;アカウントに対して行われたコールの合計数
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • EmailsSent; number;アカウントに送信された電子メールの合計数。
    • HierCallsMade; number;アカウントおよびアカウントの階層に対して行われたコールの合計数。
    • HierCurrentFiscalYearPotentialRevenueAmount; number;アカウント階層内の現在の会計年度のすべての潜在的収益の累積合計。
    • HierEmailsSent; number;アカウントおよびアカウントの階層に送信されたEメールの合計数。
    • HierEmployeesTotal; number;各アカウント階層の従業員のアカウント番号に基づく従業員の数。
    • HierLastCallMadeDate; string; アカウントおよびアカウントの階層に対して最後のコールが行われた日付。
    • HierLastCompletedActivity; string;アクティビティが最後にアカウントとその階層で完了した日付。 活動には、タスク、ポイント、およびコール・レポートが含まれます。
    • HierLastEmailSentDate; string; 最後のEメールがアカウントおよびアカウントの階層に送信された日付。
    • HierLastTouchDate; string;アカウントとアカウントの階層で最後のタッチが行われた日付。
    • HierNextTaskDue; string; アカウントとその階層を持つタスクの期日。
    • HierNumberOfOpenActivities; number;アカウント階層内でオープンしているアクティビティの数。
    • HierNumberOfOpenCriticalServiceRequests; number;重大度が1である、アカウント階層内のオープン・サービス・リクエストの数。
    • HierNumberOfOpenHotLeads; number;ホット・ランクでオープンしているリードの階層数。
    • HierNumberOfOpenLeads; number;アカウント階層内のオープン・ステータスのリードの数。
    • HierNumberOfOpenOpportunities; number;アカウント階層内でオープンしている商談の数。
    • HierNumberOfOpenServiceRequests; number;アカウント階層のオープン・サービス・リクエストの数。
    • HierNumberOfTouches; number;アカウントおよびアカウントの階層との連絡の合計数。 タッチとは、Eメール、電話などのアウトバウンド通信を指します。
    • HierSumOfActiveSubscriptionsMRR; number;アカウントおよびその階層のアクティブなサブスクリプション明細からの累積月次経常収益。
    • HierSumOfActiveSubscriptionsTCV; number;アカウントおよびその階層のアクティブなサブスクリプション明細の累積合計契約額。
    • HierSumOfClosedSubscriptionsMRR; number;特定の期間にクローズされた、アカウントおよびその階層のサブスクリプション明細からの累積月次経常収益。
    • HierSumOfLapsedRenewalsMRR; number;更改明細がないアカウントおよびその階層の失効済サブスクリプション明細からの累積月次経常収益。
    • HierSumOfOpenLeadAmount; number;アカウントの適格および不適格なオープン・リードとアカウントの階層からの潜在的収益の合計。
    • HierSumOfOpenOpportunitiesRevenue; number;アカウント階層内のオープン商談の潜在的売上金額の累積合計。
    • HierSumOfOpenOrderAmount; number;ステータスがオープンまたは処理中である、アカウント階層内の見積およびオーダー金額の累積合計。
    • HierSumOfUpcomingRenewalsMRR; number;アカウントの失効間近のサブスクリプション明細とその階層から、修正、クローズ、休止または更改されていない累積月次経常収益。
    • HierSumOfWonOpportunitiesRevenue; number;アカウント階層内の受注済商談の潜在的売上金額の累積合計。
    • HierSumOfWonOrderAmount; number;ステータスがクローズ済である、アカウント階層内のオーダーの合計。
    • HierTotalCompletedActivities; number;アカウントとその階層を持つ完了したアクティビティの合計数。
    • LastCallMadeDate; string; アカウントに対して最後にコールされた日付。
    • LastCompletedActivity; string;アクティビティがアカウントで最後に完了した日付。 活動には、タスク、ポイント、およびコール・レポートが含まれます。
    • LastEmailSentDate; string; 最後の電子メールがアカウントに送信された日付。
    • LastTouchDate; string; 最後の電子メールがアカウントに送信された日付。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • NextTaskDue; string;アカウントを持つタスクの期日。
    • NumberOfOpenActivities; number;アカウント内でオープンしているアクティビティの数。
    • NumberOfOpenCriticalServiceRequests; number;重大度が1であるアカウントのオープン・サービス・リクエストの数。
    • NumberOfOpenHotLeads; number;ホット・ランクでオープンしているリードの数。
    • NumberOfOpenLeads; number;アカウントでオープンしているリードの数。
    • NumberOfOpenOpportunities; number;アカウント内のオープン商談数。
    • NumberOfOpenServiceRequests; number;アカウントのオープン・サービス・リクエストの数。
    • NumberOfTouches; number;アカウントとの連絡の合計数。 タッチとは、Eメール、電話などのアウトバウンド通信を指します。
    • OrganizationProfileId; integer;組織プロファイルの一意の識別子。
    • SumOfActiveSubscriptionsMRR; number;アカウントのアクティブなサブスクリプション・ラインからの累積月次経常収益。
    • SumOfActiveSubscriptionsTCV; number;アカウントのアクティブなサブスクリプション明細からの累積合計契約額。
    • SumOfClosedSubscriptionsMRR; number;特定の期間にクローズされたアカウントのサブスクリプション明細からの累積月次経常収益。
    • SumOfLapsedRenewalsMRR; number;更改明細がないアカウントの失効済サブスクリプション明細からの累積月次経常収益。
    • SumOfOpenLeadAmount; number;アカウントの適格および不適格なオープン・リードからの潜在的収益の合計。
    • SumOfOpenOpportunitiesRevenue; number;アカウントのオープン商談の潜在的売上金額の累積合計。
    • SumOfOpenOrderAmount; number;ステータスがオープンまたは処理中のアカウントの見積およびオーダー金額の累積合計。
    • SumOfUpcomingRenewalsMRR; number;修正、クローズ、一時停止または更改されていないアカウントの失効間近のサブスクリプション明細からの累積月次経常収益。
    • SumOfWonOpportunitiesRevenue; number;アカウントの受注済商談の潜在的売上金額の累積合計。
    • SumOfWonOrderAmount; number;ステータスがクローズ済であるオーダーのオーダー金額の累積合計。
    • TotalCompletedActivities; number;アカウントで完了したアクティビティの合計数。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-AccountRollup
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accounts-AccountRollup-item-response
タイプ: object
ソースを表示
  • タイトル: Number of Calls Made
    読取り専用: true
    アカウントに対して行われたコールの合計数
  • タイトル: Corporate Currency
    読取り専用: true
    最大長: 15
    勘定科目ロールアップに関連付けられた企業通貨コード(USD、INRなど)。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Number of Emails Sent
    読取り専用: true
    アカウントに送信されたEメールの合計数。
  • タイトル: Hierarchy Number of Calls Made
    読取り専用: true
    アカウントおよびアカウントの階層に対して行われたコールの合計数。
  • タイトル: Hierarchy Current Fiscal Year's Potential Revenue
    読取り専用: true
    勘定科目階層内の現在の会計年度のすべての潜在的収益の累積合計。
  • タイトル: Hierarchy Number of Emails Sent
    読取り専用: true
    アカウントおよびアカウントの階層に送信されたEメールの合計数。
  • タイトル: Hierarchy Total Number of Employees
    読取り専用: true
    各取引先階層の従業員の取引先番号に基づく従業員のカウント。
  • タイトル: Hierarchy Last Call Made
    読取り専用: true
    アカウントおよびアカウントの階層に対して最終コールが行われた日付。
  • タイトル: Hierarchy Last Completed Activity
    読取り専用: true
    活動が最後に取引先とその階層で完了した日付。 活動には、タスク、ポイント、およびコール・レポートが含まれます。
  • タイトル: Hierarchy Last Email Sent
    読取り専用: true
    最終Eメールがアカウントおよびアカウントの階層に送信された日付。
  • タイトル: Hierarchy Last Touch
    読取り専用: true
    アカウントおよびアカウントの階層で最終連絡が行われた日付。
  • タイトル: Hierarchy Next Task Due
    読取り専用: true
    アカウントとその階層を持つタスクの期日。
  • タイトル: Hierarchy Number of Open Activities
    読取り専用: true
    アカウント階層内でオープンしているアクティビティの数。
  • タイトル: Hierarchy Number of Open Critical Service Requests
    読取り専用: true
    重大度が1である、アカウント階層内のオープン・サービス・リクエストの数。
  • タイトル: Hierarchy Number of Open Hot Leads
    読取り専用: true
    ホット・ランクでオープンしているリードの階層数です。
  • タイトル: Hierarchy Number of Open Leads
    読取り専用: true
    アカウント階層内のオープン・ステータスのリード数です。
  • タイトル: Hierarchy Number of Open Opportunities
    読取り専用: true
    アカウント階層内でオープンしている商談の数。
  • タイトル: Hierarchy Number of Open Service Requests
    読取り専用: true
    アカウント階層のオープン・サービス・リクエストの数。
  • タイトル: Hierarchy Number of Touches
    読取り専用: true
    アカウントおよびアカウントの階層との連絡の合計数。 タッチとは、Eメール、電話などのアウトバウンド通信を指します。
  • タイトル: Hierarchy Active Subscriptions MRR Amount
    読取り専用: true
    アカウントおよびその階層のアクティブなサブスクリプション明細からの累積月次経常収益です。
  • タイトル: Hierarchy Active Subscriptions TCV Amount
    読取り専用: true
    アカウントおよびその階層のアクティブなサブスクリプション明細からの累積合計契約額です。
  • タイトル: Hierarchy Closed Subscriptions MRR Amount
    読取り専用: true
    特定の期間にクローズされた、アカウントのサブスクリプション明細とその階層からの累積月次経常収益です。
  • タイトル: Hierarchy Lapsed Renewals MRR Amount
    読取り専用: true
    更改明細がないアカウントおよびその階層の失効済サブスクリプション明細からの累積月次経常収益です。
  • タイトル: Hierarchy Total Potential Revenue from Open Leads
    読取り専用: true
    アカウントの適格および不適格なオープン・リードとアカウントの階層からの潜在的売上の合計。
  • タイトル: Hierarchy Open Opportunity Revenue
    読取り専用: true
    アカウント階層内のオープン商談の潜在的売上金額の累積合計。
  • タイトル: Hierarchy Open Order Amount
    読取り専用: true
    ステータスがオープンまたは処理中である、アカウント階層内の見積およびオーダー金額の累積合計。
  • タイトル: Hierarchy Upcoming Renewals MRR Amount
    読取り専用: true
    修正、クローズ、休止または更改されていないアカウントとその階層の失効間近のサブスクリプション明細からの累積月次経常収益です。
  • タイトル: Hierarchy Won Opportunity Revenue
    読取り専用: true
    アカウント階層内の受注済商談の潜在的売上金額の累積合計。
  • タイトル: Hierarchy Won Order Amount
    読取り専用: true
    ステータスがクローズの取引先階層内のオーダーの合計。
  • タイトル: Hierarchy Total Completed Activities
    読取り専用: true
    取引先とその階層を含む完了した活動の合計数。
  • タイトル: Last Call Made On
    読取り専用: true
    アカウントに最終コールが行われた日付。
  • タイトル: Last Completed Activity
    読取り専用: true
    活動が最後に取引先で完了した日付。 活動には、タスク、ポイント、およびコール・レポートが含まれます。
  • タイトル: Last Email Sent
    読取り専用: true
    最後の電子メールがアカウントに送信された日付。
  • タイトル: Last Touch
    読取り専用: true
    最後の電子メールがアカウントに送信された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Next Task Due
    読取り専用: true
    アカウントがあるタスクの期日。
  • タイトル: Number of Open Activities
    読取り専用: true
    アカウント内でオープンされているアクティビティの数。
  • タイトル: Number of Open Critical Service Requests
    読取り専用: true
    重大度が1であるアカウントのオープン・サービス・リクエストの数。
  • タイトル: Number of Open Hot Leads
    読取り専用: true
    ホット・ランクでオープンしているリードの数。
  • タイトル: Number of Open Leads
    読取り専用: true
    アカウントでオープンしているリードの数。
  • タイトル: Number of Open Opportunities
    読取り専用: true
    アカウント内のオープン商談数。
  • タイトル: Number of Open Service Requests
    読取り専用: true
    アカウントのオープン・サービス・リクエストの数。
  • タイトル: Number of Touches
    読取り専用: true
    アカウントとの連絡の合計数。 タッチとは、Eメール、電話などのアウトバウンド通信を指します。
  • タイトル: Organization Profile Identifier
    読取り専用: true
    組織プロファイルの一意の識別子。
  • タイトル: Active Subscriptions MRR Amount
    読取り専用: true
    アカウントのアクティブなサブスクリプション・ラインからの累積月次経常収益。
  • タイトル: Active Subscriptions TCV Amount
    読取り専用: true
    アカウントのアクティブなサブスクリプション明細の累積合計契約額です。
  • タイトル: Closed Subscriptions MRR Amount
    読取り専用: true
    特定の期間にクローズされたアカウントのサブスクリプション明細からの累積月次経常収益です。
  • タイトル: Lapsed Renewals MRR Amount
    読取り専用: true
    更改明細がないアカウントの失効済サブスクリプション明細からの累積月次経常収益です。
  • タイトル: Total Potential Revenue from Open Leads
    読取り専用: true
    アカウントの適格および不適格なオープン・リードからの潜在的売上の合計。
  • タイトル: Open Opportunity Revenue
    読取り専用: true
    取引先のオープン商談の見込売上額の累積合計。
  • タイトル: Open Order Amount
    読取り専用: true
    ステータスがオープンまたは処理中のアカウントの見積およびオーダー金額の累積合計。
  • タイトル: Upcoming Renewals MRR Amount
    読取り専用: true
    修正、クローズ、休止または更改されていないアカウントの失効するサブスクリプション明細からの累積月次経常収益です。
  • タイトル: Won Opportunity Revenue
    読取り専用: true
    取引先の成約商談の見込み売上額の累積合計。
  • タイトル: Won Order Amount
    読取り専用: true
    ステータスがクローズ済のオーダー金額の累積合計。
  • タイトル: Total Completed Activities
    読取り専用: true
    アカウントありの完了したアクティビティの合計数。
「トップに戻る」