機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. サブスクリプション・プロファイル

すべてのサブスクリプション・プロファイルの取得

get

/crmRestApi/resources/11.13.18.05/subscriptionProfiles

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : サブスクリプション・プロファイルIDによるサブスクリプション・プロファイルの検索
      ファインダ変数:
      • SubscriptionProfileId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountingRuleId; integer; 会計基準の一意の識別子。
    • BillService; string; サブスクリプションを請求する必要があるか、更新時に請求する必要があるかを示します。
    • BillingDateCode; string; 請求日を表すコード。 値は、期間開始、期間終了、日およびオフセットです。
    • BillingFrequency; string;請求頻度。 値は月、四半期または年です。
    • BillingOffsetDays; integer;請求日オフセット日数。
    • BillingSystem; string;請求システム。 値は、Oracle Fusionまたはサード・パーティです。
    • CloseCreditMethod; string; サブスクリプションのクローズ時に使用されるクレジット・メソッド。
    • CoverageInvoiceList; object;カバレッジ請求書に含めるアイテムのリスト。
    • CoverageInvoiceText; string;カバレッジ請求書に含めるテキスト。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CreditMemoOption; string; ユーザーが発行するクレジット・メモのタイプ。 有効な値は、請求中、対顧客勘定、混合です。
    • CustomerAcceptance; string; この列は、サブスクリプション更改に顧客の受入が必要かどうかを決定します。
    • DefaultRevenueActionAmend; string; Default Revenue Action Amend
    • DefaultRevenueActionRenew; string; Default Revenue Action Renew
    • EnableProrateByDayYn;文字列。日次レート按分を使用して製品を請求する必要があるかどうかのインジケータ。
    • HeaderNumberPrefix; string; サブスクリプションの自動採番時に使用されるプレフィクス。
    • HeaderNumberSuffix; string;サブスクリプションの自動採番時に使用されるサフィクス。
    • HeaderNumberingMethod; string;サブスクリプションの自動採番を使用する際の採番メソッド。
    • InterfaceOffsetDays; integer;オフセット日数。
    • InternalApproval; string; この列は、サブスクリプション更新に内部承認が必要かどうかを決定します。
    • InvoiceAttachmentCategory; string; サブスクリプション・プロファイルに関連付けられた請求書添付のカテゴリ。
    • InvoiceAttachmentEntityName; string; サブスクリプション・プロファイルに関連付けられた請求書添付エンティティの名前。
    • InvoicingRuleId; integer; サブスクリプションに関連付けられた請求ルール。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • LayoutTemplate; string; サブスクリプション情報の書式を定義するレイアウト・テンプレート。
    • LineAutonumberEnabledYn; string; 行の自動採番が有効かどうかを示します。
    • NegotiationLanguage; string;サブスクリプション・ネゴシエーションおよび更新情報が通信される言語。
    • NumberingDeterminantType; string;サブスクリプションの自動採番中に使用される決定要因タイプ。
    • ObjectVersionNumber; integer; オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • オフセット、数値、サブスクリプション・プロファイルに関連付けられたオフセット。
    • PartialPeriodStart; string;部分的な期間の開始日。
    • PartialPeriodType; string; 期間タイプの一部。 値は固定および実績です。
    • PaymentTermsId; integer; 支払条件の一意の識別子。
    • PenaltyChargeName; string;ペナルティ料金の見出し。
    • PriceDuringBillingYn; string; 請求中にサブスクリプションが価格設定されるかどうかを示します。
    • PricingApplicationCode; string;価格設定アプリケーションに関連付けられたコード。
    • SpecificDays; number。サブスクリプションをオフセットする日付の数。
    • SubscriptionInvoiceList; object;サブスクリプション請求書に含めるテキスト。
    • SubscriptionInvoiceText; string; サブスクリプション請求書に含めるテキスト。
    • SubscriptionProfileDescription; string;サブスクリプション・プロファイルの説明。
    • SubscriptionProfileId; integer; サブスクリプション・プロファイルの必須でない識別子。
    • SubscriptionProfileName; string;サブスクリプション・プロファイルの名前。
    • TransactionTypeName; string;トランザクション・タイプの名前。
    • TransactionTypeSequenceId; integer;トランザクション・タイプ順序のunqiue識別子。
    • UsageCapture; string; 請求システムがFUSIONかTHIRD PARTYかを識別します。
    • UsageInvoiceLayoutTemplate; string;使用量請求に使用されるレイアウト・テンプレート。
    • WithholdProrationUsgYn;文字列;源泉徴収按分使用年
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

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

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのサブスクリプション・プロファイルを取得する方法を示しています。

cURLコマンド

curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProfiles

レスポンス本文の例

{
    "items": [
        {
            "SubscriptionProfileId": 300100181512584,
            "SubscriptionProfileName": "zOSS_PM_ALMMeters_NO_UsageCapture",
            "SubscriptionProfileDescription": "zOSS_PM_ALMMeters_NO_UsageCapture",
            "BillService": "ORA_BILL",
            "InvoicingRuleId": -2,
            "BillingFrequency": "0zG",
            "BillingDateCode": "ORA_PERIOD_START",
            "BillingOffsetDays": null,
            "AccountingRuleId": 300100033038414,
            "PaymentTermsId": 4,
            "PartialPeriodType": "ORA_ACTUAL",
            "PartialPeriodStart": "ORA_SERVICE",
            "CloseCreditMethod": "ORA_PRORATE_WITH_CREDIT",
            "SubscriptionInvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
            "TransactionTypeSequenceId": 34,
            "TransactionTypeName": "Invoice",
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2019-08-30T07:26:30+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2019-08-30T07:27:26.433+00:00",
            "LastUpdateLogin": "910A52A0131B9F95E053A15AF00A0D49",
            "PricingApplicationCode": "NULL",
            "PriceDuringBillingYn": "N",
            "CustomerAcceptance": null,
            "InternalApproval": null,
            "Offset": null,
            "SpecificDays": null,
            "LayoutTemplate": null,
            "NegotiationLanguage": null,
            "CoverageInvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
            "InterfaceOffsetDays": null,
            "BillingSystem": "ORA_OSS_FUSION",
            "UsageCapture": "ORA_THIRD_PARTY",
            "PenaltyChargeName": null,
            "LineAutonumberEnabledYn": "N",
  },
...
}
「トップに戻る」