Jump to

• Request
• Response

Find a goal plan

post

/hcmRestApi/resources/11.13.18.05/goalPlans/action/findByAdvancedSearchQuery

Finds a goal plan that matches the specified goal plan name.

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

• autocompleteQuery: string
  Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.
• displayFields: array displayFields
  Display fields for the goal plan search response. The display fields can include fields such as the goal plan name, review period name, and last update date for the goal plan.
• filters: array filters
  Facet filters for the goal plan search. These filters can include attributes such as the goal plan name, status, and weight.
• limit: number
  Restriction for the number of goal plans returned. If the limit exceeds the resource count, then the framework returns only the available goal plans.
• 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.
• 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 a goal plan keyword query. The search field can be the goal plan name.
• sort: array sort
  Sort criteria for the goal plan search. The criteria can include the goal plan name.

{
    "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
        },
        "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 goal plans returned. If the limit exceeds the resource count, then the framework returns only the available goal plans.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the find a goal plan keyword query. The search field can be the goal plan name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the goal plan search. These filters can include attributes such as the goal plan name, status, and weight.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the goal plan search. The criteria can include the goal plan name.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the goal plan search response. The display fields can include fields such as the goal plan name, review period name, and last update date for the goal plan.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "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 for the goal plan search response. The display fields can include fields such as the goal plan name, review period name, and last update date for the goal plan.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the goal plan search response. The display fields can include fields such as the goal plan name, review period name, and last update date for the goal plan.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the goal plan search. These filters can include attributes such as the goal plan name, status, and weight.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the goal plan search. These filters can include attributes such as the goal plan name, status, and weight.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the find a goal plan keyword query. The search field can be the goal plan name.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the find a goal plan keyword query. The search field can be the goal plan name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort criteria for the goal plan search. The criteria can include the goal plan name.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort criteria for the goal plan search. The criteria can include the goal plan 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"
    }
}

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

  Response returned for the find a goal plan action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Response returned for the find a goal plan action."
        }
    },
    "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":"Response returned for the find a goal plan action."
}

Response returned for the find a goal plan action.

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