Jump to

• Request
• Response

Import performance goals

post

/hcmRestApi/resources/11.13.18.05/goalPlans/action/importGoals

Imports performance goals from a mass assignment request and creates a new mass assignment request.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• goalPlanId: number
  Unique identifier for the goal plan associated with the target mass assignment request.
• inputPayload: object inputPayload
  Additional Properties Allowed: additionalProperties

  Details of the performance goals that needs to be imported. It includes attributes such as the goal name and goal description.
• massRequestId: number
  Unique identifier for the source mass assignment request.
• reviewPeriodId: number
  Unique identifier for the review period associated with the target mass assignment request.
• targetMassRequestId: number
  Unique identifier for the target mass assignment request.

{
    "type":"object",
    "properties":{
        "reviewPeriodId":{
            "type":"number",
            "description":"Unique identifier for the review period associated with the target mass assignment request.",
            "nullable":true
        },
        "inputPayload":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Details of the performance goals that needs to be imported. It includes attributes such as the goal name and goal description.",
            "nullable":true
        },
        "massRequestId":{
            "type":"number",
            "description":"Unique identifier for the source mass assignment request.",
            "nullable":true
        },
        "targetMassRequestId":{
            "type":"number",
            "description":"Unique identifier for the target mass assignment request.",
            "nullable":true
        },
        "goalPlanId":{
            "type":"number",
            "description":"Unique identifier for the goal plan associated with the target mass assignment request.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : inputPayload

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Details of the performance goals that needs to be imported. It includes attributes such as the goal name and goal description.",
    "nullable":true
}

Details of the performance goals that needs to be imported. It includes attributes such as the goal name and goal description.

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 mass assignment request that has the performance goals included in the source mass assignment request.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"New mass assignment request that has the performance goals included in the source mass assignment request."
        }
    },
    "additionalProperties":false
}

Back to Top