機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 価格表ヘッダー

価格表を取得

get

/crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

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

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : priceBookHeaders-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Currency
    最大長: 15
    価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Default Price Book
    最大長: 1
    デフォルト値: false
    通貨のデフォルト価格台帳であるかどうかを示します。
  • 読取り専用: true
    価格台帳を削除できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Description
    最大長: 1999
    価格台帳の簡単な説明。
  • タイトル: Header External Key
    最大長: 120
    価格台帳の外部キー値。
  • タイトル: Header External Source
    最大長: 120
    デフォルト値: PB_HEADER
    価格台帳の外部キーのソース。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 150
    価格台帳の名前。
  • タイトル: Price Book Code
    最大長: 80
    価格台帳を示すコード。 この値は、価格表の作成時に自動生成されます。
  • タイトル: Price Book ID
    価格台帳の一意の識別子。
  • Price Book Items
    タイトル: Price Book Items
    価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。
  • タイトル: Status
    最大長: 30
    デフォルト値: DRAFT
    価格台帳のステータスを示すコード。 たとえば、ドラフト、アクティブまたは失効済です。
  • Status Search
    タイトル: Status Search
    ステータス検索リソースを使用すると、価格表のステータスを検索できます。
  • 読取り専用: true
    価格台帳を更新できるかどうかを示します。 デフォルト値はtrueです。
ネストされたスキーマ : 価格表アイテム
タイプ: array
タイトル: Price Book Items
価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。
ソースを表示
ネストされたスキーマ : ステータス検索
タイプ: array
タイトル: Status Search
ステータス検索リソースを使用すると、価格表のステータスを検索できます。
ソースを表示
ネストされたスキーマ : priceBookHeaders-PriceBookItem-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • 読取り専用: true
    レコードが作成された日付。
  • 最大長: 15
    価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Inventory Item ID
    価格台帳で選択された品目の一意の識別子。
  • 価格台帳で選択された品目に関連付けられた在庫組織の一意の識別子。
  • タイトル: Name
    価格台帳品目の簡単な摘要。
  • タイトル: External Key
    最大長: 120
    価格台帳品目の外部キー値。
  • タイトル: External Source
    最大長: 120
    デフォルト値: PB_LINE
    価格台帳品目の外部キーのソース。
  • 読取り専用: true
    最大長: 300
    価格台帳金額の品目。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_ITEMで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
  • 読取り専用: true
    レコードが最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: List Price
    デフォルト値: 0
    品目の価格。
  • タイトル: Price Book Code
    最大長: 80
  • 価格台帳の一意の識別子。
  • 価格台帳品目の一意の識別子。
  • タイトル: UOM
    最大長: 30
    品目の単位。
ネストされたスキーマ : priceBookHeaders-StatusSearchLovVA-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: Lookup Code
    読取り専用: true
    最大長: 30
    FND参照のタイプを示すコード。 有効な値のリストは、参照ORA_QSC_PRICE_BOOK_STATUSで定義されます。
  • タイトル: Lookup Type
    読取り専用: true
    最大長: 30
    FND参照のタイプ。
  • タイトル: Meaning
    読取り専用: true
    最大長: 80
    参照の意味。
  • タイトル: Tag
    読取り専用: true
    最大長: 150
リンク
PriceBookItem
パラメータ:
  • priceBookHeaders_Id: $request.path.priceBookHeaders_Id
価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。
StatusCodeLovForUIVA
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_QSC_PRICE_BOOK_STATUS
価格台帳に関連付けられた様々なステータス・コードのリスト。 この属性の最大値は30です。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: StatusCode;ターゲット属性: LookupCode
  • 表示属性: 意味
StatusSearchLovVA
パラメータ:
  • priceBookHeaders_Id: $request.path.priceBookHeaders_Id
ステータス検索リソースを使用すると、価格表のステータスを検索できます。
YesNoPricebookFlagFndLookupsVA
パラメータ:
  • ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
価格台帳が通貨のデフォルトであるかどうかを示す値リスト。 有効な値はYおよびNです。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: DefaultPricebookFlag;ターゲット属性: LookupCode
  • 表示属性: 意味
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、価格表ヘッダーを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/priceBookHeaders/300100061946491

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "PricebookId" : 300100061946491,
  "PricebookCode" : "6cc41c03-bad9-4580-9323-85578dbf5a0f",
  "CurrencyCode" : "USD",
  "Name" : "HG-PB",
  "Description" : "HG-PB\n",
  "StatusCode" : "ACTIVE",
  "Ptest1_c" : null,
  "links" : [ {
    . . .
  } ]
}
「トップに戻る」