REST API for Oracle Fusion Cloud HCM

Find the organizational calendar that matches the specified criteria.

post

/hcmRestApi/resources/11.13.18.05/absenceCalendars/action/findByAdvancedSearch

Finds the organizational calendars that matches the specified criteria, such as name or description.

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

Root Schema : schema

Type: object

Show Source

autocompleteQuery: string

Indicates whether the keyword search for organizational calendars is completed automatically. Valid values are Y and N. The default value is Y.
displayFields: array displayFields

Display fields for the organizational calendar search results, such as Name, Category, and Status.
filters: array filters

Facet filters for the organizational calendar search.
limit: number

Size limit for fetching organizational calendars results. The default value is 25.
offset: number

Start range for the organizational calendars search.
query: string

Keyword search for organizational calendars.
searchFields: array searchFields

Search fields for the organizational calendar keyword search, such as Name, Category, and Status.
sort: array sort

Sort order for the organizational calendar search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Start range for the organizational calendars search.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword search for organizational calendars.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Size limit for fetching organizational calendars results. The default value is 25.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the organizational calendar keyword search, such as Name, Category, and Status.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the organizational calendar search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the organizational calendar search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the organizational calendar search results, such as Name, Category, and Status.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the keyword search for organizational calendars is completed automatically. Valid values are Y and N. The default value is Y.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the organizational calendar search results, such as Name, Category, and Status.

Show Source

Array of: string

{
    "type":"array",
    "description":"Display fields for the organizational calendar search results, such as Name, Category, and Status.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the organizational calendar search.

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

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

Nested Schema : searchFields

Type: array

Search fields for the organizational calendar keyword search, such as Name, Category, and Status.

Show Source

Array of: string

{
    "type":"array",
    "description":"Search fields for the organizational calendar keyword search, such as Name, Category, and Status.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the organizational calendar search results.

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

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

Response

Supported Media Types

application/json
application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Root Schema : schema

Type: object

Show Source

result(required): object result

Additional Properties Allowed: additionalProperties

Search results for an organizational calendar query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Search results for an organizational calendar 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 results for an organizational calendar query."
}

Search results for an organizational calendar 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"
    }
}