Jump to

• Request
• Response

Ignore shared goal

post

/hcmRestApi/resources/11.13.18.05/exploreGoals/action/exploreGoalAction

Ignores the shared performance or development goal of the employee.

Request

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

• actionContext: string
  Identifies the action context for the goal that can be explored. Valid action context is HIDE_SHARED_GOAL.
• exploreGoalId: number
  Unique identifier for the goal that can be explored.
• flowContext: string
  Identifies the person flow context. Valid values are WORKER, MANAGER, and HR.
• goalType: string
  Identifies the type of goal that can be explored. The goal type can be Performance or Development.
• inputParams: object inputParams
  Additional Properties Allowed: additionalProperties

  Additional input parameters required for actions related to goals that can be explored.
• pAssignmentId: number
  Unique identifier for the assignment of the employee who has to explore goals.
• pPersonId: number
  Unique person identifier of the employee who has to explore goals.

{
    "type":"object",
    "properties":{
        "goalType":{
            "type":"string",
            "description":"Identifies the type of goal that can be explored. The goal type can be Performance or Development.",
            "nullable":true
        },
        "flowContext":{
            "type":"string",
            "description":"Identifies the person flow context. Valid values are WORKER, MANAGER, and HR.",
            "nullable":true
        },
        "pPersonId":{
            "type":"number",
            "description":"Unique person identifier of the employee who has to explore goals.",
            "nullable":true
        },
        "inputParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Additional input parameters required for actions related to goals that can be explored.",
            "nullable":true
        },
        "pAssignmentId":{
            "type":"number",
            "description":"Unique identifier for the assignment of the employee who has to explore goals.",
            "nullable":true
        },
        "exploreGoalId":{
            "type":"number",
            "description":"Unique identifier for the goal that can be explored.",
            "nullable":true
        },
        "actionContext":{
            "type":"string",
            "description":"Identifies the action context for the goal that can be explored. Valid action context is HIDE_SHARED_GOAL.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : inputParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Additional input parameters required for actions related to goals that can be explored.",
    "nullable":true
}

Additional input parameters required for actions related to goals that can be explored.

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

  The identifier for the goal to explore and the value of the ViewSharedGoalFlag attribute that indicates if that goal has been ignored. If the value of the ViewSharedGoalFlag attribute is Y, then the goal to explore can be viewed, and if it's N, then the goal to explore is ignored.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"The identifier for the goal to explore and the value of the ViewSharedGoalFlag attribute that indicates if that goal has been ignored. If the value of the ViewSharedGoalFlag attribute is Y, then the goal to explore can be viewed, and if it's N, then the goal to explore is ignored."
        }
    },
    "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":"The identifier for the goal to explore and the value of the ViewSharedGoalFlag attribute that indicates if that goal has been ignored. If the value of the ViewSharedGoalFlag attribute is Y, then the goal to explore can be viewed, and if it's N, then the goal to explore is ignored."
}

The identifier for the goal to explore and the value of the ViewSharedGoalFlag attribute that indicates if that goal has been ignored. If the value of the ViewSharedGoalFlag attribute is Y, then the goal to explore can be viewed, and if it's N, then the goal to explore is ignored.

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