Jump to

• Request
• Response

Update a performance goal

patch

/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}

Request

Path Parameters

• GoalPlanId(required): integer(int64)
  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=
• performanceGoalsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- GoalId and GoalPlanGoalId ---for the Performance Goals resource and used to uniquely identify an instance of Performance Goals. The client should not generate the hash key value. Instead, the client should query on the Performance Goals collection resource with a filter on the primary key values in order to navigate to a specific instance of Performance Goals.
  
  For example: performanceGoals?q=GoalId=<value1>;GoalPlanGoalId=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActualCompletionDate: string (date)
  Title: Actual Completion Date

  Actual completion date of the performance goal.
• AllowDelGoalCode: string
  Title: Allow managers to delete this goal

  Maximum Length: 30

  Indicates if managers or workers can delete the performance goal.
• AllowDelGoalFlag: boolean
  Title: Allow managers to delete this goal

  Maximum Length: 30

  Indicates if managers or workers can delete the performance goal.
• AllowKeyAttrUpdateFlag: boolean
  Title: Allow Workers to Update Key Attributes

  Maximum Length: 30

  Default Value: true

  Indicates if managers or workers can update the key attributes of a performance goal.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier for the job assignment of a worker.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  Category code of a performance goal.
• ChildObjectId: integer
  Unique identifier for the child data associated with the performance goal. It can be either the identifier of the goal task or goal measurement.
• ChildObjectName: string
  Maximum Length: 255

  Name of the child object that needs to be returned after loading data from the transaction data store. It can be either perfGoalTasks or perfGoalMeasurements.
• Comments: string (byte)
  Title: Goal-specific Comments

  Comments added to a performance goal.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the performance goal.
• DisplaySequence: integer (int32)
  Display sequence of goals in the goal plan.
• GoalApprovalState: string
  Maximum Length: 30

  Approval state of the goal.
• GoalName: string
  Title: Goal Name

  Maximum Length: 400

  Name of the performance goal.
• GoalSubTypeCode: string
  Title: Subtype

  Maximum Length: 30

  Code that indicates the goal's subtype.
• GoalVersionTypeCode: string
  Title: Goal Version Type

  Maximum Length: 30

  Default Value: ACTIVE

  Version type code of the performance goal.
• LevelCode: string
  Title: Level

  Maximum Length: 30

  Code that indicates the performance goal level.
• LongDescription: string (byte)
  Title: Description

  Long description of the performance goal.
• PercentCompletion: string
  Title: Completion Percentage

  Maximum Length: 30

  Completion percentage of the performance goal.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  Priority code of the performance goal.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 30

  Default Value: false

  Indicates if the performance goal is private or not.
• PublishDate: string (date-time)
  Title: Publication Date

  The date the performance goal was published as an organization goal.
• PublishedFlag: boolean
  Title: Published

  Maximum Length: 30

  Indicates whether the current goal has been published as an organization goal.
• ReferenceGoalId: integer (int64)
  Title: Goal ID

  Unique identifier for the performance goal in the goal plan.
• RelatedLink: string
  Title: Related Link

  Maximum Length: 4000

  Related link of the performance goal.
• RequiredGPGId: string
  Unique identifier for the performance goal in the goal plan.
• RequiresApprovalState: string
  Approval state of the goal.
• RequiresApprovalStatus: string
  Indicates whether the goal requires an approval status. Valid values are Y and N.
• ReviewPeriodId: integer (int64)
  Unique Identifier for the review period that the goal plan of the performance goal is associated with.
• StartDate: string (date)
  Title: Start Date

  Start date of the performance goal.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: NOT_STARTED

  Code that indicates the status of the performance goal.
• SuccessCriteria: string (byte)
  Title: Success Criteria

  Success criteria of the performance goal.
• TargetCompletionDate: string (date)
  Title: Target Completion Date

  Targeted completion date of the performance goal.
• Weighting: number
  Title: Weight

  Weight of the performance goal.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category code of a performance goal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PublishDate":{
            "title":"Publication Date",
            "type":"string",
            "description":"The date the performance goal was published as an organization goal.",
            "format":"date-time",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the performance goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LevelCode":{
            "title":"Level",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the performance goal level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence of goals in the goal plan.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"Priority code of the performance goal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the performance goal is private or not.",
            "nullable":false,
            "default":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the status of the performance goal.",
            "nullable":false,
            "default":"NOT_STARTED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GoalApprovalState":{
            "maxLength":"30",
            "type":"string",
            "description":"Approval state of the goal.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the performance goal.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequiresApprovalStatus":{
            "type":"string",
            "description":"Indicates whether the goal requires an approval status. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier for the job assignment of a worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelatedLink":{
            "title":"Related Link",
            "maxLength":"4000",
            "type":"string",
            "description":"Related link of the performance goal.",
            "nullable":true
        },
        "GoalVersionTypeCode":{
            "title":"Goal Version Type",
            "maxLength":"30",
            "type":"string",
            "description":"Version type code of the performance goal.",
            "nullable":false,
            "default":"ACTIVE"
        },
        "AllowKeyAttrUpdateFlag":{
            "title":"Allow Workers to Update Key Attributes",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if managers or workers can update the key attributes of a performance goal.",
            "nullable":true,
            "default":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the performance goal.",
            "format":"date",
            "nullable":true
        },
        "AllowDelGoalCode":{
            "title":"Allow managers to delete this goal",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if managers or workers can delete the performance goal.",
            "nullable":true
        },
        "AllowDelGoalFlag":{
            "title":"Allow managers to delete this goal",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if managers or workers can delete the performance goal.",
            "nullable":true
        },
        "Comments":{
            "title":"Goal-specific Comments",
            "type":"string",
            "description":"Comments added to a performance goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"Success criteria of the performance goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RequiredGPGId":{
            "type":"string",
            "description":"Unique identifier for the performance goal in the goal plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ChildObjectId":{
            "type":"integer",
            "description":"Unique identifier for the child data associated with the performance goal. It can be either the identifier of the goal task or goal measurement.",
            "nullable":true
        },
        "ReferenceGoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Unique identifier for the performance goal in the goal plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PercentCompletion":{
            "title":"Completion Percentage",
            "maxLength":"30",
            "type":"string",
            "description":"Completion percentage of the performance goal.",
            "nullable":true
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"Targeted completion date of the performance goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Weighting":{
            "title":"Weight",
            "type":"number",
            "description":"Weight of the performance goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"5",
                "scale":"2"
            }
        },
        "LongDescription":{
            "title":"Description",
            "type":"string",
            "description":"Long description of the performance goal.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequiresApprovalState":{
            "type":"string",
            "description":"Approval state of the goal.",
            "nullable":true,
            "x-queryable":false
        },
        "ChildObjectName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the child object that needs to be returned after loading data from the transaction data store. It can be either perfGoalTasks or perfGoalMeasurements.",
            "nullable":true
        },
        "ReviewPeriodId":{
            "type":"integer",
            "description":"Unique Identifier for the review period that the goal plan of the performance goal is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":"400",
            "type":"string",
            "description":"Name of the performance goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalSubTypeCode":{
            "title":"Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the goal's subtype.",
            "nullable":true
        },
        "PublishedFlag":{
            "title":"Published",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the current goal has been published as an organization goal.",
            "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 : goalPlans-performanceGoals-item-response

Type: object

Show Source

• ActualCompletionDate: string (date)
  Title: Actual Completion Date

  Actual completion date of the performance goal.
• AllowDelGoalCode: string
  Title: Allow managers to delete this goal

  Maximum Length: 30

  Indicates if managers or workers can delete the performance goal.
• AllowDelGoalFlag: boolean
  Title: Allow managers to delete this goal

  Maximum Length: 30

  Indicates if managers or workers can delete the performance goal.
• AllowKeyAttrUpdateFlag: boolean
  Title: Allow Workers to Update Key Attributes

  Maximum Length: 30

  Default Value: true

  Indicates if managers or workers can update the key attributes of a performance goal.
• AssignedByPersonId: integer (int64)
  Title: Created By

  Unique identifier for the HR specialist or manager who assigns the performance goal.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier for the job assignment of a worker.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Unique assignment number for a worker assignment.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  Category code of a performance goal.
• CategoryMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description for the associated category code of a performance goal.
• ChildObjectId: integer
  Unique identifier for the child data associated with the performance goal. It can be either the identifier of the goal task or goal measurement.
• ChildObjectName: string
  Maximum Length: 255

  Name of the child object that needs to be returned after loading data from the transaction data store. It can be either perfGoalTasks or perfGoalMeasurements.
• Comments: string (byte)
  Title: Goal-specific Comments

  Comments added to a performance goal.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the performance goal.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date the performance goal was created.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the performance goal.
• DisplaySequence: integer (int32)
  Display sequence of goals in the goal plan.
• GoalApprovalState: string
  Maximum Length: 30

  Approval state of the goal.
• GoalId: integer (int64)
  Title: Goal ID

  Unique identifier for a performance goal.
• GoalName: string
  Title: Goal Name

  Maximum Length: 400

  Name of the performance goal.
• GoalPlanGoalId: integer (int64)
  Unique identifier for the performance goal in the goal plan.
• GoalPlanId: integer (int64)
  Title: Goal Plan Name

  Unique identifier of the goal plan.
• GoalSourceCode: string
  Title: Source

  Maximum Length: 30

  Source code that indicates who created the performance goal. A performance goal can be created by a worker, a manager, or an HR specialist.
• GoalSubTypeCode: string
  Title: Subtype

  Maximum Length: 30

  Code that indicates the goal's subtype.
• GoalSubtypeMeaning: string
  Title: Subtype

  Read Only: true

  Maximum Length: 80

  Code used in HCM_LOOKUPS for the goal's subtype.
• GoalVersionTypeCode: string
  Title: Goal Version Type

  Maximum Length: 30

  Default Value: ACTIVE

  Version type code of the performance goal.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date the performance goal was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the performance goal.
• LevelCode: string
  Title: Level

  Maximum Length: 30

  Code that indicates the performance goal level.
• LevelMeaning: string
  Title: Level

  Read Only: true

  Maximum Length: 80

  Performance goal level, which can be Target or Stretch.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Unique person identifier for the logged in person.
• LongDescription: string (byte)
  Title: Description

  Long description of the performance goal.
• MassRequestId: integer (int64)
  Unique identifier for the mass assignment or mass share request.
• PercentCompletion: string
  Title: Completion Percentage

  Maximum Length: 30

  Completion percentage of the performance goal.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier for the worker who's assigned the performance goal.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the worker who's assigned the performance goal.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  Priority code of the performance goal.
• PriorityMeaning: string
  Title: Priority

  Read Only: true

  Maximum Length: 80

  Priority of the performance goal, which can be High, Medium, or Low.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 30

  Default Value: false

  Indicates if the performance goal is private or not.
• PublishDate: string (date-time)
  Title: Publication Date

  The date the performance goal was published as an organization goal.
• PublishedFlag: boolean
  Title: Published

  Maximum Length: 30

  Indicates whether the current goal has been published as an organization goal.
• ReferenceGoalId: integer (int64)
  Title: Goal ID

  Unique identifier for the performance goal in the goal plan.
• RelatedLink: string
  Title: Related Link

  Maximum Length: 4000

  Related link of the performance goal.
• RequestContext: string
  Maximum Length: 30

  Page from which the performance goal was created. Performance goals can be created on the employee's Goals page, the manager page, or the goal administrator page.
• RequiredGPGId: string
  Unique identifier for the performance goal in the goal plan.
• RequiresApprovalState: string
  Approval state of the goal.
• RequiresApprovalStatus: string
  Indicates whether the goal requires an approval status. Valid values are Y and N.
• ReviewPeriodId: integer (int64)
  Unique Identifier for the review period that the goal plan of the performance goal is associated with.
• StartDate: string (date)
  Title: Start Date

  Start date of the performance goal.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: NOT_STARTED

  Code that indicates the status of the performance goal.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the performance goal.
• SuccessCriteria: string (byte)
  Title: Success Criteria

  Success criteria of the performance goal.
• TargetCompletionDate: string (date)
  Title: Target Completion Date

  Targeted completion date of the performance goal.
• Weighting: number
  Title: Weight

  Weight of the performance goal.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category code of a performance goal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date the performance goal was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PublishDate":{
            "title":"Publication Date",
            "type":"string",
            "description":"The date the performance goal was published as an organization goal.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the performance goal is private or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AssignedByPersonId":{
            "title":"Created By",
            "type":"integer",
            "description":"Unique identifier for the HR specialist or manager who assigns the performance goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GoalPlanGoalId":{
            "type":"integer",
            "description":"Unique identifier for the performance goal in the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LevelMeaning":{
            "title":"Level",
            "maxLength":"80",
            "type":"string",
            "description":"Performance goal level, which can be Target or Stretch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the status of the performance goal.",
            "nullable":false,
            "default":"NOT_STARTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GoalApprovalState":{
            "maxLength":"30",
            "type":"string",
            "description":"Approval state of the goal.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the performance goal.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalSourceCode":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"Source code that indicates who created the performance goal. A performance goal can be created by a worker, a manager, or an HR specialist.",
            "nullable":false,
            "x-queryable":true
        },
        "GoalPlanId":{
            "title":"Goal Plan Name",
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MassRequestId":{
            "type":"integer",
            "description":"Unique identifier for the mass assignment or mass share request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelatedLink":{
            "title":"Related Link",
            "maxLength":"4000",
            "type":"string",
            "description":"Related link of the performance goal.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowKeyAttrUpdateFlag":{
            "title":"Allow Workers to Update Key Attributes",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if managers or workers can update the key attributes of a performance goal.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RequestContext":{
            "maxLength":"30",
            "type":"string",
            "description":"Page from which the performance goal was created. Performance goals can be created on the employee's Goals page, the manager page, or the goal administrator page.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the performance goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the performance goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LoggedInPersonType":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique person identifier for the logged in person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredGPGId":{
            "type":"string",
            "description":"Unique identifier for the performance goal in the goal plan.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description for the associated category code of a performance goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceGoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Unique identifier for the performance goal in the goal plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PercentCompletion":{
            "title":"Completion Percentage",
            "maxLength":"30",
            "type":"string",
            "description":"Completion percentage of the performance goal.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"Targeted completion date of the performance goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier for the worker who's assigned the performance goal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GoalSubtypeMeaning":{
            "title":"Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"Code used in HCM_LOOKUPS for the goal's subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewPeriodId":{
            "type":"integer",
            "description":"Unique Identifier for the review period that the goal plan of the performance goal is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":"400",
            "type":"string",
            "description":"Name of the performance goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityMeaning":{
            "title":"Priority",
            "maxLength":"80",
            "type":"string",
            "description":"Priority of the performance goal, which can be High, Medium, or Low.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedFlag":{
            "title":"Published",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the current goal has been published as an organization goal.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the performance goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LevelCode":{
            "title":"Level",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the performance goal level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence of goals in the goal plan.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"Priority code of the performance goal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequiresApprovalStatus":{
            "type":"string",
            "description":"Indicates whether the goal requires an approval status. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique assignment number for a worker assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier for the job assignment of a worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GoalVersionTypeCode":{
            "title":"Goal Version Type",
            "maxLength":"30",
            "type":"string",
            "description":"Version type code of the performance goal.",
            "nullable":false,
            "default":"ACTIVE",
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the performance goal.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Unique identifier for a performance goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the worker who's assigned the performance goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowDelGoalCode":{
            "title":"Allow managers to delete this goal",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if managers or workers can delete the performance goal.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowDelGoalFlag":{
            "title":"Allow managers to delete this goal",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if managers or workers can delete the performance goal.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Goal-specific Comments",
            "type":"string",
            "description":"Comments added to a performance goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"Success criteria of the performance goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChildObjectId":{
            "type":"integer",
            "description":"Unique identifier for the child data associated with the performance goal. It can be either the identifier of the goal task or goal measurement.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the performance goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Weighting":{
            "title":"Weight",
            "type":"number",
            "description":"Weight of the performance goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Description",
            "type":"string",
            "description":"Long description of the performance goal.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequiresApprovalState":{
            "type":"string",
            "description":"Approval state of the goal.",
            "nullable":true,
            "x-queryable":false
        },
        "ChildObjectName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the child object that needs to be returned after loading data from the transaction data store. It can be either perfGoalTasks or perfGoalMeasurements.",
            "nullable":true,
            "x-queryable":true
        },
        "GoalSubTypeCode":{
            "title":"Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the goal's subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date the performance goal was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Links

GoalStatusCommonLookupLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHRG_GOAL_STATUS

The following properties are defined on the LOV link relation:

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

checkGoalInPDAndCheckInDoc

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/checkGoalInPDAndCheckInDoc

Parameters:

• GoalPlanId: $request.path.GoalPlanId
• performanceGoalsUniqID: $request.path.performanceGoalsUniqID

copyGoal

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/copyGoal

Parameters:

• GoalPlanId: $request.path.GoalPlanId
• performanceGoalsUniqID: $request.path.performanceGoalsUniqID

Copies a performance goal and creates a new performance goal that has the same attributes as the goal that's copied.

goalAssignAction

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/goalAssignAction

Parameters:

• GoalPlanId: $request.path.GoalPlanId
• performanceGoalsUniqID: $request.path.performanceGoalsUniqID

Assigns a performance goal to the selected employees.

Back to Top