Create a goal metric detail record
post
/crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails
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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Response
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-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
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.