Jump to

• Request
• Response

Add weight for a goal

post

/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionType: string
  Maximum Length: 80

  Indicates the type of the process, which can be mass assignment or mass sharing of performance goals.
• AssignmentId: integer (int64)
  Unique identifier for the job assignment of a worker.
• GoalGPGId: integer (int64)
  Unique identifier for a 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.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  Priority code of the performance goal.
• ReviewPeriodId: integer (int64)
  Unique Identifier for the review period that the goal plan of the performance goal is associated with.
• TargetGoalPlanId: integer
  Unique identifier of the goal plan.
• TargetReviewPeriod: integer
  Unique Identifier for the review period that the goal plan of the performance goal is associated with.
• Weighting: number
  Title: Weight

  Weight of the performance goal.

{
    "type":"object",
    "properties":{
        "Weighting":{
            "title":"Weight",
            "type":"number",
            "description":"Weight of the performance goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"5",
                "scale":"2"
            }
        },
        "TargetReviewPeriod":{
            "type":"integer",
            "description":"Unique Identifier for the review period that the goal plan of the performance goal is associated with.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionType":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the type of the process, which can be mass assignment or mass sharing of performance goals.",
            "nullable":true,
            "x-queryable":false
        },
        "GoalGPGId":{
            "type":"integer",
            "description":"Unique identifier for a performance goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "GoalPlanId":{
            "title":"Goal Plan Name",
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"Priority code of the performance goal.",
            "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":{
                "precision":"18"
            }
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the job assignment of a worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GoalPlanGoalId":{
            "type":"integer",
            "description":"Unique identifier for the performance goal in the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "TargetGoalPlanId":{
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• ActionType: string
  Maximum Length: 80

  Indicates the type of the process, which can be mass assignment or mass sharing of performance goals.
• AssignmentId: integer (int64)
  Unique identifier for the job assignment of a worker.
• GoalApprovalState: string
  Read Only: true

  Maximum Length: 30

  Indicates if the performance goal is approved or not.
• GoalGPGId: integer (int64)
  Unique identifier for a performance goal.
• GoalId: integer (int64)
  Title: Goal ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 400

  Name of the performance goal.
• GoalPlanAssignmentId: integer (int64)
  Read Only: true

  Unique identifier for the goal plan assignment.
• 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.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Priority code of the performance goal.
• ReviewPeriodId: integer (int64)
  Unique Identifier for the review period that the goal plan of the performance goal is associated with.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: NOT_STARTED

  Status code of the performance goal.
• TargetGoalPlanId: integer
  Unique identifier of the goal plan.
• TargetReviewPeriod: integer
  Unique Identifier for the review period that the goal plan of the performance goal is associated with.
• Weighting: number
  Title: Weight

  Weight of the performance goal.

{
    "type":"object",
    "properties":{
        "TargetReviewPeriod":{
            "type":"integer",
            "description":"Unique Identifier for the review period that the goal plan of the performance goal is associated with.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionType":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the type of the process, which can be mass assignment or mass sharing of performance goals.",
            "nullable":true,
            "x-queryable":false
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"Priority code of the performance goal.",
            "nullable":true,
            "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
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status code of the performance goal.",
            "nullable":false,
            "readOnly":true,
            "default":"NOT_STARTED",
            "x-queryable":true
        },
        "GoalApprovalState":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the performance goal is approved or not.",
            "nullable":true,
            "readOnly":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
        },
        "GoalGPGId":{
            "type":"integer",
            "description":"Unique identifier for a performance goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "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
        },
        "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":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the job assignment of a worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":"400",
            "type":"string",
            "description":"Name of the performance goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalPlanAssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the goal plan assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TargetGoalPlanId":{
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "nullable":true,
            "x-queryable":false
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Unique identifier for a performance goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "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."
        }
    }
}

Back to Top