機械翻訳について

サブスクリプションの取得

get

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptions-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 契約添付
タイプ: array
タイトル: Contract Attachments
契約添付リソースは、添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : クレジット・カード情報
タイプ: array
タイトル: Credit Cards
クレジット・カード・リソースは、サブスクリプションに関連付けられたクレジット・カード情報を表示、作成および更新するために使用されます。
ソースを表示
ネストされたスキーマ : 付加フレックスフィールド
タイプ: array
タイトル: Descriptive Flexfields
付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : パーティ
タイプ: array
タイトル: Parties
サブスクリプション・パーティを表示、作成、更新および削除するためのパーティ・リソース。
ソースを表示
ネストされたスキーマ : 製品
タイプ: array
タイトル: Products
製品リソースは、開始日と終了日、品目、単価、金額、請求先詳細、出荷先詳細、請求頻度、請求ルール、支払方法など、サブスクリプションの製品詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 販売実績
タイプ: array
タイトル: Sales Credits
販売実績リソースは、サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : サポート文書添付
タイプ: array
タイトル: Supporting Document Attachments
サポート文書添付リソースは、サポート文書添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : サブスクリプションの検証
タイプ: array
タイトル: Validate Subscriptions
サブスクリプションの検証リソースで、サブスクリプションの検証エラーを表示、作成、更新および削除します。
ソースを表示
ネストされたスキーマ : subscriptions-contractAttachment-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-creditCards-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-flexFields-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-parties-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 担当者
タイプ: array
タイトル: Contacts
サブスクリプション・パーティの担当者を表示、作成、更新および削除するcontactsリソース。
ソースを表示
ネストされたスキーマ : subscriptions-parties-contacts-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 関連アセット
タイプ: array
タイトル: Associated Assets
関連付けられたアセット・リソースは、サブスクリプション・タイプのサブスクリプション製品にリンクされたアセットの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 請求明細
タイプ: array
タイトル: Bill Lines
請求明細リソースは、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料
タイプ: array
タイトル: Charges
手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 対象レベル
タイプ: array
タイトル: Covered Levels
対象レベル・リソースは、サブスクリプション対象レベルを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : クレジット・カード情報
タイプ: array
タイトル: Credit Cards
クレジット・カード・リソースは、サブスクリプションに関連付けられたクレジット・カード情報を表示、作成および更新するために使用されます。
ソースを表示
ネストされたスキーマ : 付加フレックスフィールド
タイプ: array
タイトル: Descriptive Flexfields
付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 関係
タイプ: array
タイトル: Relationships
関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 販売実績
タイプ: array
タイトル: Sales Credits
販売実績リソースは、サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : サービス・リソース
タイプ: array
タイトル: Service Resources
サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-associatedAsset-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-billLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-billLines-billAdjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-charges-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 調整
タイプ: array
タイトル: Adjustments
調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ: array
タイトル: Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ: array
タイトル: Charge Tiers
手数料階層リソースは、サブスクリプションのサブスクリプション手数料階層詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-charges-adjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-charges-chargeMilestoneEvents-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-charges-chargeTiers-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求明細
タイプ: array
タイトル: Bill Lines
請求明細リソースは、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料
タイプ: array
タイトル: Charges
手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 子対象レベル
タイプ: array
タイトル: Child Covered Levels
子対象レベル・リソースは、サブスクリプションの子対象レベルを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 関係
タイプ: array
タイトル: Relationships
関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-billLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-billLines-billAdjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-charges-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 調整
タイプ: array
タイトル: Adjustments
調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ: array
タイトル: Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ: array
タイトル: Charge Tiers
手数料階層リソースは、サブスクリプションのサブスクリプション手数料階層詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-charges-adjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-charges-chargeTiers-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-childCoveredLevels-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-coveredLevels-relationships-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-creditCards-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-flexFields-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-relationships-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-salesCredits-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-products-serviceResources-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-salesCredits-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-supportingDocumentAttachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptions-validateSubscription-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/subscriptions/GP-5678

レスポンス本文の例

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

{
    "SubscriptionId": 300100177254423,
    "SubscriptionNumber": "GP-5678",
    "BusinessUnitId": 204,
    "BusinessUnitName": "Vision Operations",
    "LegalEntityId": 204,
    "LegalEntityName": "Vision Operations",
    "SubscriptionProfileId": 300100172161473,
    "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
    "PrimaryPartyId": 1001,
    "PrimaryPartyName": "A T & T SOLUTIONS INC",
    "PricedOnDate": "2019-06-04T00:00:00+00:00",
    "PricingStrategyId": null,
    "PricingStrategyExplanation": null,
    "PricingSegment": null,
    "PricingSegmentExplanation": null,
    "SegmentExplanationMessage": null,
    "Currency": "USD",
    "CurrencyName": "US Dollar",
    "CurrencyConversionRate": null,
    "CurrencyConversionRateType": null,
    "CurrencyConversionRateDate": null,
    "StartDate": "2019-01-01",
    "Duration": 359,
    "Period": "DY",
    "EndDate": "2019-12-25",
    "DefinitionOrganizationId": 204,
    "PartialPeriodType": "ORA_ACTUAL",
    "PartialPeriodStart": "ORA_SERVICE",
    "CloseReason": null,
    "ClosedDate": null,
    "CloseCreditMethod": null,
    "ApprovalNote": null,
    "CancelReason": null,
    "CanceledDate": null,
    "ApprovedDate": null,
    "RenewedDate": null,
    "ShortDescription": null,
    "Description": null,
    "Status": "ORA_DRAFT",
    "UserStatus": null,
    "BillService": "ORA_BILL",
    "BillServiceName": "Bill",
    "InvoicingRuleId": -2,
    "InvoicingRuleName": "Advance Invoice",
    "BillingDateCode": "ORA_PERIOD_START",
    "BillingDateName": "Period start",
    "BillOnDay": null,
    "BillingOffsetDays": null,
    "BillingFrequency": "0zG",
    "BillingFrequencyName": "MONTH",
    "AccountingRuleId": 300100033038413,
    "AccountingRuleName": "3 Months, Deferred",
    "TransactionTypeName": "ORA_OSS_Invoice",
    "BillingSystem": null,
    "SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
    "CoverageInvoiceText": null,
    "BillToAccountId": 1001,
    "BillToAccountNumber": "1001",
    "BillToAccountDescription": "A T & T SOLUTIONS INC",
    "BillToSiteUseId": 1006,
    "BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
    "ShipToParty": null,
    "ShipToPartyName": null,
    "ShipToPartySiteId": null,
    "ShipToSite": null,
    "PaymentMethod": null,
    "PaymentMethodName": null,
    "PONumber": null,
    "WireNumber": null,
    "PaymentTermsId": 1064,
    "PaymentTermsName": "Immediate",
    "TaxClassificationCode": null,
    "TaxClassificationMeaning": null,
    "ExemptCertificateNumber": null,
    "ExemptReason": null,
    "ExemptReasonMeaning": null,
    "TaxExemptionHandling": "S",
    "TaxExemptionHandlingName": "Standard",
    "DocumentFiscalClassification": null,
    "CustomerAcceptance": null,
    "InternalApproval": "REQUIRED",
    "LayoutTemplate": null,
    "CommunicationChannel": null,
    "PrimarySalesPerson": null,
    "NegotiationLanguage": null,
    "QuoteToContactId": null,
    "EnableRenewalRemindersFlag": null,
    "RenewalProcess": null,
    "DaysBeforeExpiry": null,
    "QuoteToCcEmail": null,
    "RenewalPricingMethodUsed": null,
    "RenewalProcessUsed": null,
    "PriceAdjustmentPercentUsed": null,
    "DaysBeforeExpiryUsed": null,
    "AssigneeId": null,
    "AssigneeType": null,
    "TotalContractValue": null,
    "EstimatedTax": null,
    "CreditedAmount": null,
    "ClosedAmount": null,
    "CanceledAmount": null,
    "InvoicedAmount": null,
    "SourceSystem": null,
    "SourceKey": null,
    "SourceNumber": null,
    "RenewalTemplateId": null,
    "NotificationTemplateId": null,
    "RenewalSubscriptionProfileId": null,
    "DefaultLanguage": null,
    "GenerateBillingSchedule": null,
    "TransactionType": "ORA_SUBSCRIPTION",
    "PricingSystem": "ORA_FUSION",
    "PricingError": null,
    "CorpCurrencyCode": "USD",
    "CurcyConvRateType": "Corporate",
    "RenewalCustomerAcceptance": null,
    "RenewalInternalApproval": null,
    "RenewalPriceAdjustmentBasis": null,
    "RenewalPriceAdjustmentPercent": null,
    "RenewalPriceAdjustmentType": null,
    "AttachmentEntityName": "OSS_DOC_SUBSCRIPTION_AGREEMENT",
    "AttachmentEntityName1": "OSS_DOC_SUPPORTING_DOCUMENTS",
    "CreatedBy": "CONMGR",
    "CreationDate": "2019-06-04T04:25:03+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2019-06-04T04:29:14+00:00",
    "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
    ...
}
「トップに戻る」