Jump to

• Request
• Response

Update a goal metric detail record

patch

/crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails/{GoalMetricDetailsUniqID}

Request

Path Parameters

• GoalMetricDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- GoalId, TargetStartDate, TargetEndDate, ResourceId and KPICategoryName ---for the Goal Metric Detail resource and used to uniquely identify an instance of Goal Metric Detail. The client should not generate the hash key value. Instead, the client should query on the Goal Metric Detail collection resource with a filter on the primary key values in order to navigate to a specific instance of Goal Metric Detail.
  
  For example: GoalMetricDetails?q=GoalId=<value1>;TargetStartDate=<value2>;TargetEndDate=<value3>;ResourceId=<value4>;KPICategoryName=<value5>
• 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: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : goals-GoalMetrics-GoalMetricDetails-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Actual":{
            "type":"number",
            "description":"Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeActual":{
            "type":"number",
            "description":"Cumulative Actual",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "Frequency":{
            "maxLength":64,
            "type":"string",
            "description":"Frequency",
            "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
        },
        "GoalName":{
            "maxLength":275,
            "type":"string",
            "description":"Goal Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Goal Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICategoryCode":{
            "maxLength":100,
            "type":"string",
            "description":"KPI Category Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPICategoryName":{
            "maxLength":80,
            "type":"string",
            "description":"KPI Category Name",
            "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
        },
        "KPIName":{
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ResoruceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":900,
            "type":"string",
            "description":"Resource Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupActual":{
            "type":"number",
            "description":"Rollup Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupCumulativeActual":{
            "type":"number",
            "description":"Rollup Cumulative Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetEndDate":{
            "type":"string",
            "description":"Target End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetStartDate":{
            "type":"string",
            "description":"Target Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":40,
            "type":"string",
            "description":"UOM Code",
            "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"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top