機械翻訳について

ジャンプ先

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

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

get

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

リクエスト

パス・パラメータ

• 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
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します
  
  

  • PrimaryKey主キーを使用して目標メトリックの内訳を検索します。
    ファインダ変数
    • BreakdownPeriodEndDate; string;分割期間の終了日。
    • BreakdownPeriodStartDate; string;分割期間の開始日。
    • GoalId; integer;目標の一意の識別子を使用した目標メトリックの検索
    • ResourceId; number。目標メトリックに関連付けられたリソースの一意の識別子。
• 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問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • BreakdownFrequency; string;現在の目標メトリック・ブレークダウンに関連付けられたブレークダウン頻度。
  • BreakdownMeasuredAlias; string; 目標メトリックに関連付けられた測定されたブレークダウンの別名。
  • BreakdownMeasurementDate; string;ブレークダウン測定が割り当てられた日付。
  • BreakdownPeriodEndDate; string; 目標メトリック・ブレークダウン期間が終了する日付。
  • BreakdownPeriodStartDate; string; 目標メトリック・ブレークダウン期間が開始する日付。
  • DayActual; number。目標メトリックの実際の日。
  • DenomDayActual;数値;目標メトリック・ブレークダウンの日実績KPI分母値。
  • DenomPeriodRunningActual;数値;目標メトリック・ブレークダウンの実績KPI分母値を実行する期間。
  • GoalFrequency; string; 目標メトリック・ブレークダウンに関連付けられた目標の頻度。
  • GoalId;整数;目標ID
  • IsForLaterDate; string; 目標メトリック・ブレークダウンが後の日付に対するものかどうかを示します。
  • KPIId;整数; KPI ID
  • LastDayOfPeriod; string; ブレークダウン期間の最終日。
  • NoOfDaysInPeriod; number;ブレークダウン期間の日数。
  • NumerDayActual;数値;目標メトリック・ブレークダウンの日実績KPI分子値。
  • NumerPeriodRunningActual; number;目標メトリック・ブレークダウンの実績KPI分子値を実行する期間。
  • PeriodRunningActual; number。目標メトリック・ブレークダウンに対して実行されている実際の期間。
  • ResourceId; number;リソースID
• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : goalMetrics-GoalMetricBreakdown

タイプ: 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"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/goalMetrics-GoalMetricBreakdown-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object goalMetrics-GoalMetricBreakdown-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/goalMetrics-GoalMetricBreakdown-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."
        }
    }
}

「トップに戻る」