すべてのサブスクリプション残高台帳の取得
get
/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters
リクエスト
問合せパラメータ
- 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
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- BalanceRegisterAltKey指定した代替キーを持つサブスクリプション残高レジスタを検索します。
ファインダ変数- BalanceRegisterNumber; string;残高台帳代替キーに対するサブスクリプション残高台帳の一意の残高台帳番号。
- PrimaryKey指定した主キーを持つサブスクリプション残高レジスタを検索します。
ファインダ変数- BalanceRegisterId; integer;検索に使用されるサブスクリプション残高レジスタの一意の残高レジスタ識別子。
- BalanceRegisterAltKey指定した代替キーを持つサブスクリプション残高レジスタを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- BalanceProfileName; string; サブスクリプション残高レジスタの残高プロファイル名。
- BalanceProfileNumber; string; サブスクリプション残高レジスタの残高プロファイル番号。
- BalanceRegisterId; integer;サブスクリプション残高レジスタの残高レジスタ識別子。
- BalanceRegisterNumber; string; サブスクリプション残高レジスタの残高レジスタ番号。
- BillOnDay; integer; サブスクリプション残高レジスタの日における請求。
- BillPeriodAlignDay; integer;請求期間は、サブスクリプション残高レジスタの日を連携させます。
- BillingDateCode; string; サブスクリプション残高レジスタの請求日コード。
- BillingFrequency; string; サブスクリプション残高レジスタの請求頻度。
- BillingOffsetDays; integer; サブスクリプション残高レジスタの請求オフセット日。
- CreatedBy; string; サブスクリプション残高登録を作成したユーザー。
- CreationDate; string;サブスクリプション残高台帳の作成日。
- InterfaceOffsetDays; integer; サブスクリプション残高レジスタのインタフェース・オフセット日。
- InvoicingRuleId; integer;サブスクリプション残高台帳の請求書ルール識別子。
- LastUpdateDate; string; サブスクリプション残高登録が最後に更新された日付。
- LastUpdateLogin; string;サブスクリプション残高台帳を最後に更新したユーザーのログイン。
- LastUpdatedBy; string; サブスクリプション残高台帳を最後に更新したユーザー。
- ObjectVersionNumber; integer; サブスクリプション残高レジスタのオブジェクト・バージョン番号。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionBalanceRegisters
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : subscriptionBalanceRegisters-item-response
タイプ:
ソースを表示
object
-
BalanceProfileName: string
タイトル:
Name
最大長:120
サブスクリプション残高台帳の残高プロファイル名。 -
BalanceProfileNumber: string
タイトル:
Number
最大長:120
サブスクリプション残高台帳の残高プロファイル番号。 -
BalanceRegisterId: integer (int64)
サブスクリプション残高台帳の残高台帳識別子。
-
BalanceRegisterNumber: string
タイトル:
Number
最大長:120
サブスクリプション残高台帳の残高台帳番号。 -
BillingDateCode: string
タイトル:
Billing Date
読取り専用:true
最大長:30
サブスクリプション残高台帳の請求日コード。 -
BillingFrequency: string
タイトル:
Billing Frequency
読取り専用:true
最大長:30
サブスクリプション残高台帳の請求頻度。 -
BillingOffsetDays: 整数(int32)
タイトル:
Offset
読取り専用:true
サブスクリプション残高台帳の請求オフセット日。 -
BillOnDay: 整数(int32)
タイトル:
Day
読取り専用:true
サブスクリプション残高台帳の日付の請求。 -
BillPeriodAlignDay: 整数(int32)
タイトル:
Align Billing Day
読取り専用:true
サブスクリプション残高台帳の請求期間調整日。 -
CreatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高登録を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サブスクリプション残高台帳の作成日。 -
InterfaceOffsetDays: 整数(int32)
タイトル:
Billing Interface Offset Days
読取り専用:true
サブスクリプション残高台帳のインタフェース・オフセット日。 -
InvoicingRuleId: integer (int64)
タイトル:
Invoicing Rule
読取り専用:true
サブスクリプション残高台帳の請求書ルール識別子。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サブスクリプション残高登録が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高台帳を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
サブスクリプション残高台帳を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション残高台帳のオブジェクト・バージョン番号。
-
profileCharges: array Subscription Balance Profile Charges
タイトル:
Subscription Balance Profile Charges
サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。 -
registerCriteria: array Subscription Balance Criteria
タイトル:
Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。 -
registerPeriods: array Subscription Balance Periods
タイトル:
Subscription Balance Periods
サブスクリプション残高サブスクリプション期間リソースは、残高サブスクリプション期間を表示するために使用されます。
ネストされたスキーマ : サブスクリプション残高プロファイル手数料
タイプ:
array
タイトル:
Subscription Balance Profile Charges
サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。
ソースを表示
ネストされたスキーマ : サブスクリプション残高基準
タイプ:
array
タイトル:
Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : サブスクリプション残高期間
タイプ:
array
タイトル:
Subscription Balance Periods
サブスクリプション残高サブスクリプション期間リソースは、残高サブスクリプション期間を表示するために使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : subscriptionBalanceRegisters-profileCharges-item-response
タイプ:
ソースを表示
object
-
BalanceProfileChargeId: integer (int64)
サブスクリプション残高プロファイル手数料の残高プロファイル手数料識別子。
-
BalanceProfileChargeNumber: string
タイトル:
Profile Charge Number
最大長:120
サブスクリプション残高プロファイル手数料の残高プロファイル手数料番号。 -
BalanceProfileId: integer (int64)
サブスクリプション残高プロファイル手数料の残高プロファイル識別子。
-
ChargeDefinitionCode: string
最大長:
30
サブスクリプション残高プロファイル手数料の手数料定義コード。 -
ChargeDefinitionId: integer (int64)
タイトル:
Charge Name
サブスクリプション残高プロファイル手数料の残高手数料定義識別子。 -
ChargePeriod: string
タイトル:
Periodicity
最大長:30
サブスクリプション残高プロファイル手数料の手数料期間。 -
ChargePeriodUnitOfMeasure: string
タイトル:
Periodicity
最大長:25
サブスクリプション残高プロファイル手数料の手数料期間単位。 -
CreatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高プロファイル料金を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サブスクリプション残高プロファイル手数料が作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サブスクリプション・プロファイル料金が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高基準を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
サブスクリプション・プロファイル料金を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション・プロファイル料金のすべての更新後に更新されるオブジェクト・バージョン番号。
-
QuantityUnitOfMeasure: string
タイトル:
Usage UOM
最大長:25
サブスクリプション残高プロファイル料金の数量単位。 -
QuantityUnitOfMeasureCode: string
タイトル:
Usage UOM
最大長:3
サブスクリプション残高プロファイル手数料の数量単位コード。
ネストされたスキーマ : subscriptionBalanceRegisters-registerCriteria-item-response
タイプ:
ソースを表示
object
-
BalanceCriteriaDescription: string
タイトル:
Description
最大長:300
サブスクリプション残高基準の摘要。 -
BalanceCriteriaId: integer (int64)
サブスクリプション残高基準の一意の識別子。
-
BalanceCriteriaNumber: string
タイトル:
Criteria
最大長:120
サブスクリプション残高基準の一意の番号。 -
BalanceCriteriaStatus: string
タイトル:
Status
最大長:30
デフォルト値:ORA_OSS_DRAFT
サブスクリプション残高基準のステータス。 -
BalanceCriteriaUsage: string
タイトル:
Usage
最大長:30
サブスクリプション残高基準の使用条件。 -
CreatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高基準を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サブスクリプション残高基準が作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サブスクリプション残高基準が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高基準を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
サブスクリプション残高基準を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション残高基準の更新のたびに更新されるオブジェクト・バージョン番号。
-
subscriptionBalancePredicates: array Subscription Balance Predicates
タイトル:
Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ネストされたスキーマ : サブスクリプション残高述語
タイプ:
array
タイトル:
Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-response
タイプ:
ソースを表示
object
-
BalanceAttributeId: integer (int64)
サブスクリプション残高属性の一意の識別子。
-
BalanceAttributeName: string
タイトル:
Attribute Name
最大長:240
サブスクリプション残高属性の名前。 -
BalanceCriteriaId: integer (int64)
サブスクリプション残高述語の残高基準ID。
-
BalanceObjectId: integer (int64)
サブスクリプション残高述語のバランス・オブジェクト識別子。
-
BalanceObjectName: string
タイトル:
Object Name
最大長:120
サブスクリプション残高述語のバランス・オブジェクト名。 -
BalancePredicateCharacterValue: string
タイトル:
Value
最大長:600
サブスクリプション残高述語の残高述語文字値。 -
BalancePredicateDateValue: 文字列(日付)
タイトル:
Value
サブスクリプション残高述語の残高述語日付値です。 -
BalancePredicateDecimalValue: number
タイトル:
Value
サブスクリプション残高述語の残高述語10進数値。 -
BalancePredicateId: integer (int64)
サブスクリプション残高述語の一意の識別子。
-
BalancePredicateNumber: string
タイトル:
Number
最大長:120
サブスクリプション残高述語の一意の番号。 -
BalancePredicateNumberValue: integer
タイトル:
Value
サブスクリプション残高述語の数値。 -
BalancePredicateOperator: string
タイトル:
Operator
最大長:30
サブスクリプション残高述語の演算子値。 -
BalancePredicateSequence: integer
タイトル:
Sequence
サブスクリプション残高述語の残高述語シーケンス。 -
BalancePredicateSortBy: string
タイトル:
Sort Order
最大長:30
サブスクリプション残高述語の基準でソートします。 -
BalancePredicateTimeValue: string (date-time)
タイトル:
Value
サブスクリプション残高述語の時間値。 -
CreatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高述語を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サブスクリプション残高述語が作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サブスクリプション残高述語が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高述語を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
サブスクリプション残高述語を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
サブスクリプション残高述語のオブジェクト・バージョン番号。
ネストされたスキーマ : subscriptionBalanceRegisters-registerPeriods-item-response
タイプ:
ソースを表示
object
-
allowanceGrants: array Subscription Balance Register Allowance Grants
タイトル:
Subscription Balance Register Allowance Grants
サブスクリプション残高台帳引当金付与リソースは、残高台帳引当金付与の表示に使用されます。 -
BalanceRegisterId: integer (int64)
サブスクリプション残高登録期間の残高登録識別子。
-
BalanceRegisterPeriodId: integer (int64)
サブスクリプション残高登録期間の残高登録期間識別子。
-
BalanceRegisterPeriodNumber: string
タイトル:
Register Period Number
最大長:120
サブスクリプション残高登録期間の残高登録期間番号。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
サブスクリプション残高基準の更新のたびに更新されるオブジェクト・バージョン番号。 -
StartDate: 文字列(日付)
タイトル:
Start Date
サブスクリプション残高登録期間の開始日。
ネストされたスキーマ : サブスクリプション残高登録引当金付与
タイプ:
array
タイトル:
Subscription Balance Register Allowance Grants
サブスクリプション残高台帳引当金付与リソースは、残高台帳引当金付与の表示に使用されます。
ソースを表示
ネストされたスキーマ : subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response
タイプ:
ソースを表示
object
-
AllowanceGrantId: integer (int64)
サブスクリプション残高台帳引当金付与の残高台帳引当金付与識別子。
-
AllowanceGrantNumber: string
タイトル:
Allowance Grant Number
最大長:120
サブスクリプション残高引当金付与の残高台帳引当金付与番号です。 -
BalanceCode: string
タイトル:
Code
読取り専用:true
最大長:30
サブスクリプション残高引当金付与の残高コード。 -
BalanceRegisterId: integer (int64)
サブスクリプション残高引当金付与の残高台帳識別子。
-
BalanceRegisterPeriodId: integer (int64)
サブスクリプション残高引当金付与の残高登録期間識別子。
-
ConsumedQuantity: number
タイトル:
Consumed Quantity
サブスクリプション残高許可付与の消費済数量。 -
CreatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高引当金付与を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サブスクリプション残高引当金付与が作成された日付。 -
EndDate: 文字列(日付)
タイトル:
End Date
手当付与が終了する日付。 -
GrantDate: 文字列(日付)
タイトル:
Grant Date
手当が付与された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サブスクリプション残高引当金付与が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
サブスクリプション残高引当金付与を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
サブスクリプション残高引当金付与を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション残高引当金付与が更新されるたびに更新されるオブジェクト・バージョン番号。
-
ProductName: string
タイトル:
Product Name
読取り専用:true
最大長:300
サブスクリプション残高引当金付与の製品名。 -
ProductNumber: string
タイトル:
Product Number
読取り専用:true
最大長:300
サブスクリプション残高引当金付与の製品番号。 -
数量: number
タイトル:
Granted Quantity
サブスクリプション残高許可の数量。 -
QuantityUnitOfMeasure: string
タイトル:
UOM
最大長:3
サブスクリプション残高引当金付与の数量単位。 -
RemainingQuantity: number
タイトル:
Remaining Quantity
サブスクリプション残高引当金付与の残数量。 -
RolloverEndDate: 文字列(日付)
タイトル:
Rollover End Date
サブスクリプション残高手当付与のロールオーバー終了日。 -
StartDate: 文字列(日付)
タイトル:
Start Date
サブスクリプション残高手当付与の開始日。 -
SubscriptionNumber: string
タイトル:
Subscription Number
読取り専用:true
最大長:120
サブスクリプション残高引当金付与のサブスクリプション番号。 -
SubscriptionProductPuid: string
タイトル:
Subscription Product PUID
読取り専用:true
最大長:120
サブスクリプション残高引当金付与のサブスクリプション製品PUID。