機械翻訳について

すべての対象レベルを取得

get

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels

リクエスト

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

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • CoveredLevelPuidAltKey : 指定された代替キーを持つ対象レベルを検索します。
      ファインダ変数:
      • CoveredLevelPuid; string;対象レベルの公開一意識別子。
    • PrimaryKey : 指定した対象レベルIDを持つ対象レベルを検索します。
      ファインダ変数:
      • CoveredLevelId; integer;対象レベルの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AssetGroupId; integer; アセット・グループの一意の識別子。
    • AssetId; integer; アセットの一意の識別子。
    • AssetSerialNumber; string;アセットのシリアル番号。
    • CalculatedCreditAmount; number;対象レベルの計算済貸方金額。
    • CancelDescription; string;対象レベルに関連付けられた取消の説明。
    • CanceledAmount; number;取り消された金額。
    • CloseDescription; string;対象レベルに関連付けられたクローズの説明。
    • ClosedAmount; number;対象レベルがクローズされた金額。
    • CorpCurrencyCode; string; 対象レベルに関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
    • CoveredLevelId; integer;対象レベルの一意の識別子。
    • CoveredLevelPuid; string;対象レベルの公開一意識別子。
    • CreatedBy; string;対象レベルを作成したユーザー。
    • CreationDate; string;対象レベルが作成された日付。
    • CreditedAmount; number;貸方記入された金額。
    • CurcyConvRateType; string;対象レベルに関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
    • CurrencyCode; string; 対象レベルに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CustomerAccountId; integer;顧客アカウントの一意の識別子。
    • EndDate; string;対象レベルが終了する日付。
    • HierarchyTotal; number;階層の合計対象レベル。
    • InventoryItemId; integer; 在庫アイテムの一意の識別子。
    • InvoiceText; string; 請求書に含まれるテキスト。
    • InvoicedAmount; number;請求書が作成された金額。
    • ItemUnitOfMeasure; string;対象レベルのアイテムを測定するために使用される単位。
    • LastUpdateDate; string;対象レベルが最後に更新された日付。
    • LastUpdateLogin; string;対象レベルを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; 対象レベルを最後に更新したユーザー。
    • OverrideCreditAmount; number;対象レベルの上書き貸方金額。
    • ParentCoveredAssetId; integer; 親対象アセットの一意の識別子。
    • ParentCoveredLevelId; integer;親対象レベルの一意の識別子。
    • PartyId; integer;パーティの一意の識別子。
    • PartySiteId; integer;パーティ・サイトの一意の識別子。
    • PriceAsOf; string;特定の日付時点での価格。
    • PriceListId; integer; 価格表の一意の識別子。
    • PriceUnitOfMeasure; string; 価格を示すために使用される単位。
    • PriceUnitOfMeasureName; string;単位の表示名。
    • PricingError; string;価格設定のエラー(ある場合)。
    • ProductGroupId; integer; 製品グループの一意の識別子。
    • 数量;数値;対象レベルの数量。
    • RenewalType; string;対象レベル更新のタイプ。
    • RenewedDate; string;対象レベルが更新された日付。
    • RollupTotal; number;対象レベルのロールアップ合計。
    • SerialNumber; string;対象レベルのシリアル番号。
    • StartDate; string;対象レベルが開始する日付。
    • Status; string;対象レベルのステータス。
    • StatusName; string; 対象レベルのステータスの意味。
    • SubscriptionId; integer; サブスクリプションの一意の識別子。
    • SubscriptionProductId; integer;サブスクリプション製品の一意の識別子。
    • SuppressedCreditAmount; number;抑制されたクレジット金額。
    • SuspendCreditMethod; string; クレジット・メソッドの中断が必要かどうかを示します。
    • TaxAmount; number;トランザクションに課せられた税額。
    • TaxError; string;計算された金額の税金エラー(ある場合)。
    • TotalContractValue; number;対象レベルに関連付けられた合計契約値。
    • Type; string;対象レベルのタイプ。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionProducts-coveredLevels
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求明細
タイプ: array
タイトル: Bill Lines
請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料
タイプ: array
タイトル: Charges
手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 関係
タイプ: array
タイトル: Relationships
関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 調整
タイプ: array
タイトル: Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ: array
タイトル: Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ: array
タイトル: Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-adjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-relationships-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべての対象レベルを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/CDRM_4016-PRDT-2013/child/coveredLevels

レスポンス本文の例

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

{
  "items": [
    {
      "CoveredLevelId": 300100192686410,
      "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
      "SubscriptionProductId": 300100181994505,
      "SubscriptionId": 300100181994494,
      "LineNumber": "1",
      "InventoryItemId": 300100118490672,
      "AssetId": 300100118585763,
      "AssetName": "zOKC_Auto_Asset1",
      "AssetSerialNumber": null,
      "ProductName": "ZOKC_Item_001",
      "Description": "Item",
      "Type": "ORA_ASSET",
      "TypeName": "Asset",
      "Quantity": 1,
      "ItemUnitOfMeasure": "Ea",
      "TotalContractValue": 12361.29,
      "GenerateBillingSchedule": null,
      "EndDate": "2020-05-29",
      "StartDate": "2020-01-01",
      "Duration": 150,
      "Period": "DY",
      "Status": "ORA_DRAFT",
      "StatusName": "Draft",
      "PriceAsOf": "2020-01-01",
      "PriceUnitOfMeasure": "0zE",
      "PriceUnitOfMeasureName": "YEAR",
      "PriceListId": null,
      "PricingError": null,
      "TaxAmount": null,
      "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
      "CancelReason": null,
      "CanceledDate": null,
      "CanceledAmount": null,
      "ClosedDate": null,
      "CloseReason": null,
      "ClosedAmount": null,
      "ReturnCreditMethod": null,
      "SuppressedCreditAmount": null,
      "InvoicedAmount": null,
      "CreditedAmount": null,
      "RenewedDate": null,
      "RenewalType": null,
      "TaxError": null,
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2019-08-20T06:55:15+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2019-08-20T06:55:15.130+00:00",
      "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
      "CurrencyCode": null,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "PutOnHoldFlag": null,
      "RemoveHoldFlag": null,
      "links":
	...
}
「トップに戻る」