Jump to

• Request
• Response

Fetch goal plan and review period details for an employee

post

/hcmRestApi/resources/11.13.18.05/goalsProgressDetails/action/getRPAndGPDetails

Retrieves the goal plan and review period details for the employee based on the values provided.

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

• contextMode: string
  Context for retrieving goal plan and review period details.
• payload: object payload
  Additional Properties Allowed: additionalProperties

  Includes information that identify the employee and the goal plan that need to be retrieved.

{
    "type":"object",
    "properties":{
        "payload":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Includes information that identify the employee and the goal plan that need to be retrieved.",
            "nullable":true
        },
        "contextMode":{
            "type":"string",
            "description":"Context for retrieving goal plan and review period details.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : payload

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Includes information that identify the employee and the goal plan that need to be retrieved.",
    "nullable":true
}

Includes information that identify the employee and the goal plan that need to be retrieved.

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

  Goal plan details and review period information.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Goal plan details and review period information."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Goal plan details and review period information."
}

Goal plan details and review period information.

Back to Top