Jump to

• Request
• Response

Copy a goal

post

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

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

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

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

Root Schema : schema

Type: object

Show Source

• AssignmentId: number
  Performance Goals
• GoalName: string
  Name of the goal that's copied.
• GoalPlanGoalId: number
  Unique identifier for the goal that's copied in the goal plan.
• GoalPlanId: number
  Unique identifier for the goal plan that includes the copied goal.
• ReviewPeriodId: number
  Unique identifier for the job assignment of a worker.

{
    "type":"object",
    "properties":{
        "GoalPlanId":{
            "type":"number",
            "description":"Unique identifier for the goal plan that includes the copied goal.",
            "nullable":true
        },
        "ReviewPeriodId":{
            "type":"number",
            "description":"Unique identifier for the job assignment of a worker.",
            "nullable":true
        },
        "AssignmentId":{
            "type":"number",
            "description":"Performance Goals",
            "nullable":true
        },
        "GoalName":{
            "type":"string",
            "description":"Name of the goal that's copied.",
            "nullable":true
        },
        "GoalPlanGoalId":{
            "type":"number",
            "description":"Unique identifier for the goal that's copied in the goal plan.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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): string
  New goal that has the attributes of the copied goal.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"New goal that has the attributes of the copied goal."
        }
    },
    "additionalProperties":false
}

Back to Top