Jump to

• Request
• Response

Assign multiple performance goals

post

/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/goalAssignActionBatch

Assigns a performance goal to the selected employees.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• AllowKeyAttrFlag: string
  Indicates if goal assignees can update the key attributes of the assigned goal.
• GoalPlanId: number
  Unique identifier for the goal plan to which the performance goal needs to be assigned.
• Goals: array Goals
  Performance Goals
• GoalWeights: array GoalWeights
  List of weights of goals that need to be assigned.
• IndirectReports: string
  Indicates if indirect reports need to be included when assigning goals for the primary goal plan.
• InputPayloadRest: array InputPayloadRest
  List of employees who need to be assigned the performance goal.
• ReviewPeriodId: number
  Unique identifier for the review period.

{
    "type":"object",
    "properties":{
        "IndirectReports":{
            "type":"string",
            "description":"Indicates if indirect reports need to be included when assigning goals for the primary goal plan.",
            "nullable":true
        },
        "InputPayloadRest":{
            "type":"array",
            "description":"List of employees who need to be assigned the performance goal.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "GoalPlanId":{
            "type":"number",
            "description":"Unique identifier for the goal plan to which the performance goal needs to be assigned.",
            "nullable":true
        },
        "ReviewPeriodId":{
            "type":"number",
            "description":"Unique identifier for the review period.",
            "nullable":true
        },
        "AllowKeyAttrFlag":{
            "type":"string",
            "description":"Indicates if goal assignees can update the key attributes of the assigned goal.",
            "nullable":true
        },
        "GoalWeights":{
            "type":"array",
            "description":"List of weights of goals that need to be assigned.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "Goals":{
            "type":"array",
            "description":"Performance Goals",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : Goals

Type: array

Performance Goals

Show Source

• Array of: number

{
    "type":"array",
    "description":"Performance Goals",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : GoalWeights

Type: array

List of weights of goals that need to be assigned.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of weights of goals that need to be assigned.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : InputPayloadRest

Type: array

List of employees who need to be assigned the performance goal.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of employees who need to be assigned the performance goal.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Unique identifier for the request that was created for the goal assignment process.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Unique identifier for the request that was created for the goal assignment process."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Unique identifier for the request that was created for the goal assignment process."
}

Unique identifier for the request that was created for the goal assignment process.

Back to Top