機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サブスクリプション残高コード

残高コードの更新

patch

/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
ネストされたスキーマ : サブスクリプション残高基準
タイプ: array
タイトル: Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : サブスクリプション残高基準
タイプ: array
タイトル: Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
ソースを表示
ネストされたスキーマ : サブスクリプション残高述語
タイプ: array
タイトル: Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-patch-request
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionBalanceCodes-consumptionCriteria-item-patch-request
タイプ: object
ソースを表示
ネストされたスキーマ : サブスクリプション残高述語
タイプ: array
タイトル: Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
ソースを表示
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionBalanceCodes-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : サブスクリプション残高基準
タイプ: array
タイトル: Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : サブスクリプション残高基準
タイプ: array
タイトル: Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionBalanceCodes-conditionCriteria-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : サブスクリプション残高述語
タイプ: array
タイトル: Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionBalanceCodes-consumptionCriteria-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : サブスクリプション残高述語
タイプ: array
タイトル: Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : subscriptionBalanceCodes-consumptionCriteria-subscriptionBalancePredicates-item-response
タイプ: object
ソースを表示
リンク
BalanceCodePrecisionTypeVA
パラメータ:
  • ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_PRECISION_TYPE
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: PrecisionType;ターゲット属性: LookupCode
  • 表示属性: 意味
BalanceCodeStatusVA
パラメータ:
  • ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_MGMT_SETUP_STS
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: BalanceCodeStatus;ターゲット属性: LookupCode
  • 表示属性: 意味
アクティブ化
パラメータ:
  • subscriptionBalanceCodes_Id: $request.path.subscriptionBalanceCodes_Id
conditionCriteria
パラメータ:
  • subscriptionBalanceCodes_Id: $request.path.subscriptionBalanceCodes_Id
consumptionCriteria
パラメータ:
  • subscriptionBalanceCodes_Id: $request.path.subscriptionBalanceCodes_Id
deActivate
パラメータ:
  • subscriptionBalanceCodes_Id: $request.path.subscriptionBalanceCodes_Id
トップに戻る

例:

次の例は、RESTリソースに対してPATCHリクエストを発行して残高コードを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionBalanceCodes/Silver Balance Code 17jan_7  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。 
{
    "BalanceCodeDescription": "The balance code with inline criteria"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "BalanceCodeId": 300100570199607,
    "BalanceCode": "Silver Balance Code 17jan_7",
    "BalanceCodeDescription": "The balance code with inline criteria",
    "BalanceCodeStatus": "ORA_OSS_DRAFT",
    "ConsumptionCriteriaId": 300100570199610,
    "ChargeDefinitionCode": "MOBILE_CHARGE",
    "ChargeDefinitionId": 300100542702863,
    "PrecisionType": null,
    "PrecisionFactor": null,
    "ObjectVersionNumber": 2,
    "CreatedBy": "CONMGR",
    "CreationDate": "2023-02-28T12:07:21+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2023-02-28T12:13:57+00:00",
    "LastUpdateLogin": "F5BDBD9017214D2EE053B4A745641903",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7",
            "name": "subscriptionBalanceCodes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7",
            "name": "subscriptionBalanceCodes",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/child/balanceCodeCharges",
            "name": "balanceCodeCharges",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/child/conditionCriteria",
            "name": "conditionCriteria",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/child/consumptionCriteria",
            "name": "consumptionCriteria",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/action/activate",
            "name": "activate",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/action/deActivate",
            "name": "deActivate",
            "kind": "other"
        }
    ]
}
「トップに戻る」