機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. インセンティブ報酬式
  4. 式詳細

すべての式の詳細を取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails

リクエスト

パス・パラメータ
  • これは、インセンティブ報酬式リソースのコンポジット・キー(OrgIdおよびExpressionId)を構成する属性のハッシュ・キーで、インセンティブ報酬式のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、インセンティブ報酬式の特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用してインセンティブ報酬式コレクション・リソースを問い合せる必要があります。

    次に例を示します: incentiveCompensationExpressions?q=OrgId=<value1>;ExpressionId=<value2>
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • PrimaryKey : 指定された主キーを持つリソースを検索します。
      ファインダ変数:
      • ExpressionDetailId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • DisplayValue; string;式詳細レコードの表示値。
    • ExpressionDetailId; integer; 式詳細レコードの一意の識別子。
    • ExpressionId; integer; 式レコードの一意の識別子。
    • ItemLabel; string;ラベルは、特定のパートが何をするかを説明する式の一部に与えられます。 ラベルは、式の様々な部分と式全体を解読しやすくするコメントのように動作します。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • 順序;整数;式内の式詳細レコードの順序。 これは、作成時にのみユーザーによって提供されます。 これは、式を左から右に読み取るように順次提供されるようにしてください。そうしないと、式の意味が異なります。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : incentiveCompensationExpressions-ExpressionDetails
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : incentiveCompensationExpressions-ExpressionDetails-item-response
タイプ: object
ソースを表示
  • 式詳細で使用されるプライマリ・オブジェクト属性の名前。 これは、「基本属性グループ」フィールドとともに使用されます。 BasicAttributeNameVOを使用して、使用可能な値のリストを取得します。
  • 使用される参加者、クレジット、プラン・コンポーネント、メジャーまたはプランなどのプライマリ・オブジェクトを表すカテゴリです。 このフィールドを使用する前に、ExpressionDetailType属性をプライマリ・オブジェクト属性にする必要があります。 受理可能な値のリストは、参照CN_EXPR_ATTR_MENUで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • 式で使用される定数の値。 定数には数値または文字列を指定できます。 このフィールドを使用する前に、式の詳細タイプ属性を定数にする必要があります。
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Display Value
    読取り専用: true
    最大長: 160
    式詳細レコードの表示値。
  • 式詳細レコードの一意の識別子。
  • ユーザー定義問合せ、プライマリ・オブジェクト属性、レート表レート、SQL式関数、定数、メジャー結果、プラン・コンポーネント結果、ユーザー定義関数および算術演算子などのwebサービス式のタイプ。 受理可能な値のリストは、参照タイプORA_CN_EXPRESSION_DETAIL_TYPEの参照値の意味で定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
  • 式レコードの一意の識別子。
  • タイトル: Operator
    式で使用される算術演算子。 このフィールドを使用する前に、式の詳細タイプ属性を算術演算子にする必要があります。 ExpressionOperatorVOを使用して、使用可能な値のリストを取得します。
  • 式で使用されるSQL関数。 FunctionsGroup属性の値に応じて、異なる参照を使用して、許容可能な値のリストを取得できます。 これは、FunctionsGroupフィールドとともに使用されます。 許容可能な値のリストは、参照CN_ADV_FUNCTIONS、CN_AGGR_FUNCTIONS、ORA_CN_VAL_ST_AGGRGN_FUNCTIONS、CN_COMP_FUNCTIONS、CN_NULL_FUNCTIONS、CN_NUMB_FUNCTIONS、ORA_CN_TEXT_FUNCTIONS、ORA_CN_DATE_FUNCTIONSおよびORA_CN_LOGICAL_OPERATIONSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
  • 拡張関数、集計関数、値セット集計関数、比較関数、Null関数、数値関数、テキスト関数、日付関数、論理演算など、式で使用されるSQL関数のタイプ。 このフィールドを使用する前に、式詳細タイプの属性値はSQL式関数である必要があります。 受理可能な値のリストは、参照CN_FUNCTION_TYPESで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
  • タイトル: Label
    最大長: 500
    ラベルは式の一部に与えられ、その特定の部分が何を行うかを記述します。 ラベルは、式の様々な部分と式全体を解読しやすくするコメントのように動作します。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのセッション・ログイン。
  • Links
  • タイトル: Measure
    式で結果が使用されるパフォーマンス・メジャーの名前。 このフィールドを使用する前に、式の詳細タイプ属性をメジャー結果にする必要があります。 MeasureNameVOを使用して、使用可能な値のリストを取得します。
  • 式で使用されるパフォーマンス・メジャーの結果の本質。 これは、MeasureNameフィールドとともに使用されます。 MeasureResultAttributeVOを使用して、使用可能な値のリストを取得します。
  • 式でメジャー結果が使用されるプラン・コンポーネントの名前。 このフィールドを使用する前に、PlanComponentResultAttribute属性をPlanComponentsMeasureにする必要があります。 PlanComponentMeasureNameVOを使用して、使用可能な値のリストを取得します。
  • 式で使用されるプラン・コンポーネントのメジャー結果の性質。 これは、PlanComponentMeasureNameフィールドとともに使用されます。 PlanComponentMeasureResultAttributeVOを使用して、使用可能な値のリストを取得します。
  • タイトル: Plan Component
    式で結果が使用されるプラン・コンポーネントの名前。 このフィールドを使用する前に、式の詳細タイプ属性をプラン・コンポーネント結果にする必要があります。 PlanComponentNameVOを使用して、使用可能な値のリストを取得します。
  • 式で使用されるプラン・コンポーネントの結果の性質。 これは、PlanComponentNameフィールドとともに使用されます。 PlanComponentResultAttributeVOを使用して、使用可能な値のリストを取得します。
  • タイトル: Sequence
    式内の式詳細レコードの順序。 これは、作成時にのみユーザーによって提供されます。 これは、式を左から右に読み取るように順次提供されるようにしてください。そうしないと、式の意味が異なります。
  • 式で使用されるユーザー定義関数の名前。 式詳細タイプ属性は、このフィールドを使用する前にユーザー定義関数である必要があります。 受理可能な値のリストは、参照CN_USER_FUNCTIONSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • 式で使用されるユーザー定義問合せの値セット・コードまたは参照コード。 このフィールドを使用する前に、式詳細タイプ属性値をユーザー定義問合せにする必要があります。 許容可能な値のリストは、参照ORA_CN_USR_DEFN_EXPRSN_VLE_SETで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべての式の詳細を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/00020000000EACED0005770800000000000000CC0000000EACED00057708000110F07F4E24E6/child/ExpressionDetails

レスポンス本文の例

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

{
  "items" : [ {
    "ExpressionDetailId" : 300100090733799,
    "ExpressionId" : 300100090733798,
    "CreationDate" : "2017-08-17T01:11:18.733-07:00",
    "LastUpdateLogin" : "56EF70736CD64C5CE0532DD6F00A2F6B",
    "LastUpdateDate" : "2017-08-17T01:12:16.362-07:00",
    "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "ExpressionDetailType" : "Rate table rate",
    "BasicAttributesGroup" : null,
    "BasicAttributeName" : null,
    "FunctionsGroup" : null,
    "FunctionName" : null,
    "ExpressionOperator" : null,
    "ConstantValue" : null,
    "MeasureName" : null,
    "MeasureResultAttribute" : null,
    "PlanComponentName" : null,
    "PlanComponentResultAttribute" : null,
    "PlanComponentMeasureName" : null,
    "PlanComponentMeasureResultAttribute" : null,
    "UserDefinedFunctionName" : null,
    "Sequence" : 1,
    "DisplayValue" : "Rate Table Rate",
    "links" : [ {
		....
		}
		]
},
{
    "ExpressionDetailId" : 300100090733800,
    "ExpressionId" : 300100090733798,
    "CreationDate" : "2017-08-17T01:11:18.740-07:00",
    "LastUpdateLogin" : "56EF70736CD64C5CE0532DD6F00A2F6B",
    "LastUpdateDate" : "2017-08-17T01:12:16.364-07:00",
    "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "ExpressionDetailType" : "Mathematical operator",
    "BasicAttributesGroup" : null,
    "BasicAttributeName" : null,
    "FunctionsGroup" : null,
    "FunctionName" : null,
    "ExpressionOperator" : "*",
    "ConstantValue" : null,
    "MeasureName" : null,
    "MeasureResultAttribute" : null,
    "PlanComponentName" : null,
    "PlanComponentResultAttribute" : null,
    "PlanComponentMeasureName" : null,
    "PlanComponentMeasureResultAttribute" : null,
    "UserDefinedFunctionName" : null,
    "Sequence" : 2,
    "DisplayValue" : "*",
    "links" : [ {
		...
		}
		]
},...
「トップに戻る」