Jump to

• Request
• Response

Find the learning audience lists.

post

/hcmRestApi/resources/11.13.18.05/learningCriteriaLists/action/findByAdvancedSearchQuery

Finds learning criteria lists that match the specified advanced search criteria.

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
  Indicates whether the query is completed automatically for the specified learning audience criteria. Valid values are Y and N.
• displayFields: array displayFields
  Fields to display in the learning audience search response.
• filters: array filters
  Facet filters used to narrow the learning audience search.
• finders: array finders
  Named finder definitions used as facets for the learning audience search.
• limit: number
  Limit how many learning audience lists are returned.
• offset: number
  Position of the learning audience list in the dataset starting from where the limit of lists will be returned in the search results.
• query: string
  Keyword used to filter the learning audience list search results.
• searchFields: array searchFields
  Search fields used for the learning audience keyword query.
• sort: array sort
  Sort order for the learning audience search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Position of the learning audience list in the dataset starting from where the limit of lists will be returned in the search results.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword used to filter the learning audience list search results.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit how many learning audience lists are returned.",
            "nullable":true
        },
        "finders":{
            "type":"array",
            "description":"Named finder definitions used as facets for the learning audience search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields used for the learning audience keyword query.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters used to narrow the learning audience search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the learning audience search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Fields to display in the learning audience search response.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is completed automatically for the specified learning audience criteria. Valid values are Y and N.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Fields to display in the learning audience search response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields to display in the learning audience search response.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters used to narrow the learning audience search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters used to narrow the learning audience search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : finders

Type: array

Named finder definitions used as facets for the learning audience search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Named finder definitions used as facets for the learning audience search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields used for the learning audience keyword query.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields used for the learning audience keyword query.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the learning audience search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the learning audience 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"
    }
}

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

  Search response returned for the learning audience query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Search response returned for the learning audience 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":"Search response returned for the learning audience query."
}

Search response returned for the learning audience 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