Jump to

• Request
• Response

Find library goals by advance search

post

/hcmRestApi/resources/11.13.18.05/libraryGoals/action/findByAdvancedSearchQuery

Finds library goals by using advance search query 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 auto completed. Valid values are Y and N. The default value is Y.
• displayFields: array displayFields
  Attributes of the library goal that are displayed in the results of the library goal search. The display attributes for library goals are the goal name, category, status, goal visibility, and last update date.
• filters: array filters
  Attributes by which the results of the library goal search can be filtered. The filter attributes for library goals are the goal name, status, goal visibility, legal employer, business unit, department, and job family.
• limit: number
  Restriction for the number of goals returned. If the limit exceeds the resource count, then the framework returns only the available goals.
• 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
  Attribute for searching the library goals, which is the goal name.
• sort: array sort
  Attributes by which the results of the library goal search can be sorted. The sort attributes for library goals are the goal name and the last update 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":"Restriction for the number of goals returned. If the limit exceeds the resource count, then the framework returns only the available goals.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Attribute for searching the library goals, which is the goal name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Attributes by which the results of the library goal search can be filtered. The filter attributes for library goals are the goal name, status, goal visibility, legal employer, business unit, department, and job family.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Attributes by which the results of the library goal search can be sorted. The sort attributes for library goals are the goal name and the last update date.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Attributes of the library goal that are displayed in the results of the library goal search. The display attributes for library goals are the goal name, category, status, goal visibility, and last update date.",
            "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

Attributes of the library goal that are displayed in the results of the library goal search. The display attributes for library goals are the goal name, category, status, goal visibility, and last update date.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attributes of the library goal that are displayed in the results of the library goal search. The display attributes for library goals are the goal name, category, status, goal visibility, and last update date.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Attributes by which the results of the library goal search can be filtered. The filter attributes for library goals are the goal name, status, goal visibility, legal employer, business unit, department, and job family.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Attributes by which the results of the library goal search can be filtered. The filter attributes for library goals are the goal name, status, goal visibility, legal employer, business unit, department, and job family.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Attribute for searching the library goals, which is the goal name.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attribute for searching the library goals, which is the goal name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Attributes by which the results of the library goal search can be sorted. The sort attributes for library goals are the goal name and the last update date.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Attributes by which the results of the library goal search can be sorted. The sort attributes for library goals are the goal name and the last update 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

  Library goals that match the criteria specified.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Library goals that match the criteria specified."
        }
    },
    "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 goals that match the criteria specified."
}

Library goals that match the criteria specified.

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