KPIの取得
get
/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}
リクエスト
パス・パラメータ
- KPINumber(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
- 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : keyPerformanceIndicators-item-response
タイプ:
ソースを表示
object
-
ConflictId: integer (int64)
デフォルト値:
0
競合ID -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
作成者 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
作成日 -
IsResourceContextFlag: boolean
タイトル:
User Context
最大長:1
ユーザー・コンテキスト -
IsSeededFlag: boolean
タイトル:
Seeded
読取り専用:true
最大長:1
デフォルト値:false
シード済 -
KPIAggregationCode: string
タイトル:
Calculation Type
最大長:200
KPI計算に使用される集計のコード。 -
KPIAggregationFact: string
タイトル:
Sum Attribute
最大長:40
集計に使用されるソース・オブジェクトの属性。 -
KPICategory: string
タイトル:
Breakup Category
最大長:40
スコアのカテゴリ・ベースの内訳に使用されるソース・オブジェクトの属性。 -
KPICategoryType: string
最大長:
40
KPIカテゴリ・タイプ。 -
KPICondition: string
タイトル:
Filter Condition
最大長:4000
KPI計算に使用されるソース・オブジェクトの条件。 -
KPICreditRecipient: string
タイトル:
Credit Recipient
最大長:100
KPIのクレジット受信者を示すソース・オブジェクトの属性。 -
KPICreditTime: string
タイトル:
Credit Date
最大長:100
KPIの適格時間を示すソース・オブジェクトの属性。 -
KPIDenomAggregationCode: string
タイトル:
Denominator Calculation Type
最大長:200
KPIの分母値の計算に使用される計算タイプ(合計や件数など)。 -
KPIDenomAggregationFact: string
タイトル:
Denominator Sum Attribute
最大長:40
KPI分母値の合計集計の計算に使用されるソース・オブジェクトのフィールド。 -
KPIDenomCreditTime: string
タイトル:
Denominator Credit Time
最大長:100
KPIの分母値の計算に使用される日付フィルタ。 -
KPIDenomRuleCondition: string
タイトル:
Denominator Rule Condition
最大長:4000
KPIの分母値の計算に使用されるJSONルール条件。 -
KPIDescription: string
タイトル:
Description
最大長:3000
摘要 -
KPIHistoryEnabledFlag: boolean
タイトル:
Enable Activity History
最大長:1
デフォルト値:true
アクティビティ履歴使用可能 -
KPIHistoryMetadata: array KPI History Metadata
タイトル:
KPI History Metadata
KPI履歴メタデータ・リソースは、KPI履歴メタデータの表示、作成、更新および削除に使用されます。 -
KPIId: integer (int64)
タイトル:
KPI ID
KPI ID -
KPIName: string
タイトル:
Name
最大長:275
名前 -
KPINumber: string
タイトル:
KPI Number
最大長:64
KPI番号 -
KPINumerAggregationCode: string
タイトル:
Numerator Calculation Type
最大長:200
KPIの分子値の計算に使用される計算タイプ(合計や件数など)。 -
KPINumerAggregationFact: string
タイトル:
Numerator Sum Attribute
最大長:40
KPI分子値の合計集計の計算に使用されるソース・オブジェクトのフィールド。 -
KPINumerCreditTime: string
タイトル:
Numerator Credit Time
最大長:100
KPIの分子値の計算に使用される日付フィルタ。 -
KPINumerRuleCondition: string
タイトル:
Numerator Rule Condition
最大長:4000
KPIの分子値の計算に使用されるJSONルール条件。 -
KPIObject: string
タイトル:
KPI Object
最大長:40
KPIオブジェクト -
KPIRuleCondition: string
タイトル:
KPI Condition Rule JSON
最大長:4000
「ルールJSON」形式のKPI条件の属性。 -
KPIStatusCode: string
タイトル:
Status
最大長:30
デフォルト値:ORA_DRAFT
KPIのステータス・コード。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
最終更新日 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
最終更新者 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
最終更新ログイン -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
オブジェクト・バージョン番号 -
UOMCode: string
最大長:
40
単位コード
ネストされたスキーマ : KPI履歴Metadata
タイプ:
array
タイトル:
KPI History Metadata
KPI履歴メタデータ・リソースは、KPI履歴メタデータの表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : keyPerformanceIndicators-KPIHistoryMetadata-item-response
タイプ:
ソースを表示
object
-
ConflictId: integer (int64)
デフォルト値:
0
競合ID -
CreatedBy: string
読取り専用:
true
最大長:64
作成者 -
CreationDate: string (date-time)
読取り専用:
true
作成日 -
KPIEventId: integer (int64)
KPIイベントの一意の識別子。
-
KPIEventName: string
最大長:
200
KPIイベントの名前。 -
KPIId: integer (int64)
KPIの一意の識別子。
-
LastUpdateDate: string (date-time)
読取り専用:
true
最終更新日 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
最終更新者 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
最終更新ログイン -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
オブジェクト・バージョン番号 -
StaticText: string
最大長:
4000
KPI履歴静的テキスト。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- KPIAggregationVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_KPI_CALC_TYPE%2CBindLookupCode%3D{KPIAggregationCode}
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: KPIAggregationCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- KPIHistoryMetadata
-
パラメータ:
- KPINumber:
$request.path.KPINumber
KPI履歴メタデータ・リソースは、KPI履歴メタデータの表示、作成、更新および削除に使用されます。 - KPINumber:
- KPIStatusVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_KPI_STATUS%2CBindLookupCode%3D{KPIStatusCode}
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: KPIStatusCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- KPIUOMVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_UNIT_OF_MEASURE%2CBindLookupCode%3D{UOMCode}
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: UOMCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ: