Jump to

• Request
• Response

Update a goal

patch

/crmRestApi/resources/11.13.18.05/goals/{GoalNumber}

Request

Path Parameters

• 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

• CommonTarget: number
  Title: Common Target

  Default Value: 0

  Common Target
• ConflictId: integer (int64)
  Default Value: 0

  Conflict ID
• EndDate: string (date-time)
  Title: End Date

  End Date
• Frequency: string
  Title: Frequency

  Maximum Length: 64

  Frequency
• GoalHistory: array Goal History
  Title: Goal History

  Goal History
• GoalMetrics: array Goal Metric
  Title: Goal Metric

  Goal Metrics
• GoalName: string
  Title: Goal Name

  Maximum Length: 275

  Goal Name
• GoalParticipants: array Goal Participants
  Title: Goal Participants

  Goal Participants
• KPIId: integer (int64)
  Title: KPI ID

  KPI ID
• ObjectVersionNumber: integer (int32)
  Object Version Number
• OwnerId: integer (int64)
  Title: Owner ID

  Owner ID
• StartDate: string (date-time)
  Title: Start Date

  Start Date
• TimezoneCode: string
  Maximum Length: 50

  Time Zone Code

{
    "type":"object",
    "properties":{
        "CommonTarget":{
            "title":"Common Target",
            "type":"number",
            "description":"Common Target",
            "nullable":true,
            "default":0
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date-time",
            "nullable":false
        },
        "Frequency":{
            "title":"Frequency",
            "maxLength":64,
            "type":"string",
            "description":"Frequency",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GoalHistory":{
            "title":"Goal History",
            "type":"array",
            "description":"Goal History",
            "items":{
                "$ref":"#/components/schemas/goals-GoalHistory-item-patch-request"
            }
        },
        "GoalMetrics":{
            "title":"Goal Metric",
            "type":"array",
            "description":"Goal Metrics",
            "items":{
                "$ref":"#/components/schemas/goals-GoalMetrics-item-patch-request"
            }
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":275,
            "type":"string",
            "description":"Goal Name",
            "nullable":false
        },
        "GoalParticipants":{
            "title":"Goal Participants",
            "type":"array",
            "description":"Goal Participants",
            "items":{
                "$ref":"#/components/schemas/goals-GoalParticipants-item-patch-request"
            }
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"Owner ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date-time",
            "nullable":false
        },
        "TimezoneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Time Zone Code",
            "nullable":true
        }
    }
}

Nested Schema : Goal History

Type: array

Title: Goal History

Goal History

Show Source

• Array of: object schema

{
    "title":"Goal History",
    "type":"array",
    "description":"Goal History",
    "items":{
        "$ref":"#/components/schemas/goals-GoalHistory-item-patch-request"
    }
}

Nested Schema : Goal Metric

Type: array

Title: Goal Metric

Goal Metrics

Show Source

• Array of: object schema

{
    "title":"Goal Metric",
    "type":"array",
    "description":"Goal Metrics",
    "items":{
        "$ref":"#/components/schemas/goals-GoalMetrics-item-patch-request"
    }
}

Nested Schema : Goal Participants

Type: array

Title: Goal Participants

Goal Participants

Show Source

• Array of: object schema

{
    "title":"Goal Participants",
    "type":"array",
    "description":"Goal Participants",
    "items":{
        "$ref":"#/components/schemas/goals-GoalParticipants-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "GoalMetricBreakdown":{
            "title":"Goal Metric Breakdowns",
            "type":"array",
            "description":"The goal metric breakdown resource is used to view breakdowns for a goal metric.",
            "items":{
                "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricBreakdown-item-patch-request"
            }
        },
        "GoalMetricDetails":{
            "title":"Goal Metric Detail",
            "type":"array",
            "description":"Goal Metric Details",
            "items":{
                "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricDetails-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Goal Metric Breakdowns",
    "type":"array",
    "description":"The goal metric breakdown resource is used to view breakdowns for a goal metric.",
    "items":{
        "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricBreakdown-item-patch-request"
    }
}

Nested Schema : Goal Metric Detail

Type: array

Title: Goal Metric Detail

Goal Metric Details

Show Source

• Array of: object schema

{
    "title":"Goal Metric Detail",
    "type":"array",
    "description":"Goal Metric Details",
    "items":{
        "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

• ConflictId: integer (int64)
  Default Value: 0

  Goal Participant Conflict ID
• ObjectVersionNumber: integer (int32)
  Object Version Number
• Target: number
  Title: Target Value

  Target Value

{
    "type":"object",
    "properties":{
        "ConflictId":{
            "type":"integer",
            "description":"Goal Participant Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Target":{
            "title":"Target Value",
            "type":"number",
            "description":"Target Value",
            "nullable":true
        }
    }
}

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-item-response

Type: object

Show Source

• CommonTarget: number
  Title: Common Target

  Default Value: 0

  Common Target
• ConflictId: integer (int64)
  Default Value: 0

  Conflict ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Read Only: true

  Creation Date
• CurrencyCode: string
  Read Only: true

  The currency code associated with the goal.
• DeleteFlag: boolean
  Read Only: true

  Delete Goal
• EndDate: string (date-time)
  Title: End Date

  End Date
• Frequency: string
  Title: Frequency

  Maximum Length: 64

  Frequency
• GoalHistory: array Goal History
  Title: Goal History

  Goal History
• GoalId: integer (int64)
  Title: Goal ID

  Goal ID
• GoalMetrics: array Goal Metric
  Title: Goal Metric

  Goal Metrics
• GoalName: string
  Title: Goal Name

  Maximum Length: 275

  Goal Name
• GoalNumber: string
  Title: Goal Number

  Maximum Length: 64

  Goal Number
• GoalParticipants: array Goal Participants
  Title: Goal Participants

  Goal Participants
• KPIAggregation: string
  Title: KPI Calculation Type

  Read Only: true

  Maximum Length: 200

  KPI Calculation Type
• KPIDescription: string
  Title: KPI Description

  Read Only: true

  Maximum Length: 3000

  KPI Description
• KPIId: integer (int64)
  Title: KPI ID

  KPI ID
• KPIName: string
  Title: KPI Name

  Read Only: true

  Maximum Length: 275

  KPI Name
• KPINumber: string
  Title: KPI Number

  Maximum Length: 64

  KPI Number
• LastUpdateDate: string (date-time)
  Read Only: true

  Last Updated Date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last Updated By
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last Update Login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Object Version Number
• OwnerId: integer (int64)
  Title: Owner ID

  Owner ID
• OwnerName: string
  Title: Owner Name

  Read Only: true

  Maximum Length: 360

  Owner Name
• OwnerNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  Owner Number
• OwnerUniqueName: string
  Title: Owner Unique Name

  Read Only: true

  Maximum Length: 900

  Owner Unique Name
• StartDate: string (date-time)
  Title: Start Date

  Start Date
• TimezoneCode: string
  Maximum Length: 50

  Time Zone Code
• UpdateFlag: boolean
  Read Only: true

  Update Goal

{
    "type":"object",
    "properties":{
        "CommonTarget":{
            "title":"Common Target",
            "type":"number",
            "description":"Common Target",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code associated with the goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Delete Goal",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Frequency":{
            "title":"Frequency",
            "maxLength":64,
            "type":"string",
            "description":"Frequency",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GoalHistory":{
            "title":"Goal History",
            "type":"array",
            "description":"Goal History",
            "items":{
                "$ref":"#/components/schemas/goals-GoalHistory-item-response"
            }
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Goal ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalMetrics":{
            "title":"Goal Metric",
            "type":"array",
            "description":"Goal Metrics",
            "items":{
                "$ref":"#/components/schemas/goals-GoalMetrics-item-response"
            }
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":275,
            "type":"string",
            "description":"Goal Name",
            "nullable":false,
            "x-queryable":true
        },
        "GoalNumber":{
            "title":"Goal Number",
            "maxLength":64,
            "type":"string",
            "description":"Goal Number",
            "nullable":false,
            "x-queryable":true
        },
        "GoalParticipants":{
            "title":"Goal Participants",
            "type":"array",
            "description":"Goal Participants",
            "items":{
                "$ref":"#/components/schemas/goals-GoalParticipants-item-response"
            }
        },
        "KPIAggregation":{
            "title":"KPI Calculation Type",
            "maxLength":200,
            "type":"string",
            "description":"KPI Calculation Type",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIDescription":{
            "title":"KPI Description",
            "maxLength":3000,
            "type":"string",
            "description":"KPI Description",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "title":"KPI ID",
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIName":{
            "title":"KPI Name",
            "maxLength":275,
            "type":"string",
            "description":"KPI Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KPINumber":{
            "title":"KPI Number",
            "maxLength":64,
            "type":"string",
            "description":"KPI Number",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"Owner ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner Name",
            "maxLength":360,
            "type":"string",
            "description":"Owner Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"Owner Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerUniqueName":{
            "title":"Owner Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"Owner Unique Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TimezoneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Time Zone Code",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Update Goal",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Goal History

Type: array

Title: Goal History

Goal History

Show Source

• Array of: object goals-GoalHistory-item-response

{
    "title":"Goal History",
    "type":"array",
    "description":"Goal History",
    "items":{
        "$ref":"#/components/schemas/goals-GoalHistory-item-response"
    }
}

Nested Schema : Goal Metric

Type: array

Title: Goal Metric

Goal Metrics

Show Source

• Array of: object goals-GoalMetrics-item-response

{
    "title":"Goal Metric",
    "type":"array",
    "description":"Goal Metrics",
    "items":{
        "$ref":"#/components/schemas/goals-GoalMetrics-item-response"
    }
}

Nested Schema : Goal Participants

Type: array

Title: Goal Participants

Goal Participants

Show Source

• Array of: object goals-GoalParticipants-item-response

{
    "title":"Goal Participants",
    "type":"array",
    "description":"Goal Participants",
    "items":{
        "$ref":"#/components/schemas/goals-GoalParticipants-item-response"
    }
}

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 : goals-GoalHistory-item-response

Type: object

Show Source

• DynamicNumber1Name: string
  Read Only: true

  Maximum Length: 200

  Dynamic Number 1 Name
• DynamicNumber1UOM: string
  Read Only: true

  Maximum Length: 200

  Dynamic Number 1 UOM
• DynamicNumber1Value: integer (int64)
  Read Only: true

  Dynamic Number 1 Value
• DynamicNumber2Name: string
  Read Only: true

  Maximum Length: 200

  Dynamic Number 2 Name
• DynamicNumber2UOM: string
  Read Only: true

  Maximum Length: 200

  Dynamic Number 2 UOM
• DynamicNumber2Value: integer (int64)
  Read Only: true

  Dynamic Number 2 Value
• DynamicText1Name: string
  Read Only: true

  Maximum Length: 200

  Dynamic Text 1 Name
• DynamicText1Value: string
  Read Only: true

  Maximum Length: 200

  Dynamic Text 1 Value
• DynamicText2Name: string
  Read Only: true

  Maximum Length: 200

  Dynamic Text 2 Name
• DynamicText2Value: string
  Read Only: true

  Maximum Length: 200

  Dynamic Text 2 Value
• GoalId: integer (int64)
  Read Only: true

  Goal ID
• HistoryParticipantId: integer (int64)
  Read Only: true

  History Participant ID
• HistoryRecordDate: string (date-time)
  Read Only: true

  History Record Date
• HistoryRecordId: integer
  Read Only: true

  History Record ID
• HistoryRecordObjectId: integer (int64)
  Read Only: true

  The unique identifier of the history record object.
• HistoryRecordObjectNumber: string
  Read Only: true

  Maximum Length: 256

  The alternate identifier of the history record object.
• HistoryRecordOwnerId: integer (int64)
  Read Only: true

  History Record Owner ID
• HistoryRecordOwnerName: string
  Read Only: true

  Maximum Length: 360

  The owner of the history record.
• HistoryRecordOwnerNumber: string
  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the history record owner.
• KPIId: integer (int64)
  Read Only: true

  KPI ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StaticText: string
  Read Only: true

  Maximum Length: 4000

  Static Text

{
    "type":"object",
    "properties":{
        "DynamicNumber1Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 1 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber1UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 1 UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber1Value":{
            "type":"integer",
            "description":"Dynamic Number 1 Value",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicNumber2Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 2 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber2UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 2 UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber2Value":{
            "type":"integer",
            "description":"Dynamic Number 2 Value",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicText1Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 1 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText1Value":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 1 Value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText2Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 2 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText2Value":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 2 Value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryParticipantId":{
            "type":"integer",
            "description":"History Participant ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordDate":{
            "type":"string",
            "description":"History Record Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordId":{
            "type":"integer",
            "description":"History Record ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordObjectId":{
            "type":"integer",
            "description":"The unique identifier of the history record object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordObjectNumber":{
            "maxLength":256,
            "type":"string",
            "description":"The alternate identifier of the history record object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerId":{
            "type":"integer",
            "description":"History Record Owner ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordOwnerName":{
            "maxLength":360,
            "type":"string",
            "description":"The owner of the history record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the history record owner.",
            "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
        },
        "StaticText":{
            "maxLength":4000,
            "type":"string",
            "description":"Static Text",
            "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."
        }
    }
}

Nested Schema : goals-GoalMetrics-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Actual":{
            "type":"number",
            "description":"Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeActual":{
            "type":"number",
            "description":"The cumulative actual amount for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeProgress":{
            "type":"number",
            "description":"Cumulative Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeTarget":{
            "type":"number",
            "description":"The cumulative target for the associated goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":4000,
            "type":"string",
            "description":"The currency code associated with the goal.",
            "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
        },
        "DenomRollupActual":{
            "type":"number",
            "description":"Indicates the actual KPI denominator rollup value used in the percentage KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExcludeRootResource":{
            "maxLength":1,
            "type":"string",
            "description":"Exclude Root Resource",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Frequency":{
            "maxLength":64,
            "type":"string",
            "description":"Frequency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalEndDate":{
            "type":"string",
            "description":"Goal End Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalMetricBreakdown":{
            "title":"Goal Metric Breakdowns",
            "type":"array",
            "description":"The goal metric breakdown resource is used to view breakdowns for a goal metric.",
            "items":{
                "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricBreakdown-item-response"
            }
        },
        "GoalMetricDetails":{
            "title":"Goal Metric Detail",
            "type":"array",
            "description":"Goal Metric Details",
            "items":{
                "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricDetails-item-response"
            }
        },
        "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
        },
        "GoalStartDate":{
            "type":"string",
            "description":"Goal Start Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsFirst":{
            "type":"number",
            "description":"Indicates if the current goal metric is the first.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsGoalParticipant":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the metric belongs to a participant of the goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsLast":{
            "type":"number",
            "description":"Indicates if the current goal metric is the last one.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsResourceFromMyOrg":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the metric belongs to a resource in my organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIAggregation":{
            "maxLength":200,
            "type":"string",
            "description":"The KPI calculation type for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":false,
            "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
        },
        "ManagerId":{
            "type":"number",
            "description":"Manager ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Manager Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoOfGoalPeriods":{
            "type":"number",
            "description":"The number of goal periods defined for the goal metric.",
            "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
        },
        "NumerRollupActual":{
            "type":"number",
            "description":"Indicates the actual KPI numerator rollup value used in the percentage KPI calculation for the goal metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Progress":{
            "type":"number",
            "description":"Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Resource Avatar URI",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"number",
            "description":"Resource ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":900,
            "type":"string",
            "description":"Resource Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupActual":{
            "type":"number",
            "description":"Rollup Actual",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupCumulativeActual":{
            "type":"number",
            "description":"The amount that indicates the rollup of the cumulative amount for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupCumulativeProgress":{
            "type":"number",
            "description":"Rollup Cumulative Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupCumulativeTarget":{
            "type":"number",
            "description":"The amount that indicates the cumulative rollup target for the goal metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupProgress":{
            "type":"number",
            "description":"Rollup Progress",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupTarget":{
            "type":"number",
            "description":"Rollup Target",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Target":{
            "type":"number",
            "description":"Target",
            "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 : 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

• Array of: object goals-GoalMetrics-GoalMetricBreakdown-item-response

{
    "title":"Goal Metric Breakdowns",
    "type":"array",
    "description":"The goal metric breakdown resource is used to view breakdowns for a goal metric.",
    "items":{
        "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricBreakdown-item-response"
    }
}

Nested Schema : Goal Metric Detail

Type: array

Title: Goal Metric Detail

Goal Metric Details

Show Source

• Array of: object goals-GoalMetrics-GoalMetricDetails-item-response

{
    "title":"Goal Metric Detail",
    "type":"array",
    "description":"Goal Metric Details",
    "items":{
        "$ref":"#/components/schemas/goals-GoalMetrics-GoalMetricDetails-item-response"
    }
}

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 : goals-GoalMetrics-GoalMetricBreakdown-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "BreakdownFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"The breakdown frequency associated with the current goal metric breakdown.",
            "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
        },
        "BreakdownMeasurementDate":{
            "type":"string",
            "description":"The date when the breakdown measurement was assigned.",
            "format":"date",
            "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
        },
        "BreakdownPeriodStartDate":{
            "type":"string",
            "description":"The date when the goal metric breakdown period starts.",
            "format":"date-time",
            "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
        },
        "DenomDayActual":{
            "type":"number",
            "description":"The day actual KPI denominator value for the goal metrics 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
        },
        "GoalFrequency":{
            "maxLength":64,
            "type":"string",
            "description":"The frequency of the goal associated with the goal metric breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsForLaterDate":{
            "type":"string",
            "description":"Indicates if the goal metric breakdown is for a later date.",
            "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
        },
        "LastDayOfPeriod":{
            "type":"string",
            "description":"The last day of the breakdown period.",
            "format":"date-time",
            "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
        },
        "NumerDayActual":{
            "type":"number",
            "description":"The Day Actual KPI Numerator value for the goal metrics breakdown.",
            "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
        },
        "PeriodRunningActual":{
            "type":"number",
            "description":"The actual period running for the goal metric breakdown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"number",
            "description":"Resource ID",
            "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 : 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 : goals-GoalParticipants-item-response

Type: object

Show Source

• ConflictId: integer (int64)
  Default Value: 0

  Goal Participant Conflict ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Read Only: true

  Creation Date
• GoalId: integer (int64)
  Title: Goal ID

  Goal ID
• GoalNumber: string
  Title: Goal Number

  Maximum Length: 64

  Goal Number
• GoalParticipantId: integer (int64)
  Title: Goal Participant ID

  Goal Participant ID
• LastUpdateDate: string (date-time)
  Read Only: true

  Last Updated Date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last Updated By
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last Update Login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Object Version Number
• ResourceAvatarUri: string
  Read Only: true

  Resource Avatar URI
• ResourceId: integer (int64)
  Title: Resource ID

  Resource ID
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 360

  Resource Name
• ResourceNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  Resource Number
• Target: number
  Title: Target Value

  Target Value

{
    "type":"object",
    "properties":{
        "ConflictId":{
            "type":"integer",
            "description":"Goal Participant Conflict ID",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Goal ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalNumber":{
            "title":"Goal Number",
            "maxLength":64,
            "type":"string",
            "description":"Goal Number",
            "nullable":false,
            "x-queryable":true
        },
        "GoalParticipantId":{
            "title":"Goal Participant ID",
            "type":"integer",
            "description":"Goal Participant ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object Version Number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ResourceAvatarUri":{
            "type":"string",
            "description":"Resource Avatar URI",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Resource ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"Resource Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"Resource Number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Target":{
            "title":"Target Value",
            "type":"number",
            "description":"Target Value",
            "nullable":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"
    }
}

Links

FrequencyVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{Frequency}%2CBindLookupType%3DORA_ZCA_GOAL_FREQUENCY

The following properties are defined on the LOV link relation:

• Source Attribute: Frequency; Target Attribute: LookupCode
• Display Attribute: Meaning

GoalHistory

Operation: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory

Parameters:

• GoalNumber: $request.path.GoalNumber

Goal History

GoalMetrics

Operation: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics

Parameters:

• GoalNumber: $request.path.GoalNumber

Goal Metrics

GoalParticipants

Operation: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalParticipants

Parameters:

• GoalNumber: $request.path.GoalNumber

Goal Participants

Back to Top