Jump to

• Request
• Response

Find performance or development goals

post

/hcmRestApi/resources/11.13.18.05/searchGoals/action/findByAdvancedSearchQuery

Finds performance or development goals that match the specified criteria.

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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
  Search fields for the search performance goals query. The search fields can be attributes such as the name of the performance goal, the goal plan name, and the manager ID.
• displayFields: array displayFields
  Attributes included in the response of the search performance or development goals query. These can be goal name, worker name, job name, goal start date, and target completion date of the goal.
• filters: array filters
  Facet filters for the performance or development goals search. These can include the review period name, worker ID, manager ID, and business unit ID.
• limit: number
  Starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• offset: number
  Query parameter defines the where clause. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.
• query: string
  Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.
• searchFields: array searchFields
  Search fields for the search performance or development goals query. The search fields can be attributes such as the name of the goal, the goal plan name, and the manager ID.
• sort: array sort
  Sort criteria for the results of the search performance or development goals query. The results can be sorted by attributes such as the review period name, goal name, or the goal plan name.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Query parameter defines the where clause. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the search performance or development goals query. The search fields can be attributes such as the name of the goal, the goal plan name, and the manager ID.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the performance or development goals search. These can include the review period name, worker ID, manager ID, and business unit ID.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the results of the search performance or development goals query. The results can be sorted by attributes such as the review period name, goal name, or the goal plan name.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Attributes included in the response of the search performance or development goals query. These can be goal name, worker name, job name, goal start date, and target completion date of the goal.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Search fields for the search performance goals query. The search fields can be attributes such as the name of the performance goal, the goal plan name, and the manager ID.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Attributes included in the response of the search performance or development goals query. These can be goal name, worker name, job name, goal start date, and target completion date of the goal.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attributes included in the response of the search performance or development goals query. These can be goal name, worker name, job name, goal start date, and target completion date of the goal.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the performance or development goals search. These can include the review period name, worker ID, manager ID, and business unit ID.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the performance or development goals search. These can include the review period name, worker ID, manager ID, and business unit ID.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the search performance or development goals query. The search fields can be attributes such as the name of the goal, the goal plan name, and the manager ID.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the search performance or development goals query. The search fields can be attributes such as the name of the goal, the goal plan name, and the manager ID.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort criteria for the results of the search performance or development goals query. The results can be sorted by attributes such as the review period name, goal name, or the goal plan name.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort criteria for the results of the search performance or development goals query. The results can be sorted by attributes such as the review period name, goal name, or 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

  Performance or development goals returned by the search performance or development goals query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Performance or development goals returned by the search performance or development goals query."
        }
    },
    "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":"Performance or development goals returned by the search performance or development goals query."
}

Performance or development goals returned by the search performance or development goals query.

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