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

すべての価格表を取得

get

/crmRestApi/resources/11.13.18.05/priceBookHeaders

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 主キーによるPricebookを検索します。
      ファインダ変数:
      • PricebookId; integer; PricebookIdを使用してPricebookを検索します。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CurrencyCode; string;価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • DefaultPricebookFlag; boolean;通貨のデフォルト価格台帳かどうかを示します。
    • DeleteFlag; boolean;価格台帳を削除できるかどうかを示します。 デフォルト値はtrueです。
    • 説明;文字列;価格台帳の簡単な説明。
    • HeaderExternalKey; string; 価格台帳の外部キー値。
    • HeaderExternalSource; string; 価格台帳の外部キーのソース。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • 名前;文字列;価格台帳の名前。
    • PricebookCode; string; 価格表を示すコード。 この値は、価格表の作成時に自動生成されます。
    • PricebookId; integer; 価格台帳の一意の識別子。
    • StatusCode; string; 価格台帳のステータスを示すコード。 たとえば、ドラフト、アクティブまたは失効済です。
    • UpdateFlag; boolean;価格台帳を更新できるかどうかを示します。 デフォルト値はtrueです。


    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CurrencyCode; string;価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
    • InvItemId; integer; 価格台帳で選択されたアイテムの一意の識別子。
    • InvOrgId; integer; 価格台帳で選択した品目に関連付けられた在庫組織の一意の識別子。
    • ItemExternalKey; string;価格台帳品目の外部キー値。
    • ItemExternalSource; string;価格台帳品目の外部キーのソース。
    • ItemNumber; string;価格台帳金額の項目。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_ITEMで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • ListPrice; number;アイテムの価格。
    • PriceUOMCode; string;アイテムの測定単位。
    • PricebookCode;文字列
    • PricebookId; integer; 価格台帳の一意の識別子。
    • PricebookItemId; integer; 価格表アイテムの一意の識別子。


    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • LookupCode; string; FND参照のタイプを示すコード。 有効な値のリストは、参照ORA_QSC_PRICE_BOOK_STATUSで定義されます。
    • LookupType; string; FND参照のタイプ。
    • 内容;文字列;参照の意味。
    • タグ;文字列
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : priceBookHeaders
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : 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
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

    {
       "items":
       [
           {
               "PricebookId": 300100036945808,
               "PricebookCode": "495ac644-2eaf-4478-9a5e-def69ffe9835",
               "CurrencyCode": "USD",
               "Name": "11111qqqqqrrr",
               "Description": null,
               "StatusCode": "ACTIVE",
               "CustomAttr_c": null,
               "TestSearch_c": null,
               "TestAttr_c": null,
               "links":
             
                   . . .
           }
       ]
    }
「トップに戻る」