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

すべての残高コードの取得

get

/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します

    • BalanceCodeAltKey特定の残高コード代替キーを含むサブスクリプション残高コードを検索します。
      ファインダ変数
      • BalanceCode; string; サブスクリプション残高コードの一意の残高コード。
    • PrimaryKey指定した主キーを持つサブスクリプション残高コードを検索します。
      ファインダ変数
      • BalanceCodeId; integer;検索に使用されるサブスクリプション残高コードの一意の残高コード識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BalanceCode; string; サブスクリプション残高の残高コード。
    • BalanceCodeDescription; string; サブスクリプション残高コードの残高コードの説明。
    • BalanceCodeId; integer; サブスクリプション残高の残高コード識別子。
    • BalanceCodeStatus; string; サブスクリプション残高コードのステータス。
    • ChargeDefinitionCode; string; サブスクリプション残高コードの料金定義コード。
    • ChargeDefinitionId; integer; サブスクリプション残高コードの料金定義識別子。
    • ConsumptionCriteriaId; integer; サブスクリプション残高コードの消費基準識別子。
    • CreatedBy; string; サブスクリプション残高コードを作成したユーザー。
    • CreationDate; string; サブスクリプション残高コードが作成された日付。
    • LastUpdateDate; string; サブスクリプション残高コードが最後に更新された日付。
    • LastUpdateLogin; string; サブスクリプション残高コードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; サブスクリプション残高コードを最後に更新したユーザー。
    • ObjectVersionNumber; integer;サブスクリプション残高コードのバージョン番号。
    • PrecisionFactor; number。サブスクリプション残高コードの精度ファクタ。
    • PrecisionType; string; サブスクリプション残高コードの精度タイプ。


    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BalanceCriteriaId; integer; サブスクリプション残高基準の一意の識別子。
    • BalanceCriteriaNumber; string; サブスクリプション残高基準の一意の番号。
    • BalanceCriteriaStatus; string; サブスクリプション残高基準のステータス。
    • BalanceCriteriaUsage; string;サブスクリプション残高基準の使用条件。
    • CreatedBy; string; サブスクリプション残高基準を作成したユーザー。
    • CreationDate; string; サブスクリプション残高基準が作成された日付。
    • LastUpdateDate; string; サブスクリプション残高基準が最後に更新された日付。
    • LastUpdateLogin; string; サブスクリプション残高基準を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; サブスクリプション残高基準を最後に更新したユーザー。
    • ObjectVersionNumber; integer; サブスクリプション残高基準のすべての更新後に更新されるオブジェクト・バージョン番号。


    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BalanceAttributeId; integer; サブスクリプション残高属性の一意の識別子。
    • BalanceAttributeName; string;サブスクリプション残高属性の名前。
    • BalanceCriteriaId; integer;サブスクリプション残高述語の残高基準ID。
    • BalanceObjectId; integer;サブスクリプション残高述語の残高オブジェクト識別子。
    • BalanceObjectName; string;サブスクリプション残高述語の残高オブジェクト名。
    • BalancePredicateCharacterValue; string;サブスクリプション残高述語の残高述語文字値。
    • BalancePredicateDateValue; string; サブスクリプション残高述語の残高述語日付値。
    • BalancePredicateDecimalValue; number;サブスクリプション残高述語の残高述語10進数値。
    • BalancePredicateId; integer;サブスクリプション残高述語の一意の識別子。
    • BalancePredicateNumber; string;サブスクリプション残高述語の一意の番号。
    • BalancePredicateNumberValue; integer;サブスクリプション残高述語の数値。
    • BalancePredicateOperator; string;サブスクリプション残高述語の演算子値。
    • BalancePredicateSequence; integer;サブスクリプション残高述語の残高述語シーケンス。
    • BalancePredicateSortBy; string; サブスクリプション残高述語の基準によるソート。
    • BalancePredicateTimeValue; string;サブスクリプション残高述語の時間値。
    • CreatedBy; string;サブスクリプション残高述語を作成したユーザー。
    • CreationDate; string;サブスクリプション残高述語が作成された日付。
    • LastUpdateDate; string;サブスクリプション残高述語が最後に更新された日付。
    • LastUpdateLogin; string; サブスクリプション・バランス述語を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; サブスクリプション残高述語を最後に更新したユーザー。
    • ObjectVersionNumber; integer;サブスクリプション残高述語のオブジェクト・バージョン番号。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionBalanceCodes
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : 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
ソースを表示
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "BalanceCodeId": 300100570194504,
            "BalanceCode": "Gold Balance Code_27Feb1",
            "BalanceCodeDescription": "balance code with Inline criteria",
            "BalanceCodeStatus": "ORA_OSS_DRAFT",
            "ConsumptionCriteriaId": 300100570194509,
            "ChargeDefinitionCode": null,
            "ChargeDefinitionId": null,
            "PrecisionType": null,
            "PrecisionFactor": null,
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2023-02-27T10:14:23+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2023-02-27T10:14:53.376+00:00",
            "LastUpdateLogin": "F5A7821916E045AEE053B4A74564ABC7",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1",
                    "name": "subscriptionBalanceCodes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1",
                    "name": "subscriptionBalanceCodes",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/child/balanceCodeCharges",
                    "name": "balanceCodeCharges",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/child/conditionCriteria",
                    "name": "conditionCriteria",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/child/consumptionCriteria",
                    "name": "consumptionCriteria",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/action/activate",
                    "name": "activate",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/action/deActivate",
                    "name": "deActivate",
                    "kind": "other"
                }
            ]
        },
        {
            "BalanceCodeId": 300100570178614,
            "BalanceCode": "Gold Balance Code_6",
            "BalanceCodeDescription": "balance code with Inline criteria",
            "BalanceCodeStatus": "ORA_OSS_ACTIVE",
            "ConsumptionCriteriaId": 300100570178618,
            "ChargeDefinitionCode": null,
            "ChargeDefinitionId": null,
            "PrecisionType": null,
            "PrecisionFactor": null,
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2023-02-24T21:35:27+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2023-02-24T21:39:33.983+00:00",
            "LastUpdateLogin": "F575378765673540E053B4A74564AA99",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_6",
                    "name": "subscriptionBalanceCodes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
...
}
「トップに戻る」