Jump to

• Request
• Response

Find a performance goal to explore

post

/hcmRestApi/resources/11.13.18.05/exploreGoals/action/getPerfSharedAndLibraryGoals

Finds library or shared performance goals that the employee can explore.

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

• limit: number
  Restriction for the number of performance goals for exploring that's returned. If the limit exceeds the resource count, then the framework returns only the available performance goals for exploring.
• offset: number
  Defines the starting position of the resource collection. If the offset exceeds the resource count, then no resources are returned. Default value is 0.
• pAssignmentId: number
  Unique identifier for the assignment of the employee whose available library and shared performance goals need to be found.
• pParentFlow: string
  Identifies the role context for finding performance goals that the employee can explore. The role context can be worker, manager, or HR specialist.
• pPersonId: number
  Unique person identifier of the employee whose available library and shared performance goals need to be found.
• pReviewPeriodId: number
  Unique identifier for the review period for which the performance goals that the employee can explore need to be found.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Defines the starting position of the resource collection. If the offset exceeds the resource count, then no resources are returned. Default value is 0.",
            "nullable":true
        },
        "pPersonId":{
            "type":"number",
            "description":"Unique person identifier of the employee whose available library and shared performance goals need to be found.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Restriction for the number of performance goals for exploring that's returned. If the limit exceeds the resource count, then the framework returns only the available performance goals for exploring.",
            "nullable":true
        },
        "pAssignmentId":{
            "type":"number",
            "description":"Unique identifier for the assignment of the employee whose available library and shared performance goals need to be found.",
            "nullable":true
        },
        "pParentFlow":{
            "type":"string",
            "description":"Identifies the role context for finding performance goals that the employee can explore. The role context can be worker, manager, or HR specialist.",
            "nullable":true
        },
        "pReviewPeriodId":{
            "type":"number",
            "description":"Unique identifier for the review period for which the performance goals that the employee can explore need to be found.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Library or shared performance goals that the employee can explore.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Library or shared performance goals that the employee can explore."
        }
    },
    "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":"Library or shared performance goals that the employee can explore."
}

Library or shared performance goals that the employee can explore.

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