Jump to

• Request
• Response

Find benefit group from a search query

post

/hcmRestApi/resources/11.13.18.05/benefitGroups/action/findByAdvancedSearchQuery

Finds all benefit group based on benefit group name, description, or legal employer from a search query.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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
  Query that's passed as a string in that custom search.
• displayFields: array displayFields
  Fields to be displayed in the search result.
• filters: array filters
  Facet filters for the benefit group search.
• limit: number
  Limits the return data after the custom search is executed.
• offset: number
  Offset point for the custom search query.
• query: string
  Query that's passed as a string in that custom search.
• searchFields: array searchFields
  Search field in the search query.
• sort: array sort
  Sort order for the benefit group search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset point for the custom search query.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query that's passed as a string in that custom search.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limits the return data after the custom search is executed.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search field in the search query.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the benefit group search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the benefit group search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Fields to be displayed in the search result.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Query that's passed as a string in that custom search.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Fields to be displayed in the search result.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields to be displayed in the search result.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the benefit group search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

Nested Schema : searchFields

Type: array

Search field in the search query.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search field in the search query.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the benefit group search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the benefit group search results.",
    "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

  Returns list of benefit groups.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Returns list of benefit groups."
        }
    },
    "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":"Returns list of benefit groups."
}

Returns list of benefit groups.

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