すべての使用イベント料金の取得
get
/crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges
リクエスト
パス・パラメータ
- EventNumber(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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey :指定した主キーで使用イベント料金を検索します。
ファインダ変数:- UsageChargeId :使用イベント料金の一意の識別子。
- UsageChargePUID :指定した代替キー基準に一致する使用イベント料金を検索します。
ファインダ変数:- UsageChargePuid :使用イベント料金に関連付けられたPUID。
- PrimaryKey :指定した主キーで使用イベント料金を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ChargeCurrency; string;使用イベント料金の通貨。
- ChargeDefinition; string; 使用イベント料金に関連付けられた料金定義。
- ChargeDefinitionId; integer; 使用イベント料金に関連付けられた料金定義の識別子。
- ChargeName; string;使用イベント料金の名前。
- CreatedBy; string; 使用イベント料金を作成したユーザー。
- CreationDate; string;使用イベント料金が作成された日付。
- EventId; integer; この使用イベント料金が関連付けられているイベントの一意の識別子。
- ExtendedAmount; number;使用イベント料金の拡張金額。
- LastUpdateDate; string; 使用イベント料金が最後に更新された日付。
- LastUpdateLogin; string; 使用イベント料金を最後に更新したユーザーのログイン。
- LastUpdatedBy; string; 使用イベント料金を最後に更新したユーザー。
- ObjectVersionNumber; integer; 使用イベント料金のすべての更新後に更新されるオブジェクト・バージョン番号。
- ParentEntity; string; 使用イベント料金に関連付けられた親エンティティ。
- ParentEntityId; integer; 使用イベント料金に関連付けられた親エンティティの一意の識別子。
- PricedQuantity; number;使用イベント料金に対して価格設定される数量。
- PricedQuantityUnitOfMeasure; string; 使用イベント料金の価格設定済数量の単位。
- SequenceNumber; integer; 使用イベント料金に関連付けられたシーケンス番号。
- SubscriptionId; integer; この使用イベント変更が属するサブスクリプションの一意の識別子。
- SubscriptionProductId; integer; この使用イベント料金が属するサブスクリプション製品のPUID。
- UsageChargeId; integer; 使用イベント料金の一意の識別子。
- UsageChargePuid; string;使用イベント料金のPUID。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionUsageEvents-usageCharges
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : subscriptionUsageEvents-usageCharges-item-response
タイプ:
ソースを表示
object
-
ChargeCurrency: string
最大長:
15
使用イベント手数料の通貨。 -
ChargeDefinition: string
最大長:
30
使用イベント手数料に関連付けられた手数料定義。 -
ChargeDefinitionId: integer (int64)
使用イベント手数料に関連付けられた手数料定義の識別子。
-
ChargeName: string
最大長:
120
使用イベント手数料の名前。 -
CreatedBy: string
読取り専用:
true
最大長:64
使用イベント料金を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
使用イベント料金が作成された日付。 -
EventId: integer (int64)
この使用イベント料金が関連付けられているイベントの一意の識別子。
-
ExtendedAmount: number
使用イベント料金の拡張金額。
-
LastUpdateDate: string (date-time)
読取り専用:
true
使用イベント料金が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
使用イベント料金を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
使用イベント料金を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
使用イベント手数料のすべての更新後に更新されるオブジェクト・バージョン番号。
-
ParentEntity: string
最大長:
30
使用イベント手数料に関連付けられた親エンティティ。 -
ParentEntityId: integer (int64)
使用イベント手数料に関連付けられた親エンティティの一意の識別子。
-
PricedQuantity: number
使用イベント手数料に対して価格設定された数量。
-
PricedQuantityUnitOfMeasure: string
最大長:
3
使用イベント手数料の価格設定済数量の単位。 -
SequenceNumber: 整数(int32)
使用イベント手数料に関連付けられた連番。
-
SubscriptionId: integer (int64)
この使用イベント変更が属するサブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
この使用イベント料金が属するサブスクリプション製品のPUID。
-
UsageChargeId: integer (int64)
使用イベント手数料の一意の識別子。
-
UsageChargePuid: string
最大長:
120
使用イベント手数料のPUID。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。