REST API for Oracle Fusion Cloud HCM

Find a goal to explore

post

/hcmRestApi/resources/11.13.18.05/exploreGoals/action/findByAdvancedSearchQuery

Finds a performance or development goal with the specified goal name 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

Root Schema : schema

Type: object

Show Source

assignmentId: string

Unique identifier for the assignment of the employee whose available library and shared development goals need to be found.
autocompleteQuery: string

Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.
context: string

Identifies the search view context. Valid values are SHARED and LIBRARY. If no context is passed, then both shared and library goals are included in the search result.
displayFields: array displayFields

Display fields to include in the response of the find goals that can be explored search query. The display fields can include fields such as the goal name, description, start date, target completion date, goal type, and the name of the person who has shared the goal.
filters: array filters

Facet filters for the find goals that can be explored search. These filter attributes depend on the view context. If the view context is Library, then the facet filters are business unit, department, job family, goal type, category, and subtype. If the view context is Shared, then the main facet filter is the goal type. For performance goals, the review period can also be used as a facet filter.
flowContext: string

Identifies the role context for finding goals to explore, which can be worker, manager, or HR specialist.
limit: number

Restriction for the number of goals for exploring that's returned. If the limit exceeds the resource count, then the framework returns only the available 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.
personId: string

Unique person identifier of the employee who has to explore goals.
query: string

Defines the where clause for the search. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.
searchFields: array searchFields

Search fields for the find goals that can be explored keyword query. The search field can be the goal name or the owner name.
sort: array sort

Sort criteria for the find goals that can be explored search, which is the goal name.

{
    "type":"object",
    "properties":{
        "flowContext":{
            "type":"string",
            "description":"Identifies the role context for finding goals to explore, which can be worker, manager, or HR specialist.",
            "nullable":true
        },
        "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
        },
        "query":{
            "type":"string",
            "description":"Defines the where clause for the search. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Restriction for the number of goals for exploring that's returned. If the limit exceeds the resource count, then the framework returns only the available goals for exploring.",
            "nullable":true
        },
        "context":{
            "type":"string",
            "description":"Identifies the search view context. Valid values are SHARED and LIBRARY. If no context is passed, then both shared and library goals are included in the search result.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the find goals that can be explored keyword query. The search field can be the goal name or the owner name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "personId":{
            "type":"string",
            "description":"Unique person identifier of the employee who has to explore goals.",
            "nullable":true
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the find goals that can be explored search. These filter attributes depend on the view context. If the view context is Library, then the facet filters are business unit, department, job family, goal type, category, and subtype. If the view context is Shared, then the main facet filter is the goal type. For performance goals, the review period can also be used as a facet filter.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the find goals that can be explored search, which is the goal name.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields to include in the response of the find goals that can be explored search query. The display fields can include fields such as the goal name, description, start date, target completion date, goal type, and the name of the person who has shared the goal.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "assignmentId":{
            "type":"string",
            "description":"Unique identifier for the assignment of the employee whose available library and shared development goals need to be found.",
            "nullable":true
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields to include in the response of the find goals that can be explored search query. The display fields can include fields such as the goal name, description, start date, target completion date, goal type, and the name of the person who has shared the goal.

Show Source

Array of: string

{
    "type":"array",
    "description":"Display fields to include in the response of the find goals that can be explored search query. The display fields can include fields such as the goal name, description, start date, target completion date, goal type, and the name of the person who has shared the goal.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the find goals that can be explored search. These filter attributes depend on the view context. If the view context is Library, then the facet filters are business unit, department, job family, goal type, category, and subtype. If the view context is Shared, then the main facet filter is the goal type. For performance goals, the review period can also be used as a facet filter.

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the find goals that can be explored search. These filter attributes depend on the view context. If the view context is Library, then the facet filters are business unit, department, job family, goal type, category, and subtype. If the view context is Shared, then the main facet filter is the goal type. For performance goals, the review period can also be used as a facet filter.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the find goals that can be explored keyword query. The search field can be the goal name or the owner name.

Show Source

Array of: string

{
    "type":"array",
    "description":"Search fields for the find goals that can be explored keyword query. The search field can be the goal name or the owner name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort criteria for the find goals that can be explored search, which is the goal name.

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort criteria for the find goals that can be explored search, which is the goal name.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json
application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Root Schema : schema

Type: object

Show Source

result(required): object result

Additional Properties Allowed: additionalProperties

Goals that the employee can explore.

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

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"
    }
}