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

機械翻訳について

目標メトリックの取得

get

/crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}

リクエスト

パス・パラメータ

goalMetricsUniqID(required): string

これは、目標メトリック・リソースに対してコンポジット・キー(GoalId、ResourceId、TargetStartDateおよびTargetEndDate)を構成する属性のハッシュ・キーで、目標メトリックのインスタンスを一意に識別するために使用されます。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、目標メトリックの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して目標メトリック収集リソースを問い合せる必要があります。

次に例を示します: goalMetrics?q=GoalId=<value1>;ResourceId=<value2>;TargetStartDate=<value3>;TargetEndDate=<value4>

問合せパラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : goalMetrics-item-response

タイプ: object

ソースを表示

実績: number

読取り専用: true

実績
CumulativeActual: number

読取り専用: true

目標メトリックの累積実績金額。
CumulativeProgress: number

読取り専用: true

累積進捗
CumulativeTarget: number

読取り専用: true

関連付けられた目標メトリックの累積ターゲット。
CurrencyCode: string

読取り専用: true

最大長: 4000

目標に関連付けられている通貨コード。
DenomActual: number

読取り専用: true

目標メトリックのKPI実績の分母値。
DenomRollupActual: number

読取り専用: true

目標メトリックのパーセントKPI計算で使用される実績KPI分母ロールアップ値を示します。
ExcludeRootResource: string

読取り専用: true

最大長: 1

ルート・リソースの除外
Frequency: string

読取り専用: true

最大長: 64

頻度
GoalEndDate: string (date-time)

読取り専用: true

目標終了日
GoalId: integer

読取り専用: true

目標ID
GoalMetricBreakdown: array Goal Metric Breakdowns

タイトル: Goal Metric Breakdowns

目標メトリック・ブレークダウン・リソースは、目標メトリックのブレークダウンを表示するために使用されます。
GoalMetricDetails: array Goal Metric Detail

タイトル: Goal Metric Detail

目標メトリック詳細
GoalName: string

読取り専用: true

最大長: 275

目標名
GoalNumber: string

読取り専用: true

最大長: 64

目標番号
GoalStartDate: string (date-time)

読取り専用: true

目標開始日
IsFirst: number

読取り専用: true

現在の目標メトリックが最初のものかどうかを示します。
IsGoalParticipant: string

読取り専用: true

最大長: 1

メトリックが目標の参加者に属しているかどうかを示します。
IsLast: number

読取り専用: true

現在の目標メトリックが最後の目標メトリックかどうかを示します。
IsResourceFromMyOrg: string

読取り専用: true

最大長: 1

メトリックが組織内のリソースに属しているかどうかを示します。
KPIAggregation: string

読取り専用: true

最大長: 200

目標メトリックのKPI計算タイプ。
KPIId: integer (int64)

読取り専用: true

KPI ID
KPIName: string

読取り専用: true

最大長: 275

KPI名
KPINumber: string

読取り専用: true

最大長: 64

KPI番号
KPIObject: string

読取り専用: true

最大長: 40

KPIオブジェクト
links: array Links

タイトル: Links

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

読取り専用: true

マネージャID
ManagerNumber: string

読取り専用: true

最大長: 30

マネージャ番号
NoOfGoalPeriods: number

読取り専用: true

目標メトリックに定義された目標期間の数。
NumerActual: number

読取り専用: true

目標メトリックのKPI実績の分子値です。
NumerRollupActual: number

読取り専用: true

目標メトリックのパーセントKPI計算で使用される実績KPI分子積上値を示します。
PersonId: integer (int64)

読取り専用: true

Person ID
進捗: number

読取り専用: true

進捗
ResourceAvatarUri: string

読取り専用: true

リソース・アバターURI
ResourceId: number

読取り専用: true

リソースID
ResourceName: string

読取り専用: true

最大長: 900

リソース名
ResourceNumber: string

読取り専用: true

最大長: 30

リソース番号
RollupActual: number

読取り専用: true

実績の積上
RollupCumulativeActual: number

読取り専用: true

目標メトリックの累積金額の積上を示す金額。
RollupCumulativeProgress: number

読取り専用: true

積上累積進捗
RollupCumulativeTarget: number

読取り専用: true

目標メトリックの累積ロールアップ・ターゲットを示す金額。
RollupProgress: number

読取り専用: true

積上進捗
RollupTarget: number

読取り専用: true

ロールアップ・ターゲット
ターゲット: number

読取り専用: true

ターゲット
TargetEndDate: string (date-time)

読取り専用: true

ターゲット終了日
TargetStartDate: string (date-time)

読取り専用: true

ターゲット開始日
UOMCode: string

読取り専用: true

最大長: 40

単位コード

{
    "type":"object",
    "properties":{
        "RollupCumulativeActual":{
            "type":"number",
            "description":"The amount that indicates the rollup of the cumulative amount for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Manager Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupActual":{
            "type":"number",
            "description":"Rollup Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":900,
            "type":"string",
            "description":"Resource Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsLast":{
            "type":"number",
            "description":"Indicates if the current goal metric is the last one.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsResourceFromMyOrg":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the metric belongs to a resource in my organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsGoalParticipant":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the metric belongs to a participant of the goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIName":{
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":4000,
            "type":"string",
            "description":"The currency code associated with the goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Target":{
            "type":"number",
            "description":"Target",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIObject":{
            "maxLength":40,
            "type":"string",
            "description":"KPI object",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerActual":{
            "type":"number",
            "description":"The numerator value of the KPI actual on goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIAggregation":{
            "maxLength":200,
            "type":"string",
            "description":"The KPI calculation type for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupTarget":{
            "type":"number",
            "description":"Rollup Target",
            "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"
            }
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeProgress":{
            "type":"number",
            "description":"Cumulative Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalEndDate":{
            "type":"string",
            "description":"Goal End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Progress":{
            "type":"number",
            "description":"Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetStartDate":{
            "type":"string",
            "description":"Target Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalMetricDetails":{
            "title":"Goal Metric Detail",
            "type":"array",
            "description":"Goal Metric Details",
            "items":{
                "$ref":"#/components/schemas/goalMetrics-GoalMetricDetails-item-response"
            }
        },
        "DenomActual":{
            "type":"number",
            "description":"The denominator value of the KPI actual on goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetEndDate":{
            "type":"string",
            "description":"Target End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Goal Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupCumulativeProgress":{
            "type":"number",
            "description":"Rollup Cumulative Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeActual":{
            "type":"number",
            "description":"The cumulative actual amount for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerRollupActual":{
            "type":"number",
            "description":"Indicates the actual KPI numerator rollup value used in the percentage KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalMetricBreakdown":{
            "title":"Goal Metric Breakdowns",
            "type":"array",
            "description":"The goal metric breakdown resource is used to view breakdowns for a goal metric.",
            "items":{
                "$ref":"#/components/schemas/goalMetrics-GoalMetricBreakdown-item-response"
            }
        },
        "RollupProgress":{
            "type":"number",
            "description":"Rollup Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RollupCumulativeTarget":{
            "type":"number",
            "description":"The amount that indicates the cumulative rollup target for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"number",
            "description":"Resource ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoOfGoalPeriods":{
            "type":"number",
            "description":"The number of goal periods defined for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsFirst":{
            "type":"number",
            "description":"Indicates if the current goal metric is the first.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Frequency":{
            "maxLength":64,
            "type":"string",
            "description":"Frequency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalName":{
            "maxLength":275,
            "type":"string",
            "description":"Goal Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Actual":{
            "type":"number",
            "description":"Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomRollupActual":{
            "type":"number",
            "description":"Indicates the actual KPI denominator rollup value used in the percentage KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Resource Avatar URI",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalStartDate":{
            "type":"string",
            "description":"Goal Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerId":{
            "type":"number",
            "description":"Manager ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeTarget":{
            "type":"number",
            "description":"The cumulative target for the associated goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExcludeRootResource":{
            "maxLength":1,
            "type":"string",
            "description":"Exclude Root Resource",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 目標メトリックの内訳

タイプ: array

タイトル: Goal Metric Breakdowns

目標メトリック・ブレークダウン・リソースは、目標メトリックのブレークダウンを表示するために使用されます。

ソースを表示

Array of: object goalMetrics-GoalMetricBreakdown-item-response

{
    "title":"Goal Metric Breakdowns",
    "type":"array",
    "description":"The goal metric breakdown resource is used to view breakdowns for a goal metric.",
    "items":{
        "$ref":"#/components/schemas/goalMetrics-GoalMetricBreakdown-item-response"
    }
}

ネストされたスキーマ : 目標メトリック詳細

タイプ: array

タイトル: Goal Metric Detail

目標メトリック詳細

ソースを表示

Array of: object goalMetrics-GoalMetricDetails-item-response

{
    "title":"Goal Metric Detail",
    "type":"array",
    "description":"Goal Metric Details",
    "items":{
        "$ref":"#/components/schemas/goalMetrics-GoalMetricDetails-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"
    }
}

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

タイプ: object

ソースを表示

BreakdownFrequency: string

読取り専用: true

最大長: 7

現在の目標メトリック・ブレークダウンに関連付けられたブレークダウン頻度。
BreakdownMeasuredAlias: string

読取り専用: true

最大長: 12

目標メトリックに関連付けられた測定されたブレークダウンの別名。
BreakdownMeasurementDate: 文字列(日付)

読取り専用: true

ブレークダウン測定が割り当てられた日付。
BreakdownPeriodEndDate: string (date-time)

読取り専用: true

目標メトリック・ブレークダウン期間が終了する日付。
BreakdownPeriodStartDate: string (date-time)

読取り専用: true

目標メトリック・ブレークダウン期間が開始する日付。
DayActual: number

読取り専用: true

目標メトリックの実際の日。
DenomDayActual: number

読取り専用: true

目標メトリック・ブレークダウンの日実績KPI分母値。
DenomPeriodRunningActual: number

読取り専用: true

目標メトリック・ブレークダウンの実績KPI分母値を実行している期間。
GoalFrequency: string

読取り専用: true

最大長: 64

目標メトリック・ブレークダウンに関連付けられた目標の頻度。
GoalId: integer

読取り専用: true

目標ID
IsForLaterDate: string

読取り専用: true

目標メトリック・ブレークダウンが後の日付に対するものかどうかを示します。
KPIId: integer (int64)

読取り専用: true

KPI ID
LastDayOfPeriod: string (date-time)

読取り専用: true

ブレークダウン期間の最終日。
links: array Links

タイトル: Links

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

読取り専用: true

ブレークダウン期間の日数。
NumerDayActual: number

読取り専用: true

目標メトリック・ブレークダウンの日実績KPI分子値。
NumerPeriodRunningActual: number

読取り専用: true

目標メトリック・ブレークダウンの実績KPI分子値を実行している期間。
PeriodRunningActual: number

読取り専用: true

目標メトリック・ブレークダウンの実行実績期間。
ResourceId: number

読取り専用: true

リソースID

{
    "type":"object",
    "properties":{
        "BreakdownPeriodStartDate":{
            "type":"string",
            "description":"The date when the goal metric breakdown period starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BreakdownPeriodEndDate":{
            "type":"string",
            "description":"The date when the goal metric breakdown period ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BreakdownFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"The breakdown frequency associated with the current goal metric breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoOfDaysInPeriod":{
            "type":"number",
            "description":"The number of days in the breakdown period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerPeriodRunningActual":{
            "type":"number",
            "description":"The period running actual KPI numerator value for the goal metrics breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDayOfPeriod":{
            "type":"string",
            "description":"The last day of the breakdown period.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BreakdownMeasurementDate":{
            "type":"string",
            "description":"The date when the breakdown measurement was assigned.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DayActual":{
            "type":"number",
            "description":"The actual day for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalFrequency":{
            "maxLength":64,
            "type":"string",
            "description":"The frequency of the goal associated with the goal metric breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"number",
            "description":"Resource ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BreakdownMeasuredAlias":{
            "maxLength":12,
            "type":"string",
            "description":"The alias of the measured breakdown associated with the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":true,
            "readOnly":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"
            }
        },
        "IsForLaterDate":{
            "type":"string",
            "description":"Indicates if the goal metric breakdown is for a later date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerDayActual":{
            "type":"number",
            "description":"The Day Actual KPI Numerator value for the goal metrics breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomDayActual":{
            "type":"number",
            "description":"The day actual KPI denominator value for the goal metrics breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodRunningActual":{
            "type":"number",
            "description":"The actual period running for the goal metric breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomPeriodRunningActual":{
            "type":"number",
            "description":"The period running actual KPI Denominator value for the goal metrics breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "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."
        }
    }
}

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

タイプ: object

ソースを表示

実績: number

読取り専用: true

実績
CumulativeActual: number

読取り専用: true

累積実績
DenomActual: number

読取り専用: true

目標メトリックのKPI実績の分母値。
DenomCumulativeActual: number

読取り専用: true

目標メトリック詳細の累積実績KPI分母値。これは、目標メトリックのKPI計算で使用されます。
DenomRollupActual: number

読取り専用: true

目標メトリック詳細の積上実績KPI分母値。これは、目標メトリックのKPI計算で使用されます。
DenomRollupCumulativeActual: number

読取り専用: true

目標メトリック詳細の積上累積実績KPI分母値。これは、目標メトリックのKPI計算で使用されます。
Frequency: string

読取り専用: true

最大長: 64

頻度
GoalId: integer (int64)

読取り専用: true

目標ID
GoalName: string

読取り専用: true

最大長: 275

目標名
GoalNumber: string

読取り専用: true

最大長: 64

目標番号
KPICategoryCode: string

読取り専用: true

最大長: 100

KPIカテゴリ・コード
KPICategoryName: string

読取り専用: true

最大長: 80

KPIカテゴリ名
KPIId: integer (int64)

読取り専用: true

KPI ID
KPIName: string

読取り専用: true

最大長: 275

KPI名
KPINumber: string

読取り専用: true

最大長: 64

KPI番号
KPIObject: string

読取り専用: true

最大長: 40

KPIオブジェクト
links: array Links

タイトル: Links

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

読取り専用: true

目標メトリックのKPI実績の分子値です。
NumerCumulativeActual: number

読取り専用: true

目標メトリック詳細の累積実績KPI分子値です。これは、目標メトリックのKPI計算で使用されます。
NumerRollupActual: number

読取り専用: true

目標メトリック詳細の積上実績KPI分子値。これは、目標メトリックのKPI計算で使用されます。
NumerRollupCumulativeActual: number

読取り専用: true

目標メトリック詳細の積上累積実績KPI分子値。これは、目標メトリックのKPI計算で使用されます。
ResoruceNumber: string

読取り専用: true

最大長: 30

リソース番号
ResourceId: integer (int64)

読取り専用: true

リソースID
ResourceName: string

読取り専用: true

最大長: 900

リソース名
RollupActual: number

読取り専用: true

実績の積上
RollupCumulativeActual: number

読取り専用: true

積上累積実績
TargetEndDate: string (date-time)

読取り専用: true

ターゲット終了日
TargetStartDate: string (date-time)

読取り専用: true

ターゲット開始日
UOMCode: string

読取り専用: true

最大長: 40

単位コード

{
    "type":"object",
    "properties":{
        "RollupCumulativeActual":{
            "type":"number",
            "description":"Rollup Cumulative Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupActual":{
            "type":"number",
            "description":"Rollup Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":900,
            "type":"string",
            "description":"Resource Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerRollupCumulativeActual":{
            "type":"number",
            "description":"The rollup cumulative actual KPI numerator value for the goal metrics details. This is used in KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomRollupCumulativeActual":{
            "type":"number",
            "description":"The rollup cumulative actual KPI denominator value for the goal metrics details. This is used in KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIName":{
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIObject":{
            "maxLength":40,
            "type":"string",
            "description":"KPI object",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerActual":{
            "type":"number",
            "description":"The numerator value of the KPI actual on goal metrics.",
            "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"
            }
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPINumber":{
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetStartDate":{
            "type":"string",
            "description":"Target Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetEndDate":{
            "type":"string",
            "description":"Target End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomActual":{
            "type":"number",
            "description":"The denominator value of the KPI actual on goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Goal Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResoruceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerCumulativeActual":{
            "type":"number",
            "description":"The cumulative actual KPI numerator value for the goal metrics details. This is used in KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICategoryName":{
            "maxLength":80,
            "type":"string",
            "description":"KPI Category Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeActual":{
            "type":"number",
            "description":"Cumulative Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumerRollupActual":{
            "type":"number",
            "description":"The rollup actual KPI numerator value for the goal metrics details. This is used in KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICategoryCode":{
            "maxLength":100,
            "type":"string",
            "description":"KPI Category Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Frequency":{
            "maxLength":64,
            "type":"string",
            "description":"Frequency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalName":{
            "maxLength":275,
            "type":"string",
            "description":"Goal Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Actual":{
            "type":"number",
            "description":"Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomRollupActual":{
            "type":"number",
            "description":"The rollup actual KPI denominator value for the goal metrics details. This is used in KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenomCumulativeActual":{
            "type":"number",
            "description":"The cumulative actual KPI denominator value for the goal metrics details. This is used in KPI calculation for the goal metrics.",
            "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"
    }
}

リンク

GoalMetricBreakdown

操作: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/GoalMetricBreakdown

パラメータ:

goalMetricsUniqID: $request.path.goalMetricsUniqID

目標メトリック・ブレークダウン・リソースは、目標メトリックのブレークダウンを表示するために使用されます。

GoalMetricDetails

操作: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/GoalMetricDetails

パラメータ:

goalMetricsUniqID: $request.path.goalMetricsUniqID

目標メトリック詳細

「トップに戻る」