製品解約機能の取得
get
/crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
リクエスト
パス・パラメータ
- SubscriptionProductPuid(required): string
サブスクリプション製品のパブリック一意識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionAiFeatures-item-response
タイプ:
ソースを表示
object-
AccountAreaCode: string
最大長:
60口座に関連付けられた市外局番。 -
AccountAutoRenewalFlag: boolean
最大長:
1アカウントを自動的に更改する必要があるかどうかを示します。 -
AccountAverageLastQtrBillAmount: number
アカウントの前四半期の平均請求額。
-
AccountAverageLastSixmthBillAmount: number
アカウントの6か月の平均請求額。
-
AccountAverageLastYearBillAmount: number
前年度のアカウントの平均請求額。
-
AccountBalance: number
口座の現在残高。
-
AccountChildIdList: string
最大長:
1000アカウントの子を含むリスト。 -
AccountChildList: string
最大長:
4000アカウントの子を含むリスト。 -
AccountCsmIdentifiedFlag: boolean
最大長:
1アカウントがCSM識別済かどうかを示します。 -
AccountHasChildFlag: boolean
最大長:
1アカウントに子があるかどうかを示します。 -
AccountLength: string
最大長:
20アカウントの長さ。 -
AccountOpportunitiesLost: number
口座が失った商談の数。
-
AccountOpportunitiesOpen: number
取引先に関連付けられたオープン商談の数。
-
AccountOverdueInvoices: number
口座の期限超過請求書の数。
-
AccountParent: string
最大長:
360取引先の親。 -
AccountParentId: string
最大長:
30親アカウントの一意の識別子。 -
AccountProductCount: number
取引先製品の数。
-
AccountProductDowngrades: number
アカウント製品のダウングレード。
-
AccountProductTerminations: number
アカウント製品に関連付けられた退職。
-
AccountStartDate: 文字列(日付)
アカウントの開始日。
-
AccountState: string
最大長:
60口座に関連付けられた都道府県。 -
AccountTotalSrs: number
アカウントに対してログに記録されたサービス・リクエストの合計数。
-
AccountType: string
最大長:
30取引先のタイプ。 -
AverageRenewalDuration: number
製品の更新の平均期間。
-
BillToAccount: string
最大長:
240サブスクリプションに関連付けられた請求先アカウント。 -
BillToAccountId: integer (int64)
請求先アカウントの一意の識別子。
-
BillToSite: string
最大長:
150請求先住所。 -
BillToSiteUseId: integer (int64)
請求先側の一意の識別子。
-
Churn: string
最大長:
1亜縮約の流動。 -
ClosedDate: 文字列(日付)
サブスクリプションがクローズされた日付。
-
CloseReason: string
最大長:
30サブクリエーションをクローズする理由。 -
CorpCurrencyCode: string
最大長:
15アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
読取り専用:
true最大長:64レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
trueレコードが作成された日付。 -
CurcyConvRateType: string
最大長:
30通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
最大長:
15通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
EndDate: 文字列(日付)
サブスクリプションが終了する日付。
-
InventoryItemId: integer (int64)
在庫品目の一意の識別子。
-
InvoicingRule: string
最大長:
80規定の請求に関するルールに従います。 -
InvoicingRuleId: integer (int64)
請求ルールの一意の識別子です。
-
ItemNumber: string
最大長:
300品目の代替一意識別子。 -
ItemUOM: string
最大長:
15明細の単位。 -
LastUpdateDate: string (date-time)
読取り専用:
trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true最大長:32レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
MonthlyRecurringRevenue: number
サブスクリプションの月次経常収益。
-
PaymentMethod: string
最大長:
30サブスクリプションに関連付けられた支払方法。 -
PaymentTerms: string
最大長:
240サブスクリプションの支払条件(ある場合)。 -
PaymentTermsId: integer (int64)
支払条件の一意の識別子。
-
PrimaryParty: string
最大長:
360サブスクリプションに関連付けられたプライマリ・パーティ。 -
PrimaryPartyId: integer (int64)
プライマリ・パーティの一意の識別子。
-
ProductAnnivPricingFlag: boolean
最大長:
1製品の年間価格。 -
ProductBillingFrequency: string
最大長:
1000製品請求の頻度。 -
ProductBreachedRequests: number
製品に対する違反リクエストの数。
-
ProductEvergreenFlag: boolean
最大長:
1これがエバーグリーン製品かどうかを示します。 -
ProductName: string
最大長:
300製品の名前。 -
ProductNetPrice: number
サブスクライブした製品の正味価格。
-
ProductPastRenewals: number
過去の製品更新の数。
-
ProductUsageChange: number
製品使用状況の変更
-
数量: number
サブスクリプションに関連付けられた数量。
-
RenewalType: string
最大長:
30サブスクリプションの更新タイプ。 -
SalesProductType: string
最大長:
30販売製品のタイプ。 -
StartDate: 文字列(日付)
サブスクリプションが開始する日付。
-
Status: string
最大長:
30製品のステータス。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
SubscriptionProductPuid: string
最大長:
120サブスクリプション製品のパブリック一意識別子。 -
UsageChargesLastNinetyDays: number
ユーザーは過去90日以内に請求します。
-
UsageChargesLastThirtyDays: number
ユーザーは過去30日間に課金されます。
-
UsageChargesMthToDate: number
ユーザーは先月課金されます。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。