機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

KPIの作成

post

/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  競合ID
• IsResourceContextFlag: boolean
  タイトル: User Context

  最大長: 1

  ユーザー・コンテキスト
• 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(required): 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のステータス・コード。
• UOMCode: string
  最大長: 40

  単位コード

{
    "required":[
        "KPIName"
    ],
    "type":"object",
    "properties":{
        "KPIDenomAggregationFact":{
            "title":"Denominator Sum Attribute",
            "maxLength":40,
            "type":"string",
            "description":"The field on source object used to calculate the sum aggregation for KPI denominator value.",
            "nullable":true
        },
        "KPICreditTime":{
            "title":"Credit Date",
            "maxLength":100,
            "type":"string",
            "description":"The attribute on the source object that indicates the qualifying time for the KPI.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPINumerRuleCondition":{
            "title":"Numerator Rule Condition",
            "maxLength":4000,
            "type":"string",
            "description":"The JSON rule condition used to calculate the numerator value of the KPI.",
            "nullable":true
        },
        "KPIDenomAggregationCode":{
            "title":"Denominator Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"The calculation type used for calculating the denominator value of the KPI such as Sum or Count.",
            "nullable":true
        },
        "KPIDenomRuleCondition":{
            "title":"Denominator Rule Condition",
            "maxLength":4000,
            "type":"string",
            "description":"The JSON rule condition used for calculating denominator value of the KPI.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "KPIHistoryMetadata":{
            "title":"KPI History Metadata",
            "type":"array",
            "description":"The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.",
            "items":{
                "$ref":"#/components/schemas/keyPerformanceIndicators-KPIHistoryMetadata-item-post-request"
            }
        },
        "KPIName":{
            "title":"Name",
            "maxLength":275,
            "type":"string",
            "description":"Name",
            "nullable":false
        },
        "KPIStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the KPI.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPIObject":{
            "title":"KPI Object",
            "maxLength":40,
            "type":"string",
            "description":"KPI Object",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPICategoryType":{
            "maxLength":40,
            "type":"string",
            "description":"The KPI category type.",
            "nullable":true
        },
        "KPIDenomCreditTime":{
            "title":"Denominator Credit Time",
            "maxLength":100,
            "type":"string",
            "description":"The date filter used for calculating denominator value of the KPI.",
            "nullable":true
        },
        "KPINumerCreditTime":{
            "title":"Numerator Credit Time",
            "maxLength":100,
            "type":"string",
            "description":"The date filter used to calculate the numerator value of the KPI.",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPINumerAggregationCode":{
            "title":"Numerator Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"The calculation type used to calculate the numerator value of the KPI such as Sum or Count.",
            "nullable":true
        },
        "KPIRuleCondition":{
            "title":"KPI Condition Rule JSON",
            "maxLength":4000,
            "type":"string",
            "description":"The attribute for the KPI condition in Rule JSON format.",
            "nullable":true
        },
        "KPINumerAggregationFact":{
            "title":"Numerator Sum Attribute",
            "maxLength":40,
            "type":"string",
            "description":"The field on source object used for calculating sum aggregation for KPI numerator value.",
            "nullable":true
        },
        "KPINumber":{
            "title":"KPI Number",
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false
        },
        "KPICreditRecipient":{
            "title":"Credit Recipient",
            "maxLength":100,
            "type":"string",
            "description":"The attribute on the source object that indicates the credit recipient for the KPI.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPICondition":{
            "title":"Filter Condition",
            "maxLength":4000,
            "type":"string",
            "description":"The condition on the source object used for KPI calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPIDescription":{
            "title":"Description",
            "maxLength":3000,
            "type":"string",
            "description":"Description",
            "nullable":true
        },
        "IsResourceContextFlag":{
            "title":"User Context",
            "maxLength":1,
            "type":"boolean",
            "description":"User Context",
            "nullable":true
        },
        "KPICategory":{
            "title":"Breakup Category",
            "maxLength":40,
            "type":"string",
            "description":"The attribute on the source object used for category based breakdown of scores.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPIHistoryEnabledFlag":{
            "title":"Enable Activity History",
            "maxLength":1,
            "type":"boolean",
            "description":"Enable Activity History",
            "nullable":false,
            "default":true
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "KPIAggregationCode":{
            "title":"Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"The code of aggregation used for KPI calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KPIAggregationFact":{
            "title":"Sum Attribute",
            "maxLength":40,
            "type":"string",
            "description":"The attribute on the source object used for aggregations.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : KPI履歴Metadata

タイプ: array

タイトル: KPI History Metadata

KPI履歴メタデータ・リソースは、KPI履歴メタデータの表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object keyPerformanceIndicators-KPIHistoryMetadata-item-post-request

{
    "title":"KPI History Metadata",
    "type":"array",
    "description":"The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.",
    "items":{
        "$ref":"#/components/schemas/keyPerformanceIndicators-KPIHistoryMetadata-item-post-request"
    }
}

ネストされたスキーマ : keyPerformanceIndicators-KPIHistoryMetadata-item-post-request

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  競合ID
• KPIEventId: integer (int64)
  KPIイベントの一意の識別子。
• KPIEventName: string
  最大長: 200

  KPIイベントの名前。
• KPIId: integer (int64)
  KPIの一意の識別子。
• StaticText: string
  最大長: 4000

  KPI履歴静的テキスト。

{
    "type":"object",
    "properties":{
        "KPIEventId":{
            "type":"integer",
            "description":"The unique identifier of the KPI event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "KPIId":{
            "type":"integer",
            "description":"The unique identifier of the KPI.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "KPIEventName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the KPI event.",
            "nullable":true
        },
        "StaticText":{
            "maxLength":4000,
            "type":"string",
            "description":"The KPI history static text.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• 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

  単位コード

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIDenomAggregationFact":{
            "title":"Denominator Sum Attribute",
            "maxLength":40,
            "type":"string",
            "description":"The field on source object used to calculate the sum aggregation for KPI denominator value.",
            "nullable":true,
            "x-queryable":true
        },
        "KPICreditTime":{
            "title":"Credit Date",
            "maxLength":100,
            "type":"string",
            "description":"The attribute on the source object that indicates the qualifying time for the KPI.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KPINumerRuleCondition":{
            "title":"Numerator Rule Condition",
            "maxLength":4000,
            "type":"string",
            "description":"The JSON rule condition used to calculate the numerator value of the KPI.",
            "nullable":true,
            "x-queryable":true
        },
        "KPIDenomAggregationCode":{
            "title":"Denominator Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"The calculation type used for calculating the denominator value of the KPI such as Sum or Count.",
            "nullable":true,
            "x-queryable":true
        },
        "KPIDenomRuleCondition":{
            "title":"Denominator Rule Condition",
            "maxLength":4000,
            "type":"string",
            "description":"The JSON rule condition used for calculating denominator value of the KPI.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIHistoryMetadata":{
            "title":"KPI History Metadata",
            "type":"array",
            "description":"The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.",
            "items":{
                "$ref":"#/components/schemas/keyPerformanceIndicators-KPIHistoryMetadata-item-response"
            }
        },
        "KPIName":{
            "title":"Name",
            "maxLength":275,
            "type":"string",
            "description":"Name",
            "nullable":false,
            "x-queryable":true
        },
        "KPIStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the KPI.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "KPIObject":{
            "title":"KPI Object",
            "maxLength":40,
            "type":"string",
            "description":"KPI Object",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "KPICategoryType":{
            "maxLength":40,
            "type":"string",
            "description":"The KPI category type.",
            "nullable":true,
            "x-queryable":true
        },
        "KPIDenomCreditTime":{
            "title":"Denominator Credit Time",
            "maxLength":100,
            "type":"string",
            "description":"The date filter used for calculating denominator value of the KPI.",
            "nullable":true,
            "x-queryable":true
        },
        "KPINumerCreditTime":{
            "title":"Numerator Credit Time",
            "maxLength":100,
            "type":"string",
            "description":"The date filter used to calculate the numerator value of the KPI.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KPINumerAggregationCode":{
            "title":"Numerator Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"The calculation type used to calculate the numerator value of the KPI such as Sum or Count.",
            "nullable":true,
            "x-queryable":true
        },
        "KPIRuleCondition":{
            "title":"KPI Condition Rule JSON",
            "maxLength":4000,
            "type":"string",
            "description":"The attribute for the KPI condition in Rule JSON format.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumerAggregationFact":{
            "title":"Numerator Sum Attribute",
            "maxLength":40,
            "type":"string",
            "description":"The field on source object used for calculating sum aggregation for KPI numerator value.",
            "nullable":true,
            "x-queryable":true
        },
        "KPINumber":{
            "title":"KPI Number",
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICreditRecipient":{
            "title":"Credit Recipient",
            "maxLength":100,
            "type":"string",
            "description":"The attribute on the source object that indicates the credit recipient for the KPI.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KPICondition":{
            "title":"Filter Condition",
            "maxLength":4000,
            "type":"string",
            "description":"The condition on the source object used for KPI calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KPIDescription":{
            "title":"Description",
            "maxLength":3000,
            "type":"string",
            "description":"Description",
            "nullable":true,
            "x-queryable":true
        },
        "IsResourceContextFlag":{
            "title":"User Context",
            "maxLength":1,
            "type":"boolean",
            "description":"User Context",
            "nullable":true,
            "x-queryable":true
        },
        "IsSeededFlag":{
            "title":"Seeded",
            "maxLength":1,
            "type":"boolean",
            "description":"Seeded",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "KPICategory":{
            "title":"Breakup Category",
            "maxLength":40,
            "type":"string",
            "description":"The attribute on the source object used for category based breakdown of scores.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KPIHistoryEnabledFlag":{
            "title":"Enable Activity History",
            "maxLength":1,
            "type":"boolean",
            "description":"Enable Activity History",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIAggregationCode":{
            "title":"Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"The code of aggregation used for KPI calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KPIAggregationFact":{
            "title":"Sum Attribute",
            "maxLength":40,
            "type":"string",
            "description":"The attribute on the source object used for aggregations.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : KPI履歴Metadata

タイプ: array

タイトル: KPI History Metadata

KPI履歴メタデータ・リソースは、KPI履歴メタデータの表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object keyPerformanceIndicators-KPIHistoryMetadata-item-response

{
    "title":"KPI History Metadata",
    "type":"array",
    "description":"The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.",
    "items":{
        "$ref":"#/components/schemas/keyPerformanceIndicators-KPIHistoryMetadata-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"
    }
}

ネストされたスキーマ : 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履歴静的テキスト。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIEventName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the KPI event.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StaticText":{
            "maxLength":4000,
            "type":"string",
            "description":"The KPI history static text.",
            "nullable":true,
            "x-queryable":true
        },
        "KPIEventId":{
            "type":"integer",
            "description":"The unique identifier of the KPI event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"The unique identifier of the KPI.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "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."
        }
    }
}

リンク

KPIAggregationVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_KPI_CALC_TYPE%2CBindLookupCode%3D{KPIAggregationCode}

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: KPIAggregationCode;ターゲット属性: LookupCode
• 表示属性: 意味

KPIHistoryMetadata

操作: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata

パラメータ:

• KPINumber: $request.path.KPINumber

KPI履歴メタデータ・リソースは、KPI履歴メタデータの表示、作成、更新および削除に使用されます。

KPIStatusVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_KPI_STATUS%2CBindLookupCode%3D{KPIStatusCode}

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: KPIStatusCode;ターゲット属性: LookupCode
• 表示属性: 意味

KPIUOMVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_UNIT_OF_MEASURE%2CBindLookupCode%3D{UOMCode}

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: UOMCode;ターゲット属性: LookupCode
• 表示属性: 意味

「トップに戻る」