機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 目標メトリック

すべての目標メトリックの取得

get

/crmRestApi/resources/11.13.18.05/goalMetrics

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

    使用可能なファインダ名および対応するファインダ変数を次に示します

    • PrimaryKey主キーを使用した目標メトリックの検索
      ファインダ変数
      • GoalId; integer;目標IDを使用した目標メトリックの検索
      • ResourceId; number;リソースIDを使用した目標メトリックの検索
      • TargetEndDate; string;ターゲット終了日を使用した目標メトリックの検索
      • TargetStartDate; string;ターゲット開始日を使用した目標メトリックの検索
    • findActiveScheduledCompletedすべての目標の目標メトリックの検索
      ファインダ変数
      • bindEffectiveDate; string;目標メトリックの有効バインド日。
    • findCompleted目標の完了したメトリックをすべて検索します。
      ファインダ変数
      • bindEffectiveDate; string;目標メトリックの有効日。
    • findEffectiveDated有効日を使用した目標メトリックの検索
      ファインダ変数
      • bindEffectiveDate;文字列;有効日
    • findScheduledスケジュール済目標の目標メトリックの検索。
      ファインダ変数
      • bindEffectiveDate; string;目標メトリックの有効バインド日。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • 実績;数;実績
    • CumulativeActual; number;目標メトリックの累積実績金額。
    • CumulativeProgress;数値;累積進捗
    • CumulativeTarget; number;関連付けられた目標メトリックの累積ターゲット。
    • CurrencyCode; string;目標に関連付けられた通貨コード。
    • DenomActual; number;目標メトリックのKPI実績の分母値。
    • DenomRollupActual; number;目標メトリックのパーセンテージKPI計算で使用される、実際のKPI分母ロールアップ値を示します。
    • ExcludeRootResource; string; Exclude Root Resource
    • 頻度;文字列;頻度
    • GoalEndDate;文字列;目標終了日
    • GoalId;整数;目標ID
    • GoalName; string;目標名
    • GoalNumber;文字列;目標番号
    • GoalStartDate;文字列;目標開始日
    • IsFirst; number。現在の目標メトリックが最初のものかどうかを示します。
    • IsGoalParticipant; string; メトリックが目標の参加者に属しているかどうかを示します。
    • IsLast; number。現在の目標メトリックが最後の目標メトリックであるかどうかを示します。
    • IsResourceFromMyOrg; string; メトリックが組織内のリソースに属しているかどうかを示します。
    • KPIAggregation; string;目標メトリックのKPI計算タイプ。
    • KPIId;整数; KPI ID
    • KPIName;文字列; KPI名
    • KPINumber;文字列; KPI番号
    • KPIObject;文字列; KPIオブジェクト
    • ManagerId; number; Manager ID
    • ManagerNumber;文字列;マネージャ番号
    • NoOfGoalPeriods; number;目標メトリックに定義された目標期間の数。
    • NumerActual; number;目標メトリックのKPI実績の分子値。
    • NumerRollupActual; number;目標メトリックのパーセンテージKPI計算で使用される実際のKPI分子積上値を示します。
    • PersonId; integer; Person ID
    • 進捗;番号;進捗
    • ResourceAvatarUri; string;リソース・アバターURI
    • ResourceId; number;リソースID
    • ResourceName; string;リソース名
    • ResourceNumber; string;リソース番号
    • RollupActual; number; Rollup Actual
    • RollupCumulativeActual; number。目標メトリックの累積金額のロールアップを示す金額。
    • RollupCumulativeProgress;数値;ロールアップ累積進捗
    • RollupCumulativeTarget; number。目標メトリックの累積ロールアップ・ターゲットを示す量。
    • RollupProgress;番号;ロールアップの進捗
    • RollupTarget;数値;ロールアップ・ターゲット
    • ターゲット;数値;ターゲット
    • TargetEndDate;文字列;ターゲット終了日
    • TargetStartDate;文字列;ターゲット開始日
    • UOMCode;文字列;単位コード
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : goalMetrics
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : goalMetrics-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 目標メトリックの内訳
タイプ: array
タイトル: Goal Metric Breakdowns
目標メトリック・ブレークダウン・リソースは、目標メトリックのブレークダウンを表示するために使用されます。
ソースを表示
ネストされたスキーマ : 目標メトリック詳細
タイプ: array
タイトル: Goal Metric Detail
目標メトリック詳細
ソースを表示
ネストされたスキーマ : goalMetrics-GoalMetricBreakdown-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : goalMetrics-GoalMetricDetails-item-response
タイプ: object
ソースを表示
「トップに戻る」