Get a Goal Metric
get
/crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}
Request
Path Parameters
-
GoalMetricsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- GoalId, ResourceId, TargetStartDate and TargetEndDate ---for the Goal Metric resource and used to uniquely identify an instance of Goal Metric. The client should not generate the hash key value. Instead, the client should query on the Goal Metric collection resource with a filter on the primary key values in order to navigate to a specific instance of Goal Metric.
For example: GoalMetrics?q=GoalId=<value1>;ResourceId=<value2>;TargetStartDate=<value3>;TargetEndDate=<value4> -
GoalNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : goals-GoalMetrics-item-response
Type:
Show Source
object
-
Actual: number
Read Only:
true
Actual -
CumulativeActual: number
Read Only:
true
The cumulative actual amount for the goal metric. -
CumulativeProgress: number
Read Only:
true
Cumulative Progress -
CumulativeTarget: number
Read Only:
true
The cumulative target for the associated goal metric. -
CurrencyCode: string
Read Only:
true
Maximum Length:4000
The currency code associated with the goal. -
DenomActual: number
Read Only:
true
The denominator value of the KPI actual on goal metrics. -
DenomRollupActual: number
Read Only:
true
Indicates the actual KPI denominator rollup value used in the percentage KPI calculation for the goal metrics. -
ExcludeRootResource: string
Read Only:
true
Maximum Length:1
Exclude Root Resource -
Frequency: string
Read Only:
true
Maximum Length:64
Frequency -
GoalEndDate: string
(date-time)
Read Only:
true
Goal End Date -
GoalId: integer
Read Only:
true
Goal ID -
GoalMetricBreakdown: array
Goal Metric Breakdowns
Title:
Goal Metric Breakdowns
The goal metric breakdown resource is used to view breakdowns for a goal metric. -
GoalMetricDetails: array
Goal Metric Detail
Title:
Goal Metric Detail
Goal Metric Details -
GoalName: string
Read Only:
true
Maximum Length:275
Goal Name -
GoalNumber: string
Read Only:
true
Maximum Length:64
Goal Number -
GoalStartDate: string
(date-time)
Read Only:
true
Goal Start Date -
IsFirst: number
Read Only:
true
Indicates if the current goal metric is the first. -
IsGoalParticipant: string
Read Only:
true
Maximum Length:1
Indicates if the metric belongs to a participant of the goal. -
IsLast: number
Read Only:
true
Indicates if the current goal metric is the last one. -
IsResourceFromMyOrg: string
Read Only:
true
Maximum Length:1
Indicates if the metric belongs to a resource in my organization. -
KPIAggregation: string
Read Only:
true
Maximum Length:200
The KPI calculation type for the goal metrics. -
KPIId: integer
(int64)
Read Only:
true
KPI ID -
KPIName: string
Read Only:
true
Maximum Length:275
KPI Name -
KPINumber: string
Read Only:
true
Maximum Length:64
KPI Number -
KPIObject: string
Read Only:
true
Maximum Length:40
KPI object -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerId: number
Read Only:
true
Manager ID -
ManagerNumber: string
Read Only:
true
Maximum Length:30
Manager Number -
NoOfGoalPeriods: number
Read Only:
true
The number of goal periods defined for the goal metric. -
NumerActual: number
Read Only:
true
The numerator value of the KPI actual on goal metrics. -
NumerRollupActual: number
Read Only:
true
Indicates the actual KPI numerator rollup value used in the percentage KPI calculation for the goal metrics. -
PersonId: integer
(int64)
Read Only:
true
Person ID -
Progress: number
Read Only:
true
Progress -
ResourceAvatarUri: string
Read Only:
true
Resource Avatar URI -
ResourceId: number
Read Only:
true
Resource ID -
ResourceName: string
Read Only:
true
Maximum Length:900
Resource Name -
ResourceNumber: string
Read Only:
true
Maximum Length:30
Resource Number -
RollupActual: number
Read Only:
true
Rollup Actual -
RollupCumulativeActual: number
Read Only:
true
The amount that indicates the rollup of the cumulative amount for the goal metric. -
RollupCumulativeProgress: number
Read Only:
true
Rollup Cumulative Progress -
RollupCumulativeTarget: number
Read Only:
true
The amount that indicates the cumulative rollup target for the goal metric. -
RollupProgress: number
Read Only:
true
Rollup Progress -
RollupTarget: number
Read Only:
true
Rollup Target -
Target: number
Read Only:
true
Target -
TargetEndDate: string
(date-time)
Read Only:
true
Target End Date -
TargetStartDate: string
(date-time)
Read Only:
true
Target Start Date -
UOMCode: string
Read Only:
true
Maximum Length:40
UOM Code
Nested Schema : Goal Metric Breakdowns
Type:
array
Title:
Goal Metric Breakdowns
The goal metric breakdown resource is used to view breakdowns for a goal metric.
Show Source
Nested Schema : Goal Metric Detail
Type:
array
Title:
Goal Metric Detail
Goal Metric Details
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : goals-GoalMetrics-GoalMetricBreakdown-item-response
Type:
Show Source
object
-
BreakdownFrequency: string
Read Only:
true
Maximum Length:7
The breakdown frequency associated with the current goal metric breakdown. -
BreakdownMeasuredAlias: string
Read Only:
true
Maximum Length:12
The alias of the measured breakdown associated with the goal metric. -
BreakdownMeasurementDate: string
(date)
Read Only:
true
The date when the breakdown measurement was assigned. -
BreakdownPeriodEndDate: string
(date-time)
Read Only:
true
The date when the goal metric breakdown period ends. -
BreakdownPeriodStartDate: string
(date-time)
Read Only:
true
The date when the goal metric breakdown period starts. -
DayActual: number
Read Only:
true
The actual day for the goal metric. -
DenomDayActual: number
Read Only:
true
The day actual KPI denominator value for the goal metrics breakdown. -
DenomPeriodRunningActual: number
Read Only:
true
The period running actual KPI Denominator value for the goal metrics breakdown. -
GoalFrequency: string
Read Only:
true
Maximum Length:64
The frequency of the goal associated with the goal metric breakdown. -
GoalId: integer
Read Only:
true
Goal ID -
IsForLaterDate: string
Read Only:
true
Indicates if the goal metric breakdown is for a later date. -
KPIId: integer
(int64)
Read Only:
true
KPI ID -
LastDayOfPeriod: string
(date-time)
Read Only:
true
The last day of the breakdown period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoOfDaysInPeriod: number
Read Only:
true
The number of days in the breakdown period. -
NumerDayActual: number
Read Only:
true
The Day Actual KPI Numerator value for the goal metrics breakdown. -
NumerPeriodRunningActual: number
Read Only:
true
The period running actual KPI numerator value for the goal metrics breakdown. -
PeriodRunningActual: number
Read Only:
true
The actual period running for the goal metric breakdown. -
ResourceId: number
Read Only:
true
Resource ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : goals-GoalMetrics-GoalMetricDetails-item-response
Type:
Show Source
object
-
Actual: number
Read Only:
true
Actual -
CumulativeActual: number
Read Only:
true
Cumulative Actual -
DenomActual: number
Read Only:
true
The denominator value of the KPI actual on goal metrics. -
DenomCumulativeActual: number
Read Only:
true
The cumulative actual KPI denominator value for the goal metrics details. This is used in KPI calculation for the goal metrics. -
DenomRollupActual: number
Read Only:
true
The rollup actual KPI denominator value for the goal metrics details. This is used in KPI calculation for the goal metrics. -
DenomRollupCumulativeActual: number
Read Only:
true
The rollup cumulative actual KPI denominator value for the goal metrics details. This is used in KPI calculation for the goal metrics. -
Frequency: string
Read Only:
true
Maximum Length:64
Frequency -
GoalId: integer
(int64)
Read Only:
true
Goal ID -
GoalName: string
Read Only:
true
Maximum Length:275
Goal Name -
GoalNumber: string
Read Only:
true
Maximum Length:64
Goal Number -
KPICategoryCode: string
Read Only:
true
Maximum Length:100
KPI Category Code -
KPICategoryName: string
Read Only:
true
Maximum Length:80
KPI Category Name -
KPIId: integer
(int64)
Read Only:
true
KPI ID -
KPIName: string
Read Only:
true
Maximum Length:275
KPI Name -
KPINumber: string
Read Only:
true
Maximum Length:64
KPI Number -
KPIObject: string
Read Only:
true
Maximum Length:40
KPI object -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumerActual: number
Read Only:
true
The numerator value of the KPI actual on goal metrics. -
NumerCumulativeActual: number
Read Only:
true
The cumulative actual KPI numerator value for the goal metrics details. This is used in KPI calculation for the goal metrics. -
NumerRollupActual: number
Read Only:
true
The rollup actual KPI numerator value for the goal metrics details. This is used in KPI calculation for the goal metrics. -
NumerRollupCumulativeActual: number
Read Only:
true
The rollup cumulative actual KPI numerator value for the goal metrics details. This is used in KPI calculation for the goal metrics. -
ResoruceNumber: string
Read Only:
true
Maximum Length:30
Resource Number -
ResourceId: integer
(int64)
Read Only:
true
Resource ID -
ResourceName: string
Read Only:
true
Maximum Length:900
Resource Name -
RollupActual: number
Read Only:
true
Rollup Actual -
RollupCumulativeActual: number
Read Only:
true
Rollup Cumulative Actual -
TargetEndDate: string
(date-time)
Read Only:
true
Target End Date -
TargetStartDate: string
(date-time)
Read Only:
true
Target Start Date -
UOMCode: string
Read Only:
true
Maximum Length:40
UOM Code
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- GoalMetricBreakdown
-
Parameters:
- GoalMetricsUniqID:
$request.path.GoalMetricsUniqID
- GoalNumber:
$request.path.GoalNumber
The goal metric breakdown resource is used to view breakdowns for a goal metric. - GoalMetricsUniqID:
- GoalMetricDetails
-
Parameters:
- GoalMetricsUniqID:
$request.path.GoalMetricsUniqID
- GoalNumber:
$request.path.GoalNumber
Goal Metric Details - GoalMetricsUniqID: