機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サブスクリプションAI機能

すべての製品チャーン機能を入手

get

/crmRestApi/resources/11.13.18.05/subscriptionAiFeatures

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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の製品解約機能を検索
      ファインダ変数:
      • SubscriptionProductPuid; string;サブスクリプション製品の一意の識別子。
    • SubscriptionProductPuidAltKey : 指定されたサブスクリプション製品PUIDの製品解約機能を検索
      ファインダ変数:
      • SubscriptionProductPuid; string;サブスクリプション製品の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountAreaCode; string;取引先に関連付けられた市外局番。
    • AccountAutoRenewalFlag; boolean;アカウントを自動的に更改するかどうかを示します。
    • AccountAverageLastQtrBillAmount; number;アカウントに対する前四半期の平均請求額。
    • AccountAverageLastSixmthBillAmount; number;アカウントの6か月間の平均請求額。
    • AccountAverageLastYearBillAmount; number;過去1年間のアカウントの平均請求額。
    • AccountBalance; number;アカウントの現在の残高。
    • AccountChildIdList; string; アカウントの子のリスト。
    • AccountChildList; string; アカウントの子を含むリスト。
    • AccountCsmIdentifiedFlag; boolean。アカウントがCSMで識別されるかどうかを示します。
    • AccountHasChildFlag; boolean;アカウントに子があるかどうかを示します。
    • AccountLength; string;アカウントの長さ。
    • AccountOpportunitiesLost; number;取引先が失った商談の数。
    • AccountOpportunitiesOpen; number;アカウントに関連付けられたオープン商談の数。
    • AccountOverdueInvoices; number;口座の期限超過請求書の数。
    • AccountParent; string;アカウントの親。
    • AccountParentId; string;親アカウントの一意の識別子。
    • AccountProductCount; number;アカウント製品の数。
    • AccountProductDowngrades; number;アカウント製品のダウングレード。
    • AccountProductTerminations; number;アカウント製品に関連付けられた終了。
    • AccountStartDate; string;アカウントの開始日。
    • AccountState; string; アカウントに関連付けられた状態。
    • AccountTotalSrs; number;アカウントに対してログに記録されたサービス・リクエストの合計。
    • AccountType; string;アカウントのタイプ。
    • AverageRenewalDuration; number;製品の更改の平均期間。
    • BillToAccount; string; サブスクリプションに関連する請求先アカウント。
    • BillToAccountId; integer; 請求先アカウントの一意の識別子。
    • BillToSite; string;請求先住所。
    • BillToSiteUseId; integer; 請求先側の一意の識別子。
    • 解約;文字列;サブクリッションの解約。
    • CloseReason; string; subscritpionを閉じる理由。
    • ClosedDate; string; サブスクリプションがクローズされた日付。
    • CorpCurrencyCode; string; アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CurcyConvRateType; string;通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string;通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • EndDate; string; サブスクリプションが終了する日付。
    • InventoryItemId; integer;在庫品目の一意の識別子。
    • InvoicingRule; string; suscriptionを請求するためのルール。
    • InvoicingRuleId; integer; 請求ルールの一意の識別子。
    • ItemNumber; string;項目の代替の一意の識別子。
    • ItemUOM; string;項目の単位。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • MonthlyRecurringRevenue; number;サブスクリプションの月次経常収益。
    • PaymentMethod; string; サブスクリプションに関連付けられた支払方法。
    • PaymentTerms; string; サブスクリプションの支払条件(ある場合)。
    • PaymentTermsId; integer; 支払条件の一意の識別子。
    • PrimaryParty; string; サブスクリプションに関連付けられているプライマリ・パーティ。
    • PrimaryPartyId; integer;プライマリ・パーティの一意の識別子。
    • ProductAnnivPricingFlag; boolean;製品の年間価格。
    • ProductBillingFrequency; string;製品請求の頻度。
    • ProductBreachedRequests; number;製品に対する違反リクエストの数。
    • ProductEvergreenFlag; boolean;これがエバーグリーン製品かどうかを示します。
    • ProductName; string;製品名。
    • ProductNetPrice; number;サブスクライブする製品の正価。
    • ProductPastRenewals; number;過去に更新された製品の数。
    • ProductUsageChange; number; The Product Usage Change
    • 数量、数値、サブスクリプションに関連付けられた数量。
    • RenewalType; string;サブスクリプションの更新タイプ。
    • SalesProductType; string;販売製品のタイプ。
    • StartDate; string; サブスクリプションが開始する日付。
    • ステータス、文字列、製品のステータス。
    • SubscriptionId; integer; サブスクリプションの一意の識別子。
    • SubscriptionProductId; integer;サブスクリプション製品の一意の識別子。
    • SubscriptionProductPuid; string; suscription製品の公開一意識別子。
    • UsageChargesLastNinetyDays; number;ユーザーは過去90日以内に課金されます。
    • UsageChargesLastThirtyDays; number;ユーザーは過去30日間に課金されます。
    • UsageChargesMthToDate; number;ユーザーは先月課金されます。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

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