子対象レベルの取得
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}
リクエスト
パス・パラメータ
- CoveredLevelPuid(required): string
対象レベルPUID
- CoveredLevelPuid2(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
- SubscriptionNumber(required): string
サブスクリプションの代替識別子。
- SubscriptionProductPuid(required): string
サブスクリプション製品PUID。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptions-products-coveredLevels-childCoveredLevels-item-response
タイプ:
ソースを表示
object-
Address: string
タイトル:
Address子対象レベルに関連付けられたパーティ・サイトの住所。 -
AssetGroupId: integer (int64)
アセット・グループの一意の識別子。
-
AssetGroupName: string
タイトル:
Asset Group Nameアセット・グループの名前。 -
AssetGroupNumber: string
タイトル:
Asset Group Numberアセット・グループの代替識別子。 -
AssetId: integer (int64)
アセットの一意の識別子。
-
AssetName: string
タイトル:
Covered Level Asset Nameアセットの名前。 -
AssetSerialNumber: string
タイトル:
Covered Asset Serial Numberアセットに関連付けられたユニバーサル・シリアル番号。 -
CalculatedCreditAmount: number
タイトル:
Calculated Credit Amount子対象レベルの計算済貸方金額。 -
CancelDescription: string
タイトル:
Cancellation Description最大長:2000子対象レベルに関連付けられた取消摘要。 -
CanceledAmount: number
取り消された金額。
-
CanceledDate: 文字列(日付)
タイトル:
Canceled Date取消日。 -
CancelReason: string
タイトル:
Cancellation Reason最大長:30取消の事由。 -
ClosedAmount: number
対象レベルがクローズされた金額。
-
ClosedDate: 文字列(日付)
タイトル:
Covered Level Close Date対象レベルがクローズされた日付。 -
CloseDescription: string
タイトル:
Covered Level Close Description最大長:2000子対象レベルに関連付けられたクローズ摘要。 -
CloseReason: string
タイトル:
Covered Level Close Reason最大長:30対象レベルがクローズされた事由。 -
CorpCurrencyCode: string
最大長:
15アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CoveredLevelName: string
タイトル:
Covered Level Name最大長:300対象レベルの名前。 -
CoveredLevelParentPuid: string
親の対象となる親。
-
CoveredLevelPuid: string
最大長:
120対象レベルの公開一意識別子。 -
CoveredLevlName: string
タイトル:
Covered Level Name子対象レベルに関連付けられた対象レベルの名前。 -
CoveredLevlNumber: string
タイトル:
Covered Level Number子対象レベルに関連付けられた対象レベルの代替識別子。 -
CreatedBy: string
読取り専用:
true最大長:64レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
trueレコードが作成された日付。 -
CreditedAmount: number
対象レベルのクレジット金額。
-
CurcyConvRateType: string
最大長:
30通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
最大長:
15通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CustomerAccountId: integer (int64)
子対象レベルに関連付けられた顧客アカウントの一意の識別子。
-
CustomerName: string
タイトル:
Customer Account子対象レベルに関連付けられた顧客の名前。 -
CustomerNumber: string
タイトル:
Customer Account Number子対象レベルに関連付けられた顧客の一意の代替識別子。 -
Description: string
タイトル:
Covered Level Description対象レベルの摘要。 -
Duration: integer
対象レベルがアクティブである期間。
-
EndDate: 文字列(日付)
タイトル:
Covered Level End Date対象レベルの終了日。 -
ExplodeAssetHierarchy: string
アセットの展開階層。
-
GenerateBillingSchedule: string
請求のスケジュールが生成されます。
-
HierarchyTotal: number
対象レベルがクローズされた合計。
-
InventoryItemId: integer (int64)
在庫品目の一意の識別子。
-
InvoicedAmount: number
請求済金額。
-
InvoiceText: string
最大長:
2000請求書に含めるテキスト。 -
ItemUnitOfMeasure: string
最大長:
15品目で使用される単位。 -
LastUpdateDate: string (date-time)
読取り専用:
trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true最大長:32レコードを最後に更新したユーザーのログイン。 -
LineNumber: string
タイトル:
Number最大長:300行番号。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
OverrideCreditAmount: number
タイトル:
Override Credit Amount子対象レベルのクレジット金額の上書き。 -
ParentCoveredAssetId: integer (int64)
親対象アセットの一意の識別子。
-
ParentCoveredLevelId: integer (int64)
レベルの親レベル。
-
PartyId: integer (int64)
子対象レベルに関連付けられたパーティの一意の識別子。
-
PartyName: string
タイトル:
Party Name子対象レベルに関連付けられたパーティの名前。 -
PartyNumber: string
タイトル:
Party Number子対象レベルに関連付けられたパーティの代替識別子。 -
PartySite: string
タイトル:
Party Site Number子対象レベルに関連付けられたパーティ・サイトの名前。 -
PartySiteId: integer (int64)
子対象レベルに関連付けられたパーティ・サイトの一意の識別子。
-
Period: string
最大長:
80対象レベルが使用される期間。 -
PriceAsOf: 文字列(日付)
対象レベルの価格。
-
PriceListId: integer (int64)
価格リストの一意の識別子。
-
PriceUnitOfMeasure: string
最大長:
30品目で使用される単位。 -
PriceUnitOfMeasureName: string
タイトル:
Pricing UOM単位の名前。 -
PricingError: string
最大長:
1000価格設定に関連するエラー。 -
ProductGroupId: integer (int64)
製品グループの一意の識別子。
-
ProductGroupName: string
タイトル:
Product Group Name製品グループの名前。 -
ProductGroupNumber: string
タイトル:
Product Group Number製品グループの代替識別子。 -
ProductName: string
タイトル:
Product Name製品の名前。 -
PutOnHoldFlag: boolean
対象レベルが保留されているかどうかを示します。
-
数量: number
タイトル:
Quantityデフォルト値:1請求明細が請求された数量。 -
RemoveHoldFlag: boolean
対象レベルの保留を削除する必要があるかどうかを示します。
-
RenewalType: string
タイトル:
Renewal Type最大長:30更新のタイプ。 -
RenewedDate: 文字列(日付)
対象レベルが更改された日付。
-
RepriceFlag: boolean
サブスクリプション子対象レベルを価格再設定する必要があるかどうかを示します。 'true'として渡された場合、サブスクリプションの子対象レベルは価格再設定されます。
-
ReturnCreditMethod: string
タイトル:
Close Credit Method最大長:230対象レベルがクローズされた後のクレジットの返品メソッド。 -
RollupTotal: number
対象レベルがクローズされた合計。
-
SerialNumber: string
タイトル:
Covered Asset Serial Number読取り専用:true最大長:80子対象レベルのシリアル番号。 -
SourceKey: string
最大長:
120子対象レベルのソース・キー。 -
SourceLineKey: string
最大長:
120子対象レベルのソース明細キー。 -
SourceLineNumber: string
最大長:
120子対象レベルのソース明細番号。 -
SourceNumber: string
最大長:
120子対象レベルのソース番号。 -
SourceSystem: string
最大長:
30子対象レベルのソース・システム。 -
StartDate: 文字列(日付)
タイトル:
Covered Level Start Date対象レベルの開始日。 -
Status: string
タイトル:
Covered Level Status最大長:30対象レベルのステータス。 -
StatusName: string
タイトル:
Statusステータスの摘要。 -
SubscriptionId: integer (int64)
関連付けられたサブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
SuppressedCreditAmount: number
クレジットの抑制金額。
-
SuspendCreditMethod: string
最大長:
30対象レベルがクローズされた後のクレジットの一時停止メソッド。 -
SuspendedDate: 文字列(日付)
タイトル:
Covered Level Suspend Date対象レベルが休止された日付。 -
SuspendReason: string
タイトル:
Covered Level Suspend Reason最大長:30対象レベルが一時停止された事由。 -
TaxAmount: number
控除する税額。
-
TaxError: string
最大長:
4000対象レベルの税金エラー。 -
TotalContractValue: number
タイトル:
Covered Level Contract Value合計契約額 -
Type: string
タイトル:
Type最大長:30対象レベルのタイプ。 -
TypeName: string
タイトル:
Covered Level Type対象レベルに関連付けられたタイプ名。 -
UnitPrice: number
タイトル:
Unit Price子対象レベルに関連付けられた対象レベルの単価です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。