機械翻訳について

サブスクリプション製品の入手

get

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

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionProducts-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 関連アセット
タイプ: array
タイトル: Associated Assets
関連付けられたアセット・リソースは、サブスクリプション・タイプのサブスクリプション製品にリンクされたアセットの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 請求明細
タイプ: array
タイトル: Bill Lines
請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料
タイプ: array
タイトル: Charges
手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 対象レベル
タイプ: array
タイトル: Covered Levels
対象レベル・リソースは、サブスクリプションID、サブスクリプション製品ID、対象アセットおよびその関連詳細など、サブスクリプション対象レベル詳細の作成、表示、更新または削除に使用されます。
ソースを表示
ネストされたスキーマ : クレジット・カード情報
タイプ: array
タイトル: Credit Cards
クレジット・カード・リソースは、サブスクリプションに関連付けられているクレジット・カードを表示、作成および更新するために使用されます。
ソースを表示
ネストされたスキーマ : 付加フレックスフィールド
タイプ: array
タイトル: Descriptive Flexfields
付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 関係
タイプ: array
タイトル: Relationships
関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 販売実績
タイプ: array
タイトル: Sales Credits
サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するための販売実績リソースです。
ソースを表示
ネストされたスキーマ : サービス・リソース
タイプ: array
タイトル: Service Resources
サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-associatedAsset-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-billLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-billLines-billAdjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-charges-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 調整
タイプ: array
タイトル: Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ: array
タイトル: Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ: array
タイトル: Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-charges-adjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-charges-chargeMilestoneEvents-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-charges-chargeTiers-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 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
ソースを表示
ネストされたスキーマ : subscriptionProducts-creditCards-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-flexFields-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-relationships-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-salesCredits-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-serviceResources-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-2017

レスポンス本文の例

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

{
  "items": [
    {
      "SubscriptionProductId": 300100182015426,
      "SubscriptionId": 300100181994494,
      "LineNumber": "4",
      "SubscriptionProductPuid": "CDRM_4016-PRDT-2017",
      "DefinitionOrganizationId": 204,
      "SubscriptionNumber": "CDRM_4016",
      "SalesProductType": "SUBSCRIPTION",
      "Description": "QP Item for SPT Subscription",
      "InventoryItemId": 300100012368232,
      "ItemUnitOfMeasure": "Ea",
      "ProductName": "QP_Item3",
      "Quantity": 1,
      "StartDate": "2019-05-30",
      "EndDate": null,
      "CloseReason": null,
      "CloseCreditMethod": null,
      "CancelReason": null,
      "ClosedDate": null,
      "CanceledDate": null,
      "RenewedDate": null,
      "PriceListId": null,
      "UnitPrice": null,
      "Status": "ORA_DRAFT",
      "Currency": "USD",
      "InvoicingRuleId": -3,
      "InvoicingRuleName": "Arrears Invoice",
      "BillOnDay": null,
      "BillingOffsetDays": null,
      "BillingFrequency": "0zG",
      "BillingFrequencyName": "MONTH",
      "AccountingRuleId": 300100033038414,
      "AccountingRuleName": "3 Months",
      "TransactionTypeName": "ORA_OSS_Invoice",
      "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
      "BillToAccountId": 300100006084313,
      "BillToAccountNumber": "300100006084312",
      "BillToAccountDescription": "FOS_Customer01",
      "BillToSiteUseId": 300100006084331,
      "BillToAddress": "151 N Street,CHICAGO, IL 60601",
      "ShipToPartyId": null,
      "ShipToPartyName": null,
      "ShipToPartySiteId": null,
      "ShipToPartySiteName": null,
      "PaymentMethod": null,
      "PaymentMethodName": null,
      "PONumber": null,
      "WireNumber": null,
      "PaymentTermsId": 300100033038407,
      "PaymentTermsName": "2 Net",
      "PrePaymentNumber": null,
      "TaxExemptionHandling": "S",
      "TaxExemptionHandlingName": "Standard",
      "ExemptCertificateNumber": null,
      "ExemptReason": null,
      "OutputTaxClassification": null,
      "ProductFiscClassification": null,
      "TaxError": null,
      "CoverageScheduleId": null,
      "RenewalType": "RENEW",
      "BillingDateCode": "ORA_PERIOD_START",
      "BillingDateName": "Period start",
      "TotalContractValue": null,
      "EstimatedTax": null,
      "PricingError": null,
      "PriceAsOf": "2019-05-31",
      "PriceTransactionOn": "2019-05-31",
      "InvoicedAmount": null,
      "CreditedAmount": null,
      "CanceledAmount": null,
      "ClosedAmount": null,
      "SourceSystem": null,
      "SourceKey": null,
      "SourceNumber": null,
      "SourceLineKey": null,
      "SourceLineNumber": null,
      "MonthlyRecurringRevenue": null,
      "Duration": null,
      "Period": null,
      "GenerateBillingSchedule": null,
      "ExternalAssetKey": null,
      "ExternalParentAssetKey": null,
      "ExternalPriceListId": null,
      "ExternalRootAssetKey": null,
      "PriceListName": null,
      "NextPricingDate": null,
      "PricingTermsStartDate": null,
      "PricingTermsPricingMethod": null,
      "PricingTermsPeriod": null,
      "PricingTermsDuration": null,
      "PricingTermsAdjustmentPCT": null,
      "CorpCurrencyCode": "USD",
      "CurcyConvRateType": "Corporate",
      "AmendCreditMethod": null,
      "AmendCreditMethodName": null,
      "AmendDescription": null,
      "AmendEffectiveDate": null,
      "AmendReason": null,
      "AmendReasonName": null,
      "StatusMeaning": "Draft",
      "EnablePricingTermsFlag": null,
      "TaxClassificationMeaning": null,
      "CreatedBy": "CONMGR",
      "CreationDate": "2019-05-31T20:19:41+00:00",
      "LastUpdatedBy": "CONMGR",
      "LastUpdateDate": "2019-05-31T20:20:17.091+00:00",
      "LastUpdateLogin": "8981B08476560847E0533EFDF40A8CB1",
      "SummarizedBillingFlag": null,
      "InterfaceOffsetDays": null,
      "CoverageName": null,
      "links": ...
	}
「トップに戻る」