Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての式の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

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

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

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定された主キーを持つリソースを検索します。
  ファインダ変数:
  - ExpressionId; integer;ビジネス・ユニットの一意の識別子。
  - OrgId; integer;式の一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- 説明;文字列;インセンティブ報酬式の説明。
- ExpressionId; integer;式の一意の識別子。
- ExpressionType; string;式のタイプ。使用可能な値には、CALCULATIONおよびPAYMENTがあります。デフォルト値はCALCULATIONです。受理可能な値のリストは、参照CN_EXPRESSION_TYPESで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- Name; string;式の名前。
- OrgId; integer;ビジネス・ユニットの一意の識別子。
- ステータス、文字列。無効または有効、使用準備完了など、式のステータスを示します。デフォルト値はINVALIDです。許容可能な値のリストは、参照CN_EXPRESSION_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : incentiveCompensationExpressions

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object incentiveCompensationExpressions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

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

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
Description: string

タイトル: Description

最大長: 1000

インセンティブ報酬式の摘要。
式: 文字列(バイト)

タイトル: Rendered Expression

読取り専用: true

演算子、属性、関数などのすべての式コンポーネントを含む式全体。これは、主に式全体を表示するために使用されます。
ExpressionDetails: array Expression Details

タイトル: Expression Details

式詳細リソースは、式詳細の表示、作成、更新および削除に使用されます。また、式の詳細のすべての値を表示するために使用することもできます。式の詳細により、式全体がコンポーネント(関数と演算子を含む)に分割され、コンポーネント別に式コンポーネントを構築できます。新しい式詳細レコードを追加する必要がある場合は、シーケンス番号が現在のすべてのレコードより後であることを確認する必要があります。既存の式詳細レコードに一致するシーケンス番号を指定すると、一致シーケンス・レコードの後に追加され、次のすべてのレコードが下に移動します。
ExpressionId: integer (int64)

式の一意の識別子。
ExpressionType: string

タイトル: Expression Type

読取り専用: true

最大長: 30

デフォルト値: CALCULATION

式のタイプ。使用可能な値には、CALCULATIONおよびPAYMENTがあります。デフォルト値はCALCULATIONです。受理可能な値のリストは、参照CN_EXPRESSION_TYPESで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ExpressionUsages: array Expression Usages

タイトル: Expression Usages

式の使用状況リソースは、式の使用方法を表示するために使用されます。有効な式の使用が自動的に作成されます。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのセッション・ログイン。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 160

式の名前。
OrgId: integer (int64)

タイトル: Business Unit

ビジネス・ユニットの一意の識別子。
Status: string

タイトル: Status

読取り専用: true

最大長: 30

デフォルト値: INVALID

無効または有効、使用準備完了など、式のステータスを示します。デフォルト値はINVALIDです。許容可能な値のリストは、参照CN_EXPRESSION_STATUSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the expression, such as invalid or valid and ready for use. The default value is INVALID. A list of acceptable values is defined in the lookup CN_EXPRESSION_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "default":"INVALID",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionUsages":{
            "title":"Expression Usages",
            "type":"array",
            "description":"The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionUsages-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the incentive compensation expression.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionDetails":{
            "title":"Expression Details",
            "type":"array",
            "description":"The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component.\nIf a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionDetails-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":160,
            "type":"string",
            "description":"The name for the expression.",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Expression":{
            "title":"Rendered Expression",
            "type":"string",
            "description":"The entire expression with all the expression components like operators, attributes, functions, etc. This is used primarily to display the entire expression.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionType":{
            "title":"Expression Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the expression. Possible values include CALCULATION and PAYMENT. The default value is CALCULATION. A list of acceptable values is defined in the lookup CN_EXPRESSION_TYPES. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"CALCULATION",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier of the expression.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 式詳細

タイプ: array

タイトル: Expression Details

式詳細リソースは、式詳細の表示、作成、更新および削除に使用されます。また、式の詳細のすべての値を表示するために使用することもできます。式の詳細により、式全体がコンポーネント(関数と演算子を含む)に分割され、コンポーネント別に式コンポーネントを構築できます。新しい式詳細レコードを追加する必要がある場合は、シーケンス番号が現在のすべてのレコードより後であることを確認する必要があります。既存の式詳細レコードに一致するシーケンス番号を指定すると、一致シーケンス・レコードの後に追加され、次のすべてのレコードが下に移動します。

ソースを表示

Array of: object incentiveCompensationExpressions-ExpressionDetails-item-response

{
    "title":"Expression Details",
    "type":"array",
    "description":"The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component.\nIf a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionDetails-item-response"
    }
}

ネストされたスキーマ : 式の使用

タイプ: array

タイトル: Expression Usages

式の使用状況リソースは、式の使用方法を表示するために使用されます。有効な式の使用が自動的に作成されます。

ソースを表示

Array of: object incentiveCompensationExpressions-ExpressionUsages-item-response

{
    "title":"Expression Usages",
    "type":"array",
    "description":"The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressions-ExpressionUsages-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : incentiveCompensationExpressions-ExpressionDetails-item-response

タイプ: object

ソースを表示

BasicAttributeName: string

式詳細で使用されるプライマリ・オブジェクト属性の名前。これは、「基本属性グループ」フィールドとともに使用されます。 BasicAttributeNameVOを使用して、使用可能な値のリストを取得します。
BasicAttributesGroup: string

使用される参加者、クレジット、プラン・コンポーネント、メジャーまたはプランなどのプライマリ・オブジェクトを表すカテゴリです。このフィールドを使用する前に、ExpressionDetailType属性をプライマリ・オブジェクト属性にする必要があります。受理可能な値のリストは、参照CN_EXPR_ATTR_MENUで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
ConstantValue: string

式で使用される定数の値。定数には数値または文字列を指定できます。このフィールドを使用する前に、式の詳細タイプ属性を定数にする必要があります。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
DisplayValue: string

タイトル: Display Value

読取り専用: true

最大長: 160

式詳細レコードの表示値。
ExpressionDetailId: integer (int64)

式詳細レコードの一意の識別子。
ExpressionDetailType: string

ユーザー定義問合せ、プライマリ・オブジェクト属性、レート表レート、SQL式関数、定数、メジャー結果、プラン・コンポーネント結果、ユーザー定義関数および算術演算子などのwebサービス式のタイプ。受理可能な値のリストは、参照タイプORA_CN_EXPRESSION_DETAIL_TYPEの参照値の意味で定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
ExpressionId: integer (int64)

式レコードの一意の識別子。
ExpressionOperator: string

タイトル: Operator

式で使用される算術演算子。このフィールドを使用する前に、式の詳細タイプ属性を算術演算子にする必要があります。 ExpressionOperatorVOを使用して、使用可能な値のリストを取得します。
FunctionName: string

式で使用される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で定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
FunctionsGroup: string

拡張関数、集計関数、値セット集計関数、比較関数、Null関数、数値関数、テキスト関数、日付関数、論理演算など、式で使用されるSQL関数のタイプ。このフィールドを使用する前に、式詳細タイプの属性値はSQL式関数である必要があります。受理可能な値のリストは、参照CN_FUNCTION_TYPESで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。
ItemLabel: string

タイトル: Label

最大長: 500

ラベルは式の一部に与えられ、その特定の部分が何を行うかを記述します。ラベルは、式の様々な部分と式全体を解読しやすくするコメントのように動作します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのセッション・ログイン。
links: array Links

タイトル: Links

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

タイトル: Measure

式で結果が使用されるパフォーマンス・メジャーの名前。このフィールドを使用する前に、式の詳細タイプ属性をメジャー結果にする必要があります。 MeasureNameVOを使用して、使用可能な値のリストを取得します。
MeasureResultAttribute: string

式で使用されるパフォーマンス・メジャーの結果の本質。これは、MeasureNameフィールドとともに使用されます。 MeasureResultAttributeVOを使用して、使用可能な値のリストを取得します。
PlanComponentMeasureName: string

式でメジャー結果が使用されるプラン・コンポーネントの名前。このフィールドを使用する前に、PlanComponentResultAttribute属性をPlanComponentsMeasureにする必要があります。 PlanComponentMeasureNameVOを使用して、使用可能な値のリストを取得します。
PlanComponentMeasureResultAttribute: string

式で使用されるプラン・コンポーネントのメジャー結果の性質。これは、PlanComponentMeasureNameフィールドとともに使用されます。 PlanComponentMeasureResultAttributeVOを使用して、使用可能な値のリストを取得します。
PlanComponentName: string

タイトル: Plan Component

式で結果が使用されるプラン・コンポーネントの名前。このフィールドを使用する前に、式の詳細タイプ属性をプラン・コンポーネント結果にする必要があります。 PlanComponentNameVOを使用して、使用可能な値のリストを取得します。
PlanComponentResultAttribute: string

式で使用されるプラン・コンポーネントの結果の性質。これは、PlanComponentNameフィールドとともに使用されます。 PlanComponentResultAttributeVOを使用して、使用可能な値のリストを取得します。
順序: 整数(int32)

タイトル: Sequence

式内の式詳細レコードの順序。これは、作成時にのみユーザーによって提供されます。これは、式を左から右に読み取るように順次提供されるようにしてください。そうしないと、式の意味が異なります。
UserDefinedFunctionName: string

式で使用されるユーザー定義関数の名前。式詳細タイプ属性は、このフィールドを使用する前にユーザー定義関数である必要があります。受理可能な値のリストは、参照CN_USER_FUNCTIONSで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
UserDefinedQueryName: string

式で使用されるユーザー定義問合せの値セット・コードまたは参照コード。このフィールドを使用する前に、式詳細タイプ属性値をユーザー定義問合せにする必要があります。許容可能な値のリストは、参照ORA_CN_USR_DEFN_EXPRSN_VLE_SETで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新できます。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionDetailType":{
            "type":"string",
            "description":"The type of the web service expression, such as User defined query, Primary object attribute, Rate table rate, SQL expression function, Constant, Measure result, Plan component result, User defined function, and Math operator. A list of acceptable values is defined in the meaning of the look up values of lookup type ORA_CN_EXPRESSION_DETAIL_TYPE. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExpressionOperator":{
            "title":"Operator",
            "type":"string",
            "description":"The mathematical operator used in the expression. The expression detail type attribute should be Mathematical Operator before using this field. Use ExpressionOperatorVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FunctionName":{
            "type":"string",
            "description":"The SQL function used in the expression. Depending on the value of the FunctionsGroup attribute, a different lookup can be used to get a list of acceptable values. It is used in conjunction with the FunctionsGroup field. A list of acceptable values is defined in the lookup 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, and ORA_CN_LOGICAL_OPERATIONS. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserDefinedQueryName":{
            "type":"string",
            "description":"The value set code or lookup code of the user defined queries used in expressions. Before using this field, the Expression Detail Type attribute value must be User Defined Query. A list of acceptable values is defined in the lookup ORA_CN_USR_DEFN_EXPRSN_VLE_SET. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "FunctionsGroup":{
            "type":"string",
            "description":"The type of SQL functions used in the expression, such as Advanced functions, Aggregate functions, Value Set Aggregate functions, Comparison functions, Null functions, Number functions, Text functions, Date functions, or Logical operations. Before using this field, the Expression Detail Type attribute value must be SQL Expression Function. A list of acceptable values is defined in the lookup CN_FUNCTION_TYPES. You can review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentResultAttribute":{
            "type":"string",
            "description":"The nature of the result of the plan component used in the expression. It is used in conjunction with the PlanComponentName field. Use PlanComponentResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PlanComponentName"
                ]
            }
        },
        "BasicAttributeName":{
            "type":"string",
            "description":"The name of the primary object attribute used in the expression detail. It is used in conjunction with the Basic Attributes Group field. Use BasicAttributeNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier for the expression record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentMeasureResultAttribute":{
            "type":"string",
            "description":"The nature of the plan component's measure result used in the expression. It is used in conjunction with the PlanComponentMeasureName field. Use PlanComponentMeasureResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayValue":{
            "title":"Display Value",
            "maxLength":160,
            "type":"string",
            "description":"The display value of the expression detail record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureName":{
            "title":"Measure",
            "type":"string",
            "description":"The name of the performance measure whose result is used in the expression. The expression detail type attribute should be Measure Result before using this field. Use MeasureNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpressionDetailId":{
            "type":"integer",
            "description":"The unique identifier for the expression detail record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the expression detail record within the expression. This is provided by the user only during Create. Do ensure, this is provided sequentially as you would read the expression from left to right or else the expression will have a different meaning.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanComponentMeasureName":{
            "type":"string",
            "description":"The name of the plan component whose measure result is used in the expression. The PlanComponentResultAttribute attribute should be PlanComponentsMeasure before using this field. Use PlanComponentMeasureNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PlanComponentName"
                ]
            }
        },
        "UserDefinedFunctionName":{
            "type":"string",
            "description":"The name of the user defined functions used in expressions. The expression detail type attribute should be User defined function before using this field. A list of acceptable values is defined in the lookup CN_USER_FUNCTIONS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BasicAttributesGroup":{
            "type":"string",
            "description":"The category that represents the primary objects like participant, credit, plan component, measure, or plan used. The ExpressionDetailType attribute should be Primary object attribute before using this field. A list of acceptable values is defined in the lookup CN_EXPR_ATTR_MENU. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConstantValue":{
            "type":"string",
            "description":"The value of the constant used in the expression. A constant could be a number or a string. The expression detail type attribute should be Constant before using this field.",
            "nullable":true,
            "x-queryable":false
        },
        "MeasureResultAttribute":{
            "type":"string",
            "description":"The nature of the result of the performance measure used in the expression. It is used in conjunction with the MeasureName field. Use MeasureResultAttributeVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureName"
                ]
            }
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "type":"string",
            "description":"The name of the plan component whose result will be used in the expression. The expression detail type attribute should be Plan Component Result before using this field. Use PlanComponentNameVO to get the list of acceptable values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ExpressionDetailType"
                ]
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLabel":{
            "title":"Label",
            "maxLength":500,
            "type":"string",
            "description":"The label is given to part of an expression to describe what that specific part does. Labels act like comments which make it easy to decipher different parts of the expression and the overall expression.",
            "nullable":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"
    }
}

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

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

ネストされたスキーマ : incentiveCompensationExpressions-ExpressionUsages-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
ExpressionId: integer (int64)

ビジネス・ユニットに関連付けられた式の一意の識別子。
ExpressionName: string

タイトル: Name

読取り専用: true

最大長: 160

式の名前。
ExpressionUsageId: integer (int64)

式使用の一意の識別子。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのセッション・ログイン。
links: array Links

タイトル: Links

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

タイトル: Usage

最大長: 30

グループ単位メジャーの入力式など、式を使用できる場所を表す参照コード。許容可能な値のリストは、参照タイプCN_EXPRESSION_USAGEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
UsageName: string

タイトル: Usage

読取り専用: true

最大長: 80

式を正しく使用できる場所をユーザーに指示する使用レコード。許容可能な値のリストは、参照タイプCN_EXPRESSION_USAGEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that represents where the expression can be used, such as an input expression for a group by measure. A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionUsageId":{
            "type":"integer",
            "description":"The unique identifier for the expression usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionName":{
            "title":"Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageName":{
            "title":"Usage",
            "maxLength":80,
            "type":"string",
            "description":"The usage record that tells the user where the expression can be used correctly.  A list of acceptable values is defined in the lookup type CN_EXPRESSION_USAGE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionId":{
            "type":"integer",
            "description":"The unique identifier for the expression associated with a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
  "items" : [ {
    "Description" : null,
    "ExpressionType" : "CALCULATION",
    "OrgId" : 204,
    "ExpressionId" : 300100052331483,
    "Name" : "CN QA group by measure with RTR. ITD output",
    "Status" : "VALID",
    "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "CreationDate" : "2015-03-19T09:27:00.442-07:00",
    "LastUpdateDate" : "2015-03-19T09:28:58.719-07:00",
    "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "LastUpdateLogin" : "11A5144D82455BB8E0531833F40A4416",
    "links" : [ {
		...
			}
		]
	},
	{
    "Description" : "S100_PC_OUTPUT_EXP_170817010141423",
    "ExpressionType" : "CALCULATION",
    "OrgId" : 204,
    "ExpressionId" : 300100090733798,
    "Name" : "S100_PC_OUTPUT_EXP_170817010141423",
    "Status" : "VALID",
    "CreatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "CreationDate" : "2017-08-17T01:11:01-07:00",
    "LastUpdateDate" : "2017-08-17T01:12:16.450-07:00",
    "LastUpdatedBy" : "OIC_PLAN_ADMIN_OPERATIONS",
    "LastUpdateLogin" : "56EF70736CD64C5CE0532DD6F00A2F6B",
    "links" : [ {
		...
			}
		]
	},...

「トップに戻る」