すべてのクレジット・カテゴリの取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories
リクエスト
パス・パラメータ
- PerformanceMeasureId(required): integer(int64)
パフォーマンス・メジャーの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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 : 指定された主キーを持つリソースを検索します。
ファインダ変数:- PerformanceMeasureCreditCategoryId; integer; パフォーマンス・メジャーに関連付けられたクレジット・カテゴリの一意の識別子。
- PrimaryKey : 指定された主キーを持つリソースを検索します。
- 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; レコードが作成された日時。
- CreditCategoryId; integer;クレジット・カテゴリの一意の識別子。
- CreditCategoryName; string;クレジット・カテゴリの名前。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- PerformanceMeasureCreditCategoryId; integer; パフォーマンス・メジャーのクレジット・カテゴリを表す一意の識別子。
- PerformanceMeasureId; integer; パフォーマンス・メジャーの一意の識別子。
- PerformanceMeasureName; string; パフォーマンス・メジャーの名前。指定した結果または目標に対する進捗を測定するために使用されるインジケータです。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CreditCategoryId: integer (int64)
タイトル:
Credit Category ID
クレジット・カテゴリの一意の識別子。 -
CreditCategoryName: string
タイトル:
Credit Category Name
最大長:160
クレジット・カテゴリの名前。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PerformanceMeasureCreditCategoriesUpdateFlag: boolean
読取り専用:
true
デフォルト値:false
クレジット・カテゴリを更新できるかどうかを示します。 -
PerformanceMeasureCreditCategoryId: integer (int64)
パフォーマンス・メジャーのクレジット・カテゴリを表す一意の識別子。
-
performanceMeasureCreditFactors: array Credit Factors
タイトル:
Credit Factors
与信ファクタ・リソースは、パフォーマンス・メジャーに関連付けられたクレジット・カテゴリ内のクレジット・ファクタまたは支給ファクタを表示、作成、更新および削除するために使用されます。 クレジット・ファクタは、クレジット・カテゴリ・レベルで一定期間、販売実績へのアップ・リフトを適用するために使用されます。 支給ファクタは、クレジット・カテゴリ・レベルの営業利益に一定期間アップ・リフトを適用するために使用されます。 -
PerformanceMeasureId: integer (int64)
タイトル:
Performance Measure ID
パフォーマンス・メジャーの一意の識別子。 -
PerformanceMeasureName: string
タイトル:
Performance Measure Name
読取り専用:true
最大長:80
パフォーマンス・メジャーの名前。指定した結果または目標に対する進捗を測定するために使用されるインジケータです。 -
performanceMeasureTransactionFactors: array Transaction Factors
タイトル:
Transaction Factors
トランザクション・ファクタ・リソースは、パフォーマンス・メジャー・クレジット・カテゴリに関連付けられたトランザクション・ファクタを表示、作成、更新および削除するために使用されます。 トランザクション・ファクタは、営業ステージ(請求書作成、購買オーダー・ステージなど)が販売実績に与える影響を決定するために使用されます。
ネストされたスキーマ : クレジット・ファクタ
タイプ:
array
タイトル:
Credit Factors
与信ファクタ・リソースは、パフォーマンス・メジャーに関連付けられたクレジット・カテゴリ内のクレジット・ファクタまたは支給ファクタを表示、作成、更新および削除するために使用されます。 クレジット・ファクタは、クレジット・カテゴリ・レベルで一定期間、販売実績へのアップ・リフトを適用するために使用されます。 支給ファクタは、クレジット・カテゴリ・レベルの営業利益に一定期間アップ・リフトを適用するために使用されます。
ソースを表示
ネストされたスキーマ : トランザクション・ファクタ
タイプ:
array
タイトル:
Transaction Factors
トランザクション・ファクタ・リソースは、パフォーマンス・メジャー・クレジット・カテゴリに関連付けられたトランザクション・ファクタを表示、作成、更新および削除するために使用されます。 トランザクション・ファクタは、営業ステージ(請求書作成、購買オーダー・ステージなど)が販売実績に与える影響を決定するために使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CreditFactor: number
タイトル:
Credit Factor
デフォルト値:100
クレジット・カテゴリ・レベルで指定された期間における、トランザクション・クレジットに適用されるアップ・リフトの比率。 特定のクレジット・カテゴリについて、一定期間における達成を促進するのに役立ちます。 デフォルト値は100です。 -
EarningFactor: number
タイトル:
Earning Factor
デフォルト値:100
クレジット・カテゴリ・レベルで指定された期間における、支給項目に適用されるアップ・リフトの比率。 特定のクレジット・カテゴリについて、一定期間支給額の増額に役立ちます。 デフォルト値は100です。 -
EndDate: 文字列(日付)
タイトル:
End Date
パフォーマンス・メジャー内のクレジット・カテゴリに指定されたクレジット・ファクタおよび支給ファクタが非アクティブになる日付。 書式はyyyy-mm-ddです。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PerformanceMeasureCreditCategoryId: integer (int64)
パフォーマンス・メジャーのクレジット・カテゴリの一意の識別子。
-
PerformanceMeasureCreditFactorId: integer (int64)
パフォーマンス・メジャーのクレジット・ファクタの一意の識別子。
-
StartDate: 文字列(日付)
タイトル:
Start Date
パフォーマンス・メジャー内のクレジット・カテゴリに指定されたクレジット・ファクタおよび支給ファクタがアクティブになる日付。 書式はyyyy-mm-ddです。
ネストされたスキーマ : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CreditCategoryId: 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
リソース・インスタンスに関連付けられたリンク関係。 -
PerformanceMeasureCreditCategoryId: integer (int64)
パフォーマンス・メジャーのクレジット・カテゴリの一意の識別子。
-
PerformanceMeasureId: integer (int64)
パフォーマンス・メジャー・レコードの一意の識別子。
-
PerformanceMeasureTransactionFactorId: integer (int64)
パフォーマンス・メジャーのトランザクション・ファクタ・レコードの一意の識別子。
-
TransactionFactor: number
タイトル:
Factor
デフォルト値:100
計算に考慮されるトランザクション金額のパーセント。 これは、販売の存続期間にわたって販売実績をステージングし、受注、請求書、支払などの販売プロセスの重要なイベントに割合を割り当てるために役立ちます。 デフォルト値は100です。 -
TransactionType: string
タイトル:
Transaction Type
最大長:30
トランザクションのタイプ。 指定可能な値には、ク・ロー・バック・トランザクション・タイプのCLAWBACK、顧客満足トランザクション・タイプのCUSTOMER_SATISFACTION、計算プロセス中にアプリケーションでレコードごとにグループを作成するGRP、請求書トランザクション・タイプのINVOICE、MANUALなどがあります手動トランザクション・タイプ、オーダー・トランザクション・タイプのORDER、支払トランザクション・タイプのPAYMENT、売掛/未収金収益修正トランザクション・タイプのRAM_ADJUSTMENT、および計算プロセス中にインターバル累計レコードが作成されるITD。 受理可能な値のリストは、参照CN_TP_TRANSACTION_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのクレジット・カテゴリを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureCreditCategories
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "PerformanceMeasureCreditCategoryId": 300100090511047, "PerformanceMeasureId": 300100090511017, "CreditCategoryId": 300100014492923, "PerformanceMeasureName": "Sales Attainment 2016", "CreditCategoryName": "Envoy Deluxe AS72111 20121226072341", "LastUpdateDate": "2017-06-08T11:43:22.130-07:00", "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-08T11:43:22-07:00", "PerformanceMeasureCreditCategoriesUpdateFlag": null, "links": [ ... ] } ,... ] }