標準カバレッジの取得
get
/crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}
リクエスト
パス・パラメータ
- CoverageHeaderPuid(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionCoverageHeaders-item-response
タイプ:
ソースを表示
object
-
CoverageChargeDiscounts: array Adjustments
タイトル:
Adjustments
調整リソースは、調整の表示、作成、更新および削除に使用されます。 調整情報の詳細が表示されます。 -
CoverageDescription: string
タイトル:
Template Description
最大長:1000
標準カバレッジ摘要を一意に識別する値。 -
CoverageHeaderId: integer (int64)
内部標準カバレッジの一意の識別子。
-
CoverageHeaderPuid: string
最大長:
120
標準カバレッジを一意に識別する値。 -
CoverageName: string
タイトル:
Template Name
最大長:150
標準カバレッジの名前。 -
CreatedBy: string
読取り専用:
true
最大長:64
標準補償内容レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
標準カバレッジが作成された日付。 -
DynamicMatrixClassId: integer (int64)
タイトル:
Entitlement Type
動的マトリックス区分の一意の識別子。 -
DynamicMatrixClassName: string
タイトル:
Entitlement Type
動的マトリックス区分を一意に識別する代替値。 -
EndDate: 文字列(日付)
タイトル:
End Date
標準補償範囲が終了する日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
標準カバレッジが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
標準カバレッジを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
標準カバレッジを最後に更新したユーザーの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MatrixId: integer (int64)
動的マトリックスの一意の識別子。
-
MatrixName: string
マトリックスの名前。
-
StandardCoverageYn: string
最大長:
1
カバレッジが標準カバレッジかどうかを示します。 デフォルト値は「False」です。 -
StartDate: 文字列(日付)
タイトル:
Start Date
調整が作成された日付。 -
SubscriptionProductPuid: string
サブスクリプション製品を一意に識別する値。
ネストされたスキーマ : 調整
タイプ:
array
タイトル:
Adjustments
調整リソースは、調整の表示、作成、更新および削除に使用されます。 調整情報の詳細が表示されます。
ソースを表示
ネストされたスキーマ : subscriptionCoverageHeaders-CoverageChargeDiscounts-item-response
タイプ:
ソースを表示
object
-
AdjustmentAmount: number
タイトル:
Value
調整タイプに入力された金額。 -
AdjustmentTypeCode: string
最大長:
30
調整タイプ参照の一意のコード。 有効な値は、割引率または値入れ率です。 受け入れられる値のリストは、参照タイプORA_QP_LINE_ADJ_TYPESで定義されます。 -
AdjustmentTypeMeaning: string
タイトル:
Adjustment Type
調整タイプ参照の表示値。 代替有効値には、割引率または値入れ率が含まれます。 受け入れられる値のリストは、参照タイプORA_QP_LINE_ADJ_TYPESで定義されます。 -
AllowCustomAdjustmentsFlag: boolean
タイトル:
Allow custom adjustments
最大長:1
カスタム調整が許可されるかどうかを示します。 デフォルト値はTrueです。 -
AllowPricingDiscountsFlag: boolean
タイトル:
Allow pricing discounts
最大長:1
価格設定割引が許可されるかどうかを示します。 デフォルト値は「False」です。 -
BillingTypeCode: string
最大長:
30
請求タイプ参照の一意のコード。 受け入れられる値のリストは、請求タイプ・コードの参照タイプEGP_MATERIAL_BILLABLE_TYPEで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。 -
BillingTypeMeaning: string
タイトル:
Billing Type
請求タイプ参照コードの表示値。 受け入れられる値のリストは、参照タイプEGP_MATERIAL_BILLABLE_TYPEに請求タイプの意味のために定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。 -
BusinessProcessCode: string
最大長:
30
ビジネス・プロセス・タイプ参照の一意のコード。 受け入れられる値のリストは、ビジネス・プロセス・コードの参照タイプORA_RCL_BUSINESS_PROCESSで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。 -
BusinessProcessMeaning: string
タイトル:
Business Process
ビジネス・プロセス・タイプ参照の表示値。 受け入れられる値のリストは、ビジネス・プロセスの意味を示す参照タイプORA_RCL_BUSINESS_PROCESSで定義されます。 「設定およびメンテナンス」作業領域および「サービス・ロジスティクス参照の管理」タスクを使用して、値リストをレビューおよび更新します。 -
ChargeDiscountId: integer (int64)
調整の一意の識別子。
-
CoverageDiscountPuid: string
最大長:
120
調整を一意に識別する値。 -
CoverageHeaderId: integer (int64)
調整に対する親カバレッジ・ヘッダーの一意の識別子。
-
CreatedBy: string
読取り専用:
true
最大長:64
調整を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
調整が作成された日付。 -
EndDate: 文字列(日付)
タイトル:
End Date
カバレッジ調整が終了する日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
調整が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
調整を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
調整を最後に更新したユーザーの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PricingBasisId: integer
価格設定基準の一意の識別子。 受け入れられる値のリストは、価格設定基準IDのビューqp_pricing_basis_vlで定義されます。
-
PricingBasisName: string
タイトル:
Adjustment Basis
価格設定基準の名前。 受け入れられる値のリストは、価格設定基準名のビューqp_pricing_basis_vlで定義されます。 -
PricingTermId: integer
価格設定条件の一意の識別子。
-
ServiceActivityId: integer (int64)
サービス・アクティビティの一意の識別子。 受け入れられる値のリストは、サービス・アクティビティIDのビューRCL_SERVICE_ACTIVITIES_VLで定義されます。
-
ServiceActivityName: string
タイトル:
Service Activity
最大長:80
サービス活動の名前。 受け入れられる値のリストは、サービス・アクティビティ名のビューRCL_SERVICE_ACTIVITIES_VLで定義されます。 -
StartDate: 文字列(日付)
タイトル:
Start Date
調整が開始する日付。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- CoverageChargeDiscounts
-
パラメータ:
- CoverageHeaderPuid:
$request.path.CoverageHeaderPuid
調整リソースは、調整の表示、作成、更新および削除に使用されます。 調整情報の詳細が表示されます。 - CoverageHeaderPuid: