Jump to

• Request
• Response

Find the attendance violations that match the search criteria

post

/hcmRestApi/resources/11.13.18.05/attendanceViolations/action/findByAdvancedSearchQuery

Finds the attendance violations 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 attendance violation data search.
• displayFields: array displayFields
  Attendance violation search result fields, such as the attendance violation date or rule.
• filters: array filters
  Criteria used to filter attendance violations, such as the attendance violation date or the person.
• limit: number
  Limit applied to the number of attendance violation records retrieved using the search criteria.
• offset: number
  Number of attendance violation records retrieved using the search criteria.
• query: string
  Keyword value, such as the attendance violation date or rule.
• searchFields: array searchFields
  Search criteria from the keyword field, such as attendance violation date or rule.
• sort: array sort
  Sort order applied to the attendance violation search results. The default sort is based on the attendance violation date, descending order.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Number of attendance violation records retrieved using the search criteria.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword value, such as the attendance violation date or rule.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit applied to the number of attendance violation records retrieved using the search criteria.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search criteria from the keyword field, such as attendance violation date or rule.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Criteria used to filter attendance violations, such as the attendance violation date or the person.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order applied to the attendance violation search results. The default sort is based on the attendance violation date, descending order.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Attendance violation search result fields, such as the attendance violation date or rule.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"The autocomplete query that applies to the attendance violation data search.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Attendance violation search result fields, such as the attendance violation date or rule.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attendance violation search result fields, such as the attendance violation date or rule.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Criteria used to filter attendance violations, such as the attendance violation date or the person.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Criteria used to filter attendance violations, such as the attendance violation date or the person.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search criteria from the keyword field, such as attendance violation date or rule.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search criteria from the keyword field, such as attendance violation date or rule.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order applied to the attendance violation search results. The default sort is based on the attendance violation date, descending order.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order applied to the attendance violation search results. The default sort is based on the attendance violation 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 attendance violation 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 attendance violation 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 attendance violation search criteria."
}

Search results for the specified attendance violation 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