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

機械翻訳について

すべての集計済支給の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarnings

リクエスト

問合せパラメータ

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
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します
- PrimaryKey指定した主キーを持つ集計済支給を検索します。
  ファインダ変数
  - IntervalNumber; string;支給が計算される間隔番号。
  - IntervalTypeName; string;間隔タイプ名。
  - ParticipantId; integer;参加者の一意の識別子。
  - PlanComponentId; integer;プラン・コンポーネントの一意の識別子。
- findByDates指定した日付範囲内の集計済支給を検索します。
  ファインダ変数
  - bEndDate; string; 支給期間が終了する日付。
  - bIntervalType; string;間隔タイプの名前。
  - bStartDate; string;支給期間が開始する日付。
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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CompensationPlanId; integer;報酬プランの一意の識別子。
- CompensationPlanName; string;支給が計算される報酬プランの名前。
- CurrencyCode; string; 支給額の処理通貨を示すコード。処理通貨は、ビジネス・ユニットの営業通貨または参加者のホーム通貨として選択されます。処理通貨パラメータは、「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用してレビューできます。
- IntervalEndDate; string;間隔が終了する日付。
- IntervalNumber; string;支給が計算される間隔番号。
- IntervalStartDate; string;間隔が開始する日付。
- IntervalTypeName; string;間隔タイプ名。
- OrganizationId; integer;ビジネス・ユニットの識別子。
- ParticipantId; integer; 支給項目が計算される参加者の一意の識別子。
- ParticipantName; string;支給が計算される参加者の名前。
- PlanComponentId; integer;プラン・コンポーネントの一意の識別子。
- PlanComponentName; string;支給が計算されるプラン・コンポーネントの名前。
- TotalEarningAmount;数値;参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された支給額合計。
- TotalInputAchieved; number;参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された、達成された入力の合計。
- TotalOutputAchieved; number;参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された、達成された合計出力。
- TotalTransactionAmount;数値;参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された合計トランザクション金額。
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のデフォルト・バージョンを選択します。

ルート・スキーマ : incentiveCompensationSummarizedEarnings

タイプ: 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/incentiveCompensationSummarizedEarnings-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object incentiveCompensationSummarizedEarnings-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationSummarizedEarnings-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"
    }
}

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

タイプ: object

ソースを表示

CompensationPlanId: integer

読取り専用: true

報酬プランの一意の識別子。
CompensationPlanName: string

読取り専用: true

最大長: 80

支給が計算される報酬プランの名前。
CurrencyCode: string

読取り専用: true

支給額の処理通貨を示すコード。処理通貨は、ビジネス・ユニットの営業通貨または参加者のホーム通貨として選択されます。処理通貨パラメータは、「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用してレビューできます。
IntervalEndDate: 文字列(日付)

読取り専用: true

間隔が終了する日付。
IntervalNumber: string

読取り専用: true

支給が計算される間隔番号。
IntervalStartDate: 文字列(日付)

読取り専用: true

間隔が開始する日付。
IntervalTypeName: string

読取り専用: true

間隔タイプ名。
links: array Links

タイトル: Links

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

読取り専用: true

ビジネス・ユニットの識別子。
ParticipantId: integer

読取り専用: true

支給項目が計算される関係者の一意の識別子。
ParticipantName: string

読取り専用: true

最大長: 360

支給が計算される参加者の名前。
PlanComponentId: integer

読取り専用: true

プラン・コンポーネントの一意の識別子。
PlanComponentName: string

読取り専用: true

最大長: 80

支給項目が計算されるプラン・コンポーネントの名前。
TotalEarningAmount: number

読取り専用: true

参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された支給額合計。
TotalInputAchieved: number

読取り専用: true

参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された達成済入力合計。
TotalOutputAchieved: number

読取り専用: true

参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された達成済合計出力。
TotalTransactionAmount: number

読取り専用: true

参加者、報酬プラン、間隔およびプラン・コンポーネント別に要約された合計トランザクション金額。

{
    "type":"object",
    "properties":{
        "IntervalStartDate":{
            "type":"string",
            "description":"The date when the interval starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan for which the earnings are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant for whom the earnings are calculated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The identifier of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant for whom the earnings are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The code indicating the processing currency for the earning amount. The processing currency is selected as either the operating currency or the participant's home currency for the business unit. You can review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalEndDate":{
            "type":"string",
            "description":"The date when the interval ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalEarningAmount":{
            "type":"number",
            "description":"The total earning amount summarized by participant, compensation plan, interval, and plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalInputAchieved":{
            "type":"number",
            "description":"The total input achieved summarized by participant, compensation plan, interval, and plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalOutputAchieved":{
            "type":"number",
            "description":"The total output achieved summarized by participant, compensation plan, interval, and plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntervalTypeName":{
            "type":"string",
            "description":"The interval type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalNumber":{
            "type":"string",
            "description":"The interval number for which the earnings are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalTransactionAmount":{
            "type":"number",
            "description":"The total transaction amount summarized by participant, compensation plan, interval, and plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component for which the earnings are calculated.",
            "nullable":false,
            "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"
    }
}

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

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

「トップに戻る」