機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アカウント
  4. 勘定科目階層要約

すべての勘定科目階層要約の取得

get

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

リクエスト

パス・パラメータ
  • アカウント・パーティの一意の代替識別子。 プロファイル・オプション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 :主キーを使用して勘定科目階層要約を検索します。
      ファインダ変数:
      • PartyId :アカウント階層に関連付けられたパーティの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ParentAccountName; string;指定されたアカウントの親アカウント名。
    • ParentAccountPartyId; integer;指定されたアカウントの親アカウント識別子。
    • ParentAccountPartyNumber; string;指定されたアカウントの親アカウント・レジストリ識別子。
    • PartyId; integer; 指定されたアカウントに関連付けられたパーティの一意の識別子。
    • UltimateParentName; string;指定されたアカウントの最終的な親アカウント名。
    • UltimateParentPartyId; integer;指定されたアカウントの最終親アカウント識別子。
    • UltimateParentPartyNumber; string;指定されたアカウントの最終親アカウント・レジストリ識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-AccountHierarchySummary
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accounts-AccountHierarchySummary-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アカウント階層要約を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    勘定科目階層要約が作成された日時。
  • タイトル: Last Update Date
    読取り専用: true
    勘定科目階層要約が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アカウント階層要約を最後に更新したユーザー。
  • Links
  • タイトル: Parent Account List
    読取り専用: true
    最大長: 4000
    勘定科目階層の最上位ノードまでのすべての親アカウントのリストです。
  • タイトル: Parent Account Name
    読取り専用: true
    最大長: 360
    指定されたアカウントの親アカウント名。
  • タイトル: Parent Account ID
    読取り専用: true
    指定されたアカウントの親アカウント識別子。
  • タイトル: Parent Account Registry ID
    読取り専用: true
    最大長: 30
    指定されたアカウントの親アカウント登録識別子。
  • タイトル: Party ID
    読取り専用: true
    指定されたアカウントに関連付けられたパーティの一意の識別子。
  • タイトル: Descendant Count
    読取り専用: true
    子アカウントの合計数。
  • タイトル: Immediate Child Count
    読取り専用: true
    指定されたアカウントの直接の子の合計数。
  • タイトル: Ultimate Parent Name
    読取り専用: true
    最大長: 360
    指定されたアカウントの最終親アカウント名。
  • タイトル: Ultimate Parent ID
    読取り専用: true
    指定されたアカウントの最終親アカウント識別子。
  • タイトル: Ultimate Parent Registry ID
    読取り専用: true
    最大長: 30
    指定されたアカウントの最終親アカウント登録識別子。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのアカウント階層サマリーを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000014983187/child/AccountHierarchySummary

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "items": [
        {
            "PartyId": 100000014983188,
            "ParentAccountPartyId": null,
            "ParentAccountPartyNumber": null,
            "ParentAccountName": null,
            "UltimateParentPartyId": 100000014983188,
            "UltimateParentPartyNumber": "100000014983187",
            "UltimateParentName": "OBIA Enterprise",
            "TotalChildAccounts": 50,
            "TotalImmediateChildAccounts": 6,
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "CreationDate": "2023-03-01T00:05:30.159+00:00",
            "LastUpdateDate": "2023-03-01T00:05:30.159+00:00",
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ParentAccountList": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000014983187/child/AccountHierarchySummary/100000014983188",
                    "name": "AccountHierarchySummary",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000014983187/child/AccountHierarchySummary/100000014983188",
                    "name": "AccountHierarchySummary",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000014983187",
                    "name": "accounts",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000014983187/child/AccountHierarchySummary",
            "name": "AccountHierarchySummary",
            "kind": "collection"
        }
    ]
}
「トップに戻る」