Jump to

• Request
• Response

Update a goal plan

patch

/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}

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=

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

• associatedPerfDocumentTypes: array Associated Performance Document Types
  Title: Associated Performance Document Types

  The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.
• CanDelHRGoal: string
  Title: Actions for Workers and Managers on HR-Assigned Goals

  Maximum Length: 60

  Indicates the actions managers and workers can perform on performance goals assigned by the HR specialist.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the goal plan.
• EnableWeightingFlag: boolean
  Title: Enable Weight

  Maximum Length: 30

  Default Value: true

  Indicates whether weights are enabled for the goals in the goal plan.
• EndDate: string (date)
  Title: End Date

  End date of the goal plan.
• EnforceGoalWeightFlag: boolean
  Maximum Length: 30

  Default Value: false

  Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.
• EnforceMaximumGoalsInGpFlag: boolean
  Title: Enforce maximum goals

  Maximum Length: 30

  Indicates if maximum goals in goal plan is enforced or not.
• EvaluationType: string
  Title: Evaluation Type

  Maximum Length: 30

  Default Value: ORA_HRA_EVAL_TYPE_DEFAULT

  Specifies the type of evaluation in the performance document template. Goal plans that have the same evaluation type as that defined in the performance template are automatically added as evaluation topics.
• GoalAccessLevelCode: string
  Title: Allow Updates to Goals By

  Maximum Length: 30

  Default Value: ALL

  Code that specifies the roles that can access the goals in the goal plan.
• GoalPlanActiveCode: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  Indicates if the goal plan is active or inactive. Valid values are A and I.
• GoalPlanExternalId: string
  Title: External ID

  Maximum Length: 250

  Unique external identifier of the goal plan.
• GoalPlanName: string
  Title: Goal Plan Name

  Maximum Length: 400

  Name of the goal plan.
• GoalPlanTypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: ORA_HRG_WORKER

  Indicates the type of goal plan. The default value is Worker.
• GoalSubTypeCode: string
  Title: Subtype

  Maximum Length: 30

  Indicates the type of goal plan. The default value is Worker.
• MaximumGoalsNumberInGoalPlan: integer (int64)
  Maximum goals allowed in the goal plan.
• MinimumGoalsNumberInGoalPlan: integer (int64)
  Minimum number of goals that the goal plan needs to have.
• perfGoalEligibilityProfiles: array Performance Goal Eligibility Profiles
  Title: Performance Goal Eligibility Profiles

  The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.
• perfGoalExcludedWorkers: array Performance Goal Excluded Workers
  Title: Performance Goal Excluded Workers

  The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.
• perfGoalIncludedWorkers: array Performance Goal Included Workers
  Title: Performance Goal Included Workers

  The perfGoalInccludedWorkers resource provides all workers included in a goal plan.
• performanceGoals: array Performance Goals
  Title: Performance Goals

  The performanceGoalsV2 resource provides performance goals of workers.
• PrimaryGoalPlanFlag: boolean
  Maximum Length: 30

  Default Value: false

  Indicates if the goal plan is the primary goal plan.
• RequestStatus: string
  Maximum Length: 30

  Status of the performance document synchronization process.
• ReviewPeriodId: integer (int64)
  Title: Review Period

  Unique identifier of the review period associated with the goal plan.
• StartDate: string (date)
  Title: Start Date

  Start date of the goal plan.

{
    "type":"object",
    "properties":{
        "MaximumGoalsNumberInGoalPlan":{
            "type":"integer",
            "description":"Maximum goals allowed in the goal plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the goal plan.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EnforceMaximumGoalsInGpFlag":{
            "title":"Enforce maximum goals",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if maximum goals in goal plan is enforced or not.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "perfGoalIncludedWorkers":{
            "title":"Performance Goal Included Workers",
            "type":"array",
            "description":"The perfGoalInccludedWorkers resource provides all workers included in a goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-perfGoalIncludedWorkers-item-patch-request"
            }
        },
        "CanDelHRGoal":{
            "title":"Actions for Workers and Managers on HR-Assigned Goals",
            "maxLength":"60",
            "type":"string",
            "description":"Indicates the actions managers and workers can perform on performance goals assigned by the HR specialist.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalPlanTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of goal plan. The default value is Worker.",
            "nullable":false,
            "default":"ORA_HRG_WORKER"
        },
        "GoalAccessLevelCode":{
            "title":"Allow Updates to Goals By",
            "maxLength":"30",
            "type":"string",
            "description":"Code that specifies the roles that can access the goals in the goal plan.",
            "nullable":true,
            "default":"ALL",
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EnforceGoalWeightFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the goal plan.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PrimaryGoalPlanFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the goal plan is the primary goal plan.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EnableWeightingFlag":{
            "title":"Enable Weight",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether weights are enabled for the goals in the goal plan.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MinimumGoalsNumberInGoalPlan":{
            "type":"integer",
            "description":"Minimum number of goals that the goal plan needs to have.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the goal plan.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalPlanActiveCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the goal plan is active or inactive. Valid values are A and I.",
            "nullable":true,
            "default":"A",
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "associatedPerfDocumentTypes":{
            "title":"Associated Performance Document Types",
            "type":"array",
            "description":"The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-associatedPerfDocumentTypes-item-patch-request"
            }
        },
        "perfGoalExcludedWorkers":{
            "title":"Performance Goal Excluded Workers",
            "type":"array",
            "description":"The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-perfGoalExcludedWorkers-item-patch-request"
            }
        },
        "ReviewPeriodId":{
            "title":"Review Period",
            "type":"integer",
            "description":"Unique identifier of the review period associated with the goal plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "perfGoalEligibilityProfiles":{
            "title":"Performance Goal Eligibility Profiles",
            "type":"array",
            "description":"The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-perfGoalEligibilityProfiles-item-patch-request"
            }
        },
        "EvaluationType":{
            "title":"Evaluation Type",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the type of evaluation in the performance document template. Goal plans that have the same evaluation type as that defined in the performance template are automatically added as evaluation topics.",
            "nullable":true,
            "default":"ORA_HRA_EVAL_TYPE_DEFAULT",
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalPlanExternalId":{
            "title":"External ID",
            "maxLength":"250",
            "type":"string",
            "description":"Unique external identifier of the goal plan.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalSubTypeCode":{
            "title":"Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of goal plan. The default value is Worker.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "performanceGoals":{
            "title":"Performance Goals",
            "type":"array",
            "description":"The performanceGoalsV2 resource provides performance goals of workers.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-performanceGoals-item-patch-request"
            }
        },
        "GoalPlanName":{
            "title":"Goal Plan Name",
            "maxLength":"400",
            "type":"string",
            "description":"Name of the goal plan.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the performance document synchronization process.",
            "nullable":true
        }
    }
}

Nested Schema : Associated Performance Document Types

Type: array

Title: Associated Performance Document Types

The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.

Show Source

• Array of: object goalPlans-associatedPerfDocumentTypes-item-patch-request

{
    "title":"Associated Performance Document Types",
    "type":"array",
    "description":"The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-associatedPerfDocumentTypes-item-patch-request"
    }
}

Nested Schema : Performance Goal Eligibility Profiles

Type: array

Title: Performance Goal Eligibility Profiles

The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.

Show Source

• Array of: object goalPlans-perfGoalEligibilityProfiles-item-patch-request

{
    "title":"Performance Goal Eligibility Profiles",
    "type":"array",
    "description":"The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-perfGoalEligibilityProfiles-item-patch-request"
    }
}

Nested Schema : Performance Goal Excluded Workers

Type: array

Title: Performance Goal Excluded Workers

The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.

Show Source

• Array of: object goalPlans-perfGoalExcludedWorkers-item-patch-request

{
    "title":"Performance Goal Excluded Workers",
    "type":"array",
    "description":"The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-perfGoalExcludedWorkers-item-patch-request"
    }
}

Nested Schema : Performance Goal Included Workers

Type: array

Title: Performance Goal Included Workers

The perfGoalInccludedWorkers resource provides all workers included in a goal plan.

Show Source

• Array of: object goalPlans-perfGoalIncludedWorkers-item-patch-request

{
    "title":"Performance Goal Included Workers",
    "type":"array",
    "description":"The perfGoalInccludedWorkers resource provides all workers included in a goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-perfGoalIncludedWorkers-item-patch-request"
    }
}

Nested Schema : Performance Goals

Type: array

Title: Performance Goals

The performanceGoalsV2 resource provides performance goals of workers.

Show Source

• Array of: object goalPlans-performanceGoals-item-patch-request

{
    "title":"Performance Goals",
    "type":"array",
    "description":"The performanceGoalsV2 resource provides performance goals of workers.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-performanceGoals-item-patch-request"
    }
}

Nested Schema : goalPlans-associatedPerfDocumentTypes-item-patch-request

Type: object

Show Source

• DocumentTypeId: integer (int64)
  Unique identifier for the performance document type.
• GoalPlanDocumentTypeId: integer (int64)
  Unique identifier of the goal plan document type.
• GoalPlanId: integer (int64)
  Unique identifier of the goal plan.

{
    "type":"object",
    "properties":{
        "GoalPlanDocumentTypeId":{
            "type":"integer",
            "description":"Unique identifier of the goal plan document type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "GoalPlanId":{
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "DocumentTypeId":{
            "type":"integer",
            "description":"Unique identifier for the performance document type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        }
    }
}

Nested Schema : goalPlans-perfGoalEligibilityProfiles-item-patch-request

Type: object

Show Source

• EligibilityProfileId: integer (int64)
  Title: Eligibility Profile

  Unique identifier for the eligibility profile.
• EligibilityProfileObjectId: integer (int64)
  Unique identifier for the eligibility profile in the associated goal plan.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 1

  Indicates if the eligibility profile is required or not.

{
    "type":"object",
    "properties":{
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the eligibility profile is required or not.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EligibilityProfileObjectId":{
            "type":"integer",
            "description":"Unique identifier for the eligibility profile in the associated goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "EligibilityProfileId":{
            "title":"Eligibility Profile",
            "type":"integer",
            "description":"Unique identifier for the eligibility profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        }
    }
}

Nested Schema : goalPlans-perfGoalExcludedWorkers-item-patch-request

Type: object

Show Source

• AssignmentId: integer (int64)
  Unique identifier for the assignment of the worker excluded from the goal plan.
• PersonId: integer (int64)
  Title: Person

  Unique identifier for the mass request hierarchy.
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker excluded from the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : goalPlans-perfGoalIncludedWorkers-item-patch-request

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Manager Assignment

  Unique identifier for the assignment of the worker included in the goal plan.
• CascadingLevel: integer (int64)
  Title: Assignees

  A code that determines which employees reporting to the requester will be assigned the performance goals in the goal plan. The performance goals can be assigned only to the requester, all direct reports of the requester, requester and their direct reports, all persons reporting to the requester, and requester and all persons reporting to the requester.
• PersonId: integer (int64)
  Title: Person

  Unique identifier of the worker included in the goal plan.
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "title":"Manager Assignment",
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker included in the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "CascadingLevel":{
            "title":"Assignees",
            "type":"integer",
            "description":"A code that determines which employees reporting to the requester will be assigned the performance goals in the goal plan. The performance goals can be assigned only to the requester, all direct reports of the requester, requester and their direct reports, all persons reporting to the requester, and requester and all persons reporting to the requester.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier of the worker included in the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : goalPlans-performanceGoals-item-patch-request

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.
• RelatedLink: string
  Title: Related Link

  Maximum Length: 4000

  Related link of the performance goal.
• 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
        },
        "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
        },
        "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-item-response

Type: object

Show Source

• Assignees: integer
  Title: Assignees

  Read Only: true

  Number of goal plan assignees.
• associatedPerfDocumentTypes: array Associated Performance Document Types
  Title: Associated Performance Document Types

  The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.
• CanDelHRGoal: string
  Title: Actions for Workers and Managers on HR-Assigned Goals

  Maximum Length: 60

  Indicates the actions managers and workers can perform on performance goals assigned by the HR specialist.
• CanDelHRGoalMeaning: string
  Title: Actions for Workers and Managers on HR-Assigned Goals

  Read Only: true

  Maximum Length: 80

  Description corresponding to the actions managers and workers can perform on performance goals assigned by the HR specialist.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the goal plan.
• CreationDate: string (date-time)
  Read Only: true

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

  Maximum Length: 4000

  Description of the goal plan.
• EnableWeightingFlag: boolean
  Title: Enable Weight

  Maximum Length: 30

  Default Value: true

  Indicates whether weights are enabled for the goals in the goal plan.
• EndDate: string (date)
  Title: End Date

  End date of the goal plan.
• EnforceGoalWeightFlag: boolean
  Maximum Length: 30

  Default Value: false

  Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.
• EnforceMaximumGoalsInGpFlag: boolean
  Title: Enforce maximum goals

  Maximum Length: 30

  Indicates if maximum goals in goal plan is enforced or not.
• EvaluationType: string
  Title: Evaluation Type

  Maximum Length: 30

  Default Value: ORA_HRA_EVAL_TYPE_DEFAULT

  Specifies the type of evaluation in the performance document template. Goal plans that have the same evaluation type as that defined in the performance template are automatically added as evaluation topics.
• EvaluationTypeMeaning: string
  Title: Evaluation Type

  Read Only: true

  Maximum Length: 80

  Description of the evaluation type.
• GoalAccessLevelCode: string
  Title: Allow Updates to Goals By

  Maximum Length: 30

  Default Value: ALL

  Code that specifies the roles that can access the goals in the goal plan.
• GoalAccessLevelMeaning: string
  Title: Allow Updates to Goals By

  Read Only: true

  Maximum Length: 80

  Description of the goal access level code. This value is validated against HCM_LOOKUPS with the lookup type HRG_GOAL_ACCESS_LEVELS.
• GoalPlanActiveCode: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  Indicates if the goal plan is active or inactive. Valid values are A and I.
• GoalPlanActiveCodeMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Description of the goal plan active indicator. This value is validated against HCM_LOOKUPS with lookup type ACTIVE_INACTIVE.
• GoalPlanExternalId: string
  Title: External ID

  Maximum Length: 250

  Unique external identifier of the goal plan.
• GoalPlanId: integer (int64)
  Title: Goal Plan Name

  Unique identifier of the goal plan.
• GoalPlanName: string
  Title: Goal Plan Name

  Maximum Length: 400

  Name of the goal plan.
• GoalPlanTypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: ORA_HRG_WORKER

  Indicates the type of goal plan. The default value is Worker.
• GoalsCount: integer
  Read Only: true

  Count of performance goals in the goal plan.
• GoalSubTypeCode: string
  Title: Subtype

  Maximum Length: 30

  Indicates the type of goal plan. The default value is Worker.
• GoalSubTypeLookupCode: string
  Title: Lookup Code

  Read Only: true

  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the goal plan was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the goal plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassRequestId: integer (int64)
  Unique identifier for the goal plan mass request.
• MaximumGoalsNumberInGoalPlan: integer (int64)
  Maximum goals allowed in the goal plan.
• MinimumGoalsNumberInGoalPlan: integer (int64)
  Minimum number of goals that the goal plan needs to have.
• NbrOfPDConsumed: integer
  Read Only: true

  Number of performance documents in which the performance goal is included.
• perfGoalEligibilityProfiles: array Performance Goal Eligibility Profiles
  Title: Performance Goal Eligibility Profiles

  The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.
• perfGoalExcludedWorkers: array Performance Goal Excluded Workers
  Title: Performance Goal Excluded Workers

  The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.
• perfGoalIncludedWorkers: array Performance Goal Included Workers
  Title: Performance Goal Included Workers

  The perfGoalInccludedWorkers resource provides all workers included in a goal plan.
• performanceGoals: array Performance Goals
  Title: Performance Goals

  The performanceGoalsV2 resource provides performance goals of workers.
• PrimaryGoalPlanFlag: boolean
  Maximum Length: 30

  Default Value: false

  Indicates if the goal plan is the primary goal plan.
• RequestStatus: string
  Maximum Length: 30

  Status of the performance document synchronization process.
• ReviewPeriodId: integer (int64)
  Title: Review Period

  Unique identifier of the review period associated with the goal plan.
• ReviewPeriodName: string
  Title: Review Period

  Read Only: true

  Maximum Length: 400

  Name of the review period.
• StartDate: string (date)
  Title: Start Date

  Start date of the goal plan.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date the goal plan was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumGoalsNumberInGoalPlan":{
            "type":"integer",
            "description":"Maximum goals allowed in the goal plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the goal plan.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EnforceMaximumGoalsInGpFlag":{
            "title":"Enforce maximum goals",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if maximum goals in goal plan is enforced or not.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalPlanTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of goal plan. The default value is Worker.",
            "nullable":false,
            "default":"ORA_HRG_WORKER",
            "x-queryable":true
        },
        "GoalAccessLevelCode":{
            "title":"Allow Updates to Goals By",
            "maxLength":"30",
            "type":"string",
            "description":"Code that specifies the roles that can access the goals in the goal plan.",
            "nullable":true,
            "default":"ALL",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EnforceGoalWeightFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PrimaryGoalPlanFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the goal plan is the primary goal plan.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EnableWeightingFlag":{
            "title":"Enable Weight",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether weights are enabled for the goals in the goal plan.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MinimumGoalsNumberInGoalPlan":{
            "type":"integer",
            "description":"Minimum number of goals that the goal plan needs to have.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GoalsCount":{
            "type":"integer",
            "description":"Count of performance goals in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the goal plan.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalSubTypeLookupCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the goal's subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalPlanActiveCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the goal plan is active or inactive. Valid values are A and I.",
            "nullable":true,
            "default":"A",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalPlanId":{
            "title":"Goal Plan Name",
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "MassRequestId":{
            "type":"integer",
            "description":"Unique identifier for the goal plan mass request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "perfGoalEligibilityProfiles":{
            "title":"Performance Goal Eligibility Profiles",
            "type":"array",
            "description":"The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-perfGoalEligibilityProfiles-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReviewPeriodName":{
            "title":"Review Period",
            "maxLength":"400",
            "type":"string",
            "description":"Name of the review period.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Assignees":{
            "title":"Assignees",
            "type":"integer",
            "description":"Number of goal plan assignees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "performanceGoals":{
            "title":"Performance Goals",
            "type":"array",
            "description":"The performanceGoalsV2 resource provides performance goals of workers.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-performanceGoals-item-response"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "perfGoalIncludedWorkers":{
            "title":"Performance Goal Included Workers",
            "type":"array",
            "description":"The perfGoalInccludedWorkers resource provides all workers included in a goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-perfGoalIncludedWorkers-item-response"
            }
        },
        "CanDelHRGoal":{
            "title":"Actions for Workers and Managers on HR-Assigned Goals",
            "maxLength":"60",
            "type":"string",
            "description":"Indicates the actions managers and workers can perform on performance goals assigned by the HR specialist.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalPlanActiveCodeMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the goal plan active indicator. This value is validated against HCM_LOOKUPS with lookup type ACTIVE_INACTIVE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the goal plan.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EvaluationTypeMeaning":{
            "title":"Evaluation Type",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the evaluation type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalAccessLevelMeaning":{
            "title":"Allow Updates to Goals By",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the goal access level code. This value is validated against HCM_LOOKUPS with the lookup type HRG_GOAL_ACCESS_LEVELS.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "associatedPerfDocumentTypes":{
            "title":"Associated Performance Document Types",
            "type":"array",
            "description":"The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-associatedPerfDocumentTypes-item-response"
            }
        },
        "perfGoalExcludedWorkers":{
            "title":"Performance Goal Excluded Workers",
            "type":"array",
            "description":"The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.",
            "items":{
                "$ref":"#/components/schemas/goalPlans-perfGoalExcludedWorkers-item-response"
            }
        },
        "CanDelHRGoalMeaning":{
            "title":"Actions for Workers and Managers on HR-Assigned Goals",
            "maxLength":"80",
            "type":"string",
            "description":"Description corresponding to the actions managers and workers can perform on performance goals assigned by the HR specialist.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReviewPeriodId":{
            "title":"Review Period",
            "type":"integer",
            "description":"Unique identifier of the review period associated with the goal plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "EvaluationType":{
            "title":"Evaluation Type",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the type of evaluation in the performance document template. Goal plans that have the same evaluation type as that defined in the performance template are automatically added as evaluation topics.",
            "nullable":true,
            "default":"ORA_HRA_EVAL_TYPE_DEFAULT",
            "x-hints":{
                "includeInCompactView":true
            },
            "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-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalPlanExternalId":{
            "title":"External ID",
            "maxLength":"250",
            "type":"string",
            "description":"Unique external identifier of the goal plan.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalSubTypeCode":{
            "title":"Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of goal plan. The default value is Worker.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NbrOfPDConsumed":{
            "type":"integer",
            "description":"Number of performance documents in which the performance goal is included.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalPlanName":{
            "title":"Goal Plan Name",
            "maxLength":"400",
            "type":"string",
            "description":"Name of the goal plan.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the goal plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the performance document synchronization process.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Associated Performance Document Types

Type: array

Title: Associated Performance Document Types

The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.

Show Source

• Array of: object goalPlans-associatedPerfDocumentTypes-item-response

{
    "title":"Associated Performance Document Types",
    "type":"array",
    "description":"The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-associatedPerfDocumentTypes-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 : Performance Goal Eligibility Profiles

Type: array

Title: Performance Goal Eligibility Profiles

The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.

Show Source

• Array of: object goalPlans-perfGoalEligibilityProfiles-item-response

{
    "title":"Performance Goal Eligibility Profiles",
    "type":"array",
    "description":"The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-perfGoalEligibilityProfiles-item-response"
    }
}

Nested Schema : Performance Goal Excluded Workers

Type: array

Title: Performance Goal Excluded Workers

The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.

Show Source

• Array of: object goalPlans-perfGoalExcludedWorkers-item-response

{
    "title":"Performance Goal Excluded Workers",
    "type":"array",
    "description":"The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-perfGoalExcludedWorkers-item-response"
    }
}

Nested Schema : Performance Goal Included Workers

Type: array

Title: Performance Goal Included Workers

The perfGoalInccludedWorkers resource provides all workers included in a goal plan.

Show Source

• Array of: object goalPlans-perfGoalIncludedWorkers-item-response

{
    "title":"Performance Goal Included Workers",
    "type":"array",
    "description":"The perfGoalInccludedWorkers resource provides all workers included in a goal plan.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-perfGoalIncludedWorkers-item-response"
    }
}

Nested Schema : Performance Goals

Type: array

Title: Performance Goals

The performanceGoalsV2 resource provides performance goals of workers.

Show Source

• Array of: object goalPlans-performanceGoals-item-response

{
    "title":"Performance Goals",
    "type":"array",
    "description":"The performanceGoalsV2 resource provides performance goals of workers.",
    "items":{
        "$ref":"#/components/schemas/goalPlans-performanceGoals-item-response"
    }
}

Nested Schema : goalPlans-associatedPerfDocumentTypes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the performance document type associated with the goal plan.
• CreationDate: string (date-time)
  Read Only: true

  Date the performance document type associated with the goal plan was created.
• DocumentTypeId: integer (int64)
  Unique identifier for the performance document type.
• GoalPlanDocumentTypeId: integer (int64)
  Unique identifier of the goal plan document type.
• GoalPlanId: integer (int64)
  Unique identifier of the goal plan.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the performance document type associated with the goal plan was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the performance document type associated with the goal plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the performance document type.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the performance document type associated with the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the performance document type associated with the goal plan was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the performance document type associated with the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalPlanDocumentTypeId":{
            "type":"integer",
            "description":"Unique identifier of the goal plan document type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "GoalPlanId":{
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the performance document type associated with the goal plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the performance document type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentTypeId":{
            "type":"integer",
            "description":"Unique identifier for the performance document type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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 : goalPlans-perfGoalEligibilityProfiles-item-response

Type: object

Show Source

• EligibilityProfileDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the eligibility profile associated with the goal plan.
• EligibilityProfileId: integer (int64)
  Title: Eligibility Profile

  Unique identifier for the eligibility profile.
• EligibilityProfileName: string
  Read Only: true

  Maximum Length: 255

  Name of the eligibility profile associated with the goal plan.
• EligibilityProfileObjectId: integer (int64)
  Unique identifier for the eligibility profile in the associated goal plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 1

  Indicates if the eligibility profile is required or not.
• TalentObjectType: string
  Maximum Length: 30

  Type of talent object associated with the eligibility profile. For Goal Management, the talent object type is goal plan.

{
    "type":"object",
    "properties":{
        "TalentObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of talent object associated with the eligibility profile. For Goal Management, the talent object type is goal plan.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EligibilityProfileDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the eligibility profile associated with the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EligibilityProfileName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the eligibility profile associated with the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the eligibility profile is required or not.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EligibilityProfileObjectId":{
            "type":"integer",
            "description":"Unique identifier for the eligibility profile in the associated goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "EligibilityProfileId":{
            "title":"Eligibility Profile",
            "type":"integer",
            "description":"Unique identifier for the eligibility profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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 : goalPlans-perfGoalExcludedWorkers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Unique identifier for the assignment of the worker excluded from the goal plan.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the excluded worker's assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the excluded worker.
• AssignmentStatusType: string
  Title: Assignment Status

  Read Only: true

  Maximum Length: 30

  Status type for the assignment of the excluded worker.
• BusinessTitle: string
  Title: Job

  Read Only: true

  Maximum Length: 255

  Business title of the excluded worker.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who excluded the worker from the goal plan assignment.
• CreationDate: string (date-time)
  Read Only: true

  Date the worker was excluded from the goal plan assignment.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 255

  Name of the excluded worker's department.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the worker who's excluded from the goal plan assignment.
• LastUpdateDate: string (date-time)
  Read Only: true

  Global user ID of the excluded worker.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date the details of the worker excluded from the goal plan was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerName: string
  Title: Manager Name

  Read Only: true

  Maximum Length: 255

  Name of the person who last updated the details of the worker who's excluded from the goal plan assignment.
• MassRequestExemptionId: integer (int64)
  Name of the excluded worker's manager.
• MassRequestHierarchyId: integer (int64)
  Read Only: true

  Default Value: -1

  Type of manager that excluded the worker.
• PersonId: integer (int64)
  Title: Person

  Unique identifier for the mass request hierarchy.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Unique identifier for the mass goal plan assignment.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 255

  Unique identifier for the excluded worker.
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date the details of the worker excluded from the goal plan was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the mass goal plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MassRequestExemptionId":{
            "type":"integer",
            "description":"Name of the excluded worker's manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the worker was excluded from the goal plan assignment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the person who excluded the worker from the goal plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position",
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the excluded worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MassRequestHierarchyId":{
            "type":"integer",
            "description":"Type of manager that excluded the worker.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person who last updated the details of the worker who's excluded from the goal plan assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentStatusType":{
            "title":"Assignment Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status type for the assignment of the excluded worker.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the excluded worker's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessTitle":{
            "title":"Job",
            "maxLength":"255",
            "type":"string",
            "description":"Business title of the excluded worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the worker who's excluded from the goal plan assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment number of the excluded worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker excluded from the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the excluded worker's department.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Global user ID of the excluded worker.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

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 : goalPlans-perfGoalIncludedWorkers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Manager Assignment

  Unique identifier for the assignment of the worker included in the goal plan.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the assignment of the worker included in the goal plan.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the worker included in the goal plan.
• AssignmentStatusType: string
  Title: Assignment Status

  Read Only: true

  Maximum Length: 30

  Assignment status type of the worker included in the goal plan.
• BusinessTitle: string
  Title: Job

  Read Only: true

  Maximum Length: 255

  Business title of the worker included in the goal plan.
• CascadingLevel: integer (int64)
  Title: Assignees

  A code that determines which employees reporting to the requester will be assigned the performance goals in the goal plan. The performance goals can be assigned only to the requester, all direct reports of the requester, requester and their direct reports, all persons reporting to the requester, and requester and all persons reporting to the requester.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the worker to the goal plan.
• CreationDate: string (date-time)
  Read Only: true

  Date the worker was included in the goal plan.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 255

  Name of the department that the included worker belongs to.
• DirectsCount: integer
  Read Only: true

  Count of direct reports of a manager.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the included worker.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the details of the worker included in the goal plan was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the details of the worker included in the goal plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerName: string
  Title: Manager Name

  Read Only: true

  Maximum Length: 255

  Name of the manager of the included worker.
• MassRequestHierarchyId: integer (int64)
  Title: Mass Request Hierarchy ID

  Unique identifier for the mass request hierarchy.
• PersonId: integer (int64)
  Title: Person

  Unique identifier of the worker included in the goal plan.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the worker included in the goal plan.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 255

  Name of the position of the worker included in the goal plan.
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the details of the worker included in the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the worker included in the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the worker was included in the goal plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who added the worker to the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the position of the worker included in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MassRequestHierarchyId":{
            "title":"Mass Request Hierarchy ID",
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the manager of the included worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentStatusType":{
            "title":"Assignment Status",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment status type of the worker included in the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier of the worker included in the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the assignment of the worker included in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessTitle":{
            "title":"Job",
            "maxLength":"255",
            "type":"string",
            "description":"Business title of the worker included in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the included worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment number of the worker included in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Manager Assignment",
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker included in the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the department that the included worker belongs to.",
            "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"
            }
        },
        "CascadingLevel":{
            "title":"Assignees",
            "type":"integer",
            "description":"A code that determines which employees reporting to the requester will be assigned the performance goals in the goal plan. The performance goals can be assigned only to the requester, all direct reports of the requester, requester and their direct reports, all persons reporting to the requester, and requester and all persons reporting to the requester.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the details of the worker included in the goal plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DirectsCount":{
            "type":"integer",
            "description":"Count of direct reports of a manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : 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

  Long description of the performance goal.
• 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.
• 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.
• 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":"Long description of the performance goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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"
    }
}

Links

associatedPerfDocumentTypes

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes

Parameters:

• GoalPlanId: $request.path.GoalPlanId

The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.

perfGoalEligibilityProfiles

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles

Parameters:

• GoalPlanId: $request.path.GoalPlanId

The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.

perfGoalExcludedWorkers

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers

Parameters:

• GoalPlanId: $request.path.GoalPlanId

The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.

perfGoalIncludedWorkers

Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers

Parameters:

• GoalPlanId: $request.path.GoalPlanId

The perfGoalInccludedWorkers resource provides all workers included in a goal plan.

performanceGoals

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

Parameters:

• GoalPlanId: $request.path.GoalPlanId

The performanceGoalsV2 resource provides performance goals of workers.

Back to Top