Jump to

• Request
• Response

Find development goals

post

/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/findByAdvancedSearchQuery

Finds development goals that match the specified criteria.

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 completed automatically. Valid values are Y and N. The default value is Y.
• displayFields: array displayFields
  Attributes included in the response of the search development goals query.
• filters: array filters
  Facet filters for the development goals search.
• limit: number
  Restricts the number of resources returned inside the resource collection.
• offset: number
  Starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• query: string
  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.
• searchFields: array searchFields
  Search fields for the search development goals query. The search fields can be attributes such as the name of the development goal, the goal name, and the Person ID.
• sort: array sort
  Sort criteria for the results of the search development goals query. The results can be sorted by attributes such as the goal name, or the last modified date.

{
    "type":"object",
    "properties":{
        "offset":{
            "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
        },
        "query":{
            "type":"string",
            "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
        },
        "limit":{
            "type":"number",
            "description":"Restricts the number of resources returned inside the resource collection.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the search development goals query. The search fields can be attributes such as the name of the development goal, the goal name, and the Person ID.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the development goals search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the results of the search development goals query. The results can be sorted by attributes such as the goal name, or the last modified date.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Attributes included in the response of the search development goals query.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is completed automatically. Valid values are Y and N. The default value is Y.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Attributes included in the response of the search development goals query.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attributes included in the response of the search development goals query.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the development goals search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the development goals search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

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

Show Source

• Array of: string

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

Nested Schema : sort

Type: array

Sort criteria for the results of the search development goals query. The results can be sorted by attributes such as the goal name, or the last modified date.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

  Development goals returned by the search performance goals query.

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

Development goals returned by the search performance 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