Jump to

• Request
• Response

Retrieve progress details

post

/hcmRestApi/resources/11.13.18.05/goalsProgressDetails/action/fetchGoalsProgressInfo

Retrieves the progress details for an employee's goal or the progress made on goals by all team members.

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 goals details.
• payload: object payload
  Additional Properties Allowed: additionalProperties

  Identifies the employee performance or development goal or team goals that need to be retrieved.

{
    "type":"object",
    "properties":{
        "payload":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Identifies the employee performance or development goal or team goals that need to be retrieved.",
            "nullable":true
        },
        "contextMode":{
            "type":"string",
            "description":"Context for retrieving goals details.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : payload

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Identifies the employee performance or development goal or team goals that need to be retrieved.",
    "nullable":true
}

Identifies the employee performance or development goal or team goals 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

  All details about the performance or development goal of the employee or the team's goals.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"All details about the performance or development goal of the employee or the team's goals."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"All details about the performance or development goal of the employee or the team's goals."
}

All details about the performance or development goal of the employee or the team's goals.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "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