機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

残高プロファイルの作成

post

/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• BalanceProfileId: integer (int64)
  サブスクリプション残高プロファイルの一意の識別子。
• BalanceProfileName(required): string
  タイトル: Name

  最大長: 120

  サブスクリプション残高プロファイルの名前。
• BalanceProfileNumber(required): string
  タイトル: Number

  最大長: 120

  サブスクリプション残高プロファイルの一意の番号。
• BalanceProfileStatus: string
  タイトル: Status

  最大長: 30

  デフォルト値: ORA_OSS_DRAFT

  サブスクリプション残高プロファイルのステータス。
• BillingDate: string
  タイトル: Billing Date

  最大長: 80

  サブスクリプション残高プロファイルの請求日。
• BillingDateCode: string
  タイトル: Billing Date

  最大長: 30

  サブスクリプション残高プロファイルの請求日コード。
• BillingFrequency: string
  タイトル: Billing Frequency

  最大長: 30

  サブスクリプション残高プロファイルの請求頻度。
• BillingFrequencyUnitOfMeasure: string
  タイトル: Billing Frequency

  最大長: 25

  サブスクリプション残高プロファイルの請求頻度単位。
• BillingOffsetDays: 整数(int32)
  タイトル: Offset

  サブスクリプション残高プロファイルの名前。
• BillOnDay: 整数(int32)
  タイトル: Day

  サブスクリプション残高プロファイルの日における請求。
• BillPeriodAlignDay: 整数(int32)
  タイトル: Align Billing Day

  サブスクリプション残高プロファイルの請求期間調整日。
• groupCriteria: array Subscription Balance Criteria
  タイトル: Subscription Balance Criteria

  サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
• InterfaceOffsetDays: 整数(int32)
  タイトル: Billing Interface Offset Days

  サブスクリプション残高プロファイルのインタフェース・オフセット日数。
• InvoicingRuleId: integer (int64)
  タイトル: Invoicing Rule

  サブスクリプション残高プロファイルの請求書ルール識別子。
• InvoicingRuleName: string
  タイトル: Invoicing Rule

  最大長: 30

  サブスクリプション残高プロファイルの請求書ルール名。
• ObjectVersionNumber: 整数(int32)
  サブスクリプション残高プロファイルのすべての更新後に更新されるオブジェクト・バージョン番号。
• profileBalanceCodes: array Subscription Profile Balance Codes
  タイトル: Subscription Profile Balance Codes

  サブスクリプション残高プロファイル残高コード・リソースは、残高プロファイル残高コードの表示、作成、更新および削除に使用されます。
• profileCharges: array Subscription Balance Profile Charges
  タイトル: Subscription Balance Profile Charges

  サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。

{
    "required":[
        "BalanceProfileName",
        "BalanceProfileNumber"
    ],
    "type":"object",
    "properties":{
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance profile.",
            "nullable":false
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The invoice rule identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The billing date code of the subscription balance profile.",
            "nullable":true
        },
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The name of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency of the subscription balance profile.",
            "nullable":true
        },
        "BillPeriodAlignDay":{
            "title":"Align Billing Day",
            "type":"integer",
            "description":"The bill period align day of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            }
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "maxLength":30,
            "type":"string",
            "description":"The invoice rule name of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceProfileName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the subscription balance profile.",
            "nullable":false
        },
        "BillingDate":{
            "title":"Billing Date",
            "maxLength":80,
            "type":"string",
            "description":"The billing date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "groupCriteria":{
            "title":"Subscription Balance Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-post-request"
            },
            "x-cardinality":"1"
        },
        "BillOnDay":{
            "title":"Day",
            "type":"integer",
            "description":"The bill on day of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            }
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceProfileStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance profile.",
            "nullable":true,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":25,
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance profile.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "profileCharges":{
            "title":"Subscription Balance Profile Charges",
            "type":"array",
            "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileCharges-item-post-request"
            }
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The interface offset days of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "profileBalanceCodes":{
            "title":"Subscription Profile Balance Codes",
            "type":"array",
            "description":"The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileBalanceCodes-item-post-request"
            }
        }
    }
}

ネストされたスキーマ : サブスクリプション残高基準

タイプ: array

タイトル: Subscription Balance Criteria

サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。

ソースを表示

• Array of: object subscriptionBalanceProfiles-groupCriteria-item-post-request

{
    "title":"Subscription Balance Criteria",
    "type":"array",
    "description":"The subscription balance criteria resource is used to view a balance criteria.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-post-request"
    },
    "x-cardinality":"1"
}

ネストされたスキーマ : サブスクリプション・プロファイル残高コード

タイプ: array

タイトル: Subscription Profile Balance Codes

サブスクリプション残高プロファイル残高コード・リソースは、残高プロファイル残高コードの表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Subscription Profile Balance Codes",
    "type":"array",
    "description":"The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileBalanceCodes-item-post-request"
    }
}

ネストされたスキーマ : サブスクリプション残高プロファイル手数料

タイプ: array

タイトル: Subscription Balance Profile Charges

サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Subscription Balance Profile Charges",
    "type":"array",
    "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileCharges-item-post-request"
    }
}

ネストされたスキーマ : subscriptionBalanceProfiles-groupCriteria-item-post-request

タイプ: object

ソースを表示

• BalanceCriteriaDescription: string
  タイトル: Description

  最大長: 300

  サブスクリプション残高基準の摘要。
• BalanceCriteriaId: integer (int64)
  サブスクリプション残高基準の一意の識別子。
• BalanceCriteriaNumber(required): string
  タイトル: Criteria

  最大長: 120

  サブスクリプション残高基準の一意の番号。
• BalanceCriteriaStatus: string
  タイトル: Status

  最大長: 30

  デフォルト値: ORA_OSS_DRAFT

  サブスクリプション残高基準のステータス。
• BalanceCriteriaUsage(required): string
  タイトル: Usage

  最大長: 30

  サブスクリプション残高基準の使用条件。
• ObjectVersionNumber: 整数(int32)
  サブスクリプション残高基準の更新のたびに更新されるオブジェクト・バージョン番号。
• subscriptionBalancePredicates: array Subscription Balance Predicates
  タイトル: Subscription Balance Predicates

  サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

{
    "required":[
        "BalanceCriteriaNumber",
        "BalanceCriteriaUsage"
    ],
    "type":"object",
    "properties":{
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The usage condition of subscription balance criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : サブスクリプション残高述語

タイプ: array

タイトル: Subscription Balance Predicates

サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

ソースを表示

• Array of: object subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request

{
    "title":"Subscription Balance Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request"
    }
}

ネストされたスキーマ : subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request

タイプ: 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

  サブスクリプション残高述語の時間値。

{
    "type":"object",
    "properties":{
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria Id of subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":30,
            "type":"string",
            "description":"The sort by criterion of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance object name of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":600,
            "type":"string",
            "description":"The balance predicate character value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance predicate.",
            "nullable":false
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the subscription balance attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        }
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• BalanceCode: string
  タイトル: Code

  最大長: 30

  サブスクリプション残高プロファイル残高コードのバランス・コード。
• BalanceCodeId: integer (int64)
  タイトル: Balance Code

  バランス・コードの一意の識別子。
• BalanceProfileChargeId: integer (int64)
  バランス・プロファイル手数料の一意の識別子。
• BalanceProfileId: integer (int64)
  バランス・プロファイルの一意の識別子。
• ProfileBalanceCodeId: integer (int64)
  バランス・プロファイル・コードの一意の識別子。
• ProfileBalanceCodeNumber: string
  最大長: 120

  プロファイル残高コードの代替識別子。

{
    "type":"object",
    "properties":{
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProfileBalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription balance profile balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

ネストされたスキーマ : スキーマ

タイプ: 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

  サブスクリプション残高プロファイル手数料の手数料期間単位。
• ObjectVersionNumber: 整数(int32)
  サブスクリプション・プロファイル料金のすべての更新後に更新されるオブジェクト・バージョン番号。
• QuantityUnitOfMeasure: string
  タイトル: Usage UOM

  最大長: 25

  サブスクリプション残高プロファイル料金の数量単位。
• QuantityUnitOfMeasureCode: string
  タイトル: Usage UOM

  最大長: 3

  サブスクリプション残高プロファイル手数料の数量単位コード。

{
    "type":"object",
    "properties":{
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":25,
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":25,
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true
        },
        "QuantityUnitOfMeasureCode":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The quantity unit of measure code of the subscription balance profile charges.",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : subscriptionBalanceProfiles-item-response

タイプ: object

ソースを表示

• BalanceProfileId: integer (int64)
  サブスクリプション残高プロファイルの一意の識別子。
• BalanceProfileName: string
  タイトル: Name

  最大長: 120

  サブスクリプション残高プロファイルの名前。
• BalanceProfileNumber: string
  タイトル: Number

  最大長: 120

  サブスクリプション残高プロファイルの一意の番号。
• BalanceProfileStatus: string
  タイトル: Status

  最大長: 30

  デフォルト値: ORA_OSS_DRAFT

  サブスクリプション残高プロファイルのステータス。
• BillingDate: string
  タイトル: Billing Date

  最大長: 80

  サブスクリプション残高プロファイルの請求日。
• BillingDateCode: string
  タイトル: Billing Date

  最大長: 30

  サブスクリプション残高プロファイルの請求日コード。
• BillingFrequency: string
  タイトル: Billing Frequency

  最大長: 30

  サブスクリプション残高プロファイルの請求頻度。
• BillingFrequencyUnitOfMeasure: string
  タイトル: Billing Frequency

  最大長: 25

  サブスクリプション残高プロファイルの請求頻度単位。
• BillingOffsetDays: 整数(int32)
  タイトル: Offset

  サブスクリプション残高プロファイルの名前。
• BillOnDay: 整数(int32)
  タイトル: Day

  サブスクリプション残高プロファイルの日における請求。
• BillPeriodAlignDay: 整数(int32)
  タイトル: Align Billing Day

  サブスクリプション残高プロファイルの請求期間調整日。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  サブスクリプション残高プロファイルを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  サブスクリプション残高プロファイルが作成された日付。
• groupCriteria: array Subscription Balance Criteria
  タイトル: Subscription Balance Criteria

  サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
• InterfaceOffsetDays: 整数(int32)
  タイトル: Billing Interface Offset Days

  サブスクリプション残高プロファイルのインタフェース・オフセット日数。
• InvoicingRuleId: integer (int64)
  タイトル: Invoicing Rule

  サブスクリプション残高プロファイルの請求書ルール識別子。
• InvoicingRuleName: string
  タイトル: Invoicing Rule

  最大長: 30

  サブスクリプション残高プロファイルの請求書ルール名。
• LastUpdateDate: string (date-time)
  読取り専用: true

  サブスクリプション残高プロファイルが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  サブスクリプション残高プロファイルを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  サブスクリプション残高プロファイルを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  サブスクリプション残高プロファイルのすべての更新後に更新されるオブジェクト・バージョン番号。
• profileBalanceCodes: array Subscription Profile Balance Codes
  タイトル: Subscription Profile Balance Codes

  サブスクリプション残高プロファイル残高コード・リソースは、残高プロファイル残高コードの表示、作成、更新および削除に使用されます。
• profileCharges: array Subscription Balance Profile Charges
  タイトル: Subscription Balance Profile Charges

  サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance profile.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The invoice rule identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The billing date code of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The name of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BillPeriodAlignDay":{
            "title":"Align Billing Day",
            "type":"integer",
            "description":"The bill period align day of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "maxLength":30,
            "type":"string",
            "description":"The invoice rule name of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the subscription balance profile.",
            "nullable":false,
            "x-queryable":true
        },
        "BillingDate":{
            "title":"Billing Date",
            "maxLength":80,
            "type":"string",
            "description":"The billing date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "groupCriteria":{
            "title":"Subscription Balance Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "BillOnDay":{
            "title":"Day",
            "type":"integer",
            "description":"The bill on day of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance profile.",
            "nullable":true,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":25,
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance profile.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "profileCharges":{
            "title":"Subscription Balance Profile Charges",
            "type":"array",
            "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileCharges-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The interface offset days of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "profileBalanceCodes":{
            "title":"Subscription Profile Balance Codes",
            "type":"array",
            "description":"The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileBalanceCodes-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance profile was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : サブスクリプション残高基準

タイプ: array

タイトル: Subscription Balance Criteria

サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。

ソースを表示

• Array of: object subscriptionBalanceProfiles-groupCriteria-item-response

{
    "title":"Subscription Balance Criteria",
    "type":"array",
    "description":"The subscription balance criteria resource is used to view a balance criteria.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-response"
    },
    "x-cardinality":"1"
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : サブスクリプション・プロファイル残高コード

タイプ: array

タイトル: Subscription Profile Balance Codes

サブスクリプション残高プロファイル残高コード・リソースは、残高プロファイル残高コードの表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object subscriptionBalanceProfiles-profileBalanceCodes-item-response

{
    "title":"Subscription Profile Balance Codes",
    "type":"array",
    "description":"The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileBalanceCodes-item-response"
    }
}

ネストされたスキーマ : サブスクリプション残高プロファイル手数料

タイプ: array

タイトル: Subscription Balance Profile Charges

サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。

ソースを表示

• Array of: object subscriptionBalanceProfiles-profileCharges-item-response

{
    "title":"Subscription Balance Profile Charges",
    "type":"array",
    "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileCharges-item-response"
    }
}

ネストされたスキーマ : subscriptionBalanceProfiles-groupCriteria-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

  サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The usage condition of subscription balance criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : サブスクリプション残高述語

タイプ: array

タイトル: Subscription Balance Predicates

サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

ソースを表示

• Array of: object subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response

{
    "title":"Subscription Balance Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : subscriptionBalanceProfiles-groupCriteria-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

  サブスクリプション残高述語のオブジェクト・バージョン番号。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria Id of subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":30,
            "type":"string",
            "description":"The sort by criterion of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance object name of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance predicate.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":600,
            "type":"string",
            "description":"The balance predicate character value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance predicate.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the subscription balance attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance predicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionBalanceProfiles-profileBalanceCodes-item-response

タイプ: object

ソースを表示

• BalanceCode: string
  タイトル: Code

  最大長: 30

  サブスクリプション残高プロファイル残高コードのバランス・コード。
• BalanceCodeDescription: string
  タイトル: Name

  読取り専用: true

  最大長: 120

  サブスクリプション・プロファイル残高コードの残高コード摘要。
• BalanceCodeId: integer (int64)
  タイトル: Balance Code

  バランス・コードの一意の識別子。
• BalanceProfileChargeId: integer (int64)
  バランス・プロファイル手数料の一意の識別子。
• BalanceProfileId: integer (int64)
  バランス・プロファイルの一意の識別子。
• 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

  サブスクリプション・プロファイル残高コードのオブジェクト・バージョン番号。
• ProfileBalanceCodeId: integer (int64)
  バランス・プロファイル・コードの一意の識別子。
• ProfileBalanceCodeNumber: string
  最大長: 120

  プロファイル残高コードの代替識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription profile balance code was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileBalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription balance profile balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription profile balance code.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance code description of the subscription profile balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile balance code was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription profile balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionBalanceProfiles-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

  サブスクリプション残高プロファイル手数料の数量単位コード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance profile charges.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasureCode":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The quantity unit of measure code of the subscription balance profile charges.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":25,
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":25,
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription profile charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

アクティブ化

操作: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/activate

パラメータ:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

このメソッドは、残高プロファイルをアクティブ化するために使用されます。

deActivate

操作: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/deActivate

パラメータ:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

このメソッドは、残高プロファイルを非アクティブ化するために使用されます。

groupCriteria

操作: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria

パラメータ:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。

profileBalanceCodes

操作: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes

パラメータ:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

サブスクリプション残高プロファイル残高コード・リソースは、残高プロファイル残高コードの表示、作成、更新および削除に使用されます。

profileCharges

操作: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges

パラメータ:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

サブスクリプション残高プロファイル料金リソースは、残高プロファイル料金の表示に使用されます。

「トップに戻る」