Jump to

• Request
• Response

Find the time events that match the search criteria

post

/hcmRestApi/resources/11.13.18.05/timeEvents/action/findByAdvancedSearchQuery

Finds the time events and related attribute values that match the advanced 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
  The autocomplete query that applies to the time event data search.
• displayFields: array displayFields
  Time event search result fields, such as time event details or time event status.
• filters: array filters
  Criteria used to filter time events, such as the time event start or end date, or the group name.
• limit: number
  Limit applied to the number of time event records retrieved using the search criteria.
• offset: number
  Number of time event records retrieved using the search criteria.
• query: string
  Keyword value, such as the time event start date or stop date.
• searchFields: array searchFields
  Search criteria from the keyword field, such as time event status or time period.
• sort: array sort
  Sort order applied to the time event search results. The default sort is based on the time event start date, descending order.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Number of time event records retrieved using the search criteria.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword value, such as the time event start date or stop date.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit applied to the number of time event records retrieved using the search criteria.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search criteria from the keyword field, such as time event status or time period.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Criteria used to filter time events, such as the time event start or end date, or the group name.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order applied to the time event search results. The default sort is based on the time event start date, descending order.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Time event search result fields, such as time event details or time event status.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"The autocomplete query that applies to the time event data search.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Time event search result fields, such as time event details or time event status.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Time event search result fields, such as time event details or time event status.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Criteria used to filter time events, such as the time event start or end date, or the group name.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Criteria used to filter time events, such as the time event start or end date, or the group name.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search criteria from the keyword field, such as time event status or time period.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search criteria from the keyword field, such as time event status or time period.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order applied to the time event search results. The default sort is based on the time event start date, descending order.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order applied to the time event search results. The default sort is based on the time event start date, descending order.",
    "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

  Search results for the specified time event search criteria.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Search results for the specified time event search criteria."
        }
    },
    "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 the specified time event search criteria."
}

Search results for the specified time event search criteria.

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