Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

アカウント階層要約の取得

get

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

リクエスト

パス・パラメータ

PartyId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=
PartyNumber(required): string

アカウント・パーティの一意の代替識別子。プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。非アクティブなレコードは更新できません。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : accounts-AccountHierarchySummary-item-response

タイプ: object

ソースを表示

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

アカウント階層要約を最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Parent Account List

読取り専用: true

最大長: 4000

勘定科目階層の最上位ノードまでのすべての親アカウントのリストです。
ParentAccountName: string

タイトル: Parent Account Name

読取り専用: true

最大長: 360

指定されたアカウントの親アカウント名。
ParentAccountPartyId: integer (int64)

タイトル: Parent Account ID

読取り専用: true

指定されたアカウントの親アカウント識別子。
ParentAccountPartyNumber: string

タイトル: Parent Account Registry ID

読取り専用: true

最大長: 30

指定されたアカウントの親アカウント登録識別子。
PartyId: integer (int64)

タイトル: Party ID

読取り専用: true

指定されたアカウントに関連付けられたパーティの一意の識別子。
TotalChildAccounts: 整数(int32)

タイトル: Descendant Count

読取り専用: true

子アカウントの合計数。
TotalImmediateChildAccounts: 整数(int32)

タイトル: Immediate Child Count

読取り専用: true

指定されたアカウントの直接の子の合計数。
UltimateParentName: string

タイトル: Ultimate Parent Name

読取り専用: true

最大長: 360

指定されたアカウントの最終親アカウント名。
UltimateParentPartyId: integer (int64)

タイトル: Ultimate Parent ID

読取り専用: true

指定されたアカウントの最終親アカウント識別子。
UltimateParentPartyNumber: string

タイトル: Ultimate Parent Registry ID

読取り専用: true

最大長: 30

指定されたアカウントの最終親アカウント登録識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the account hierarchy summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the account hierarchy summary was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the account hierarchy summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentAccountList":{
            "title":"Parent Account List",
            "maxLength":4000,
            "type":"string",
            "description":"List of all the parent accounts till the top node in the account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UltimateParentPartyNumber":{
            "title":"Ultimate Parent Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The ultimate parent account registry identifier of given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAccountName":{
            "title":"Parent Account Name",
            "maxLength":360,
            "type":"string",
            "description":"The parent account name of the given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UltimateParentPartyId":{
            "title":"Ultimate Parent ID",
            "type":"integer",
            "description":"The ultimate parent account identifier of given account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated to the given account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentAccountPartyNumber":{
            "title":"Parent Account Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The parent account registry identifier of given account.",
            "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"
            }
        },
        "TotalChildAccounts":{
            "title":"Descendant Count",
            "type":"integer",
            "description":"The total number of child accounts.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":8
            }
        },
        "ParentAccountPartyId":{
            "title":"Parent Account ID",
            "type":"integer",
            "description":"The parent account identifier of the given account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UltimateParentName":{
            "title":"Ultimate Parent Name",
            "maxLength":360,
            "type":"string",
            "description":"The ultimate parent account name of given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalImmediateChildAccounts":{
            "title":"Immediate Child Count",
            "type":"integer",
            "description":"Total number of immediate child of given account.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":8
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the account hierarchy summary was last updated.",
            "format":"date-time",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、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/100000014983188

レスポンス本文の例

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

{
    "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"
        }
    ]
}

「トップに戻る」