Zoho: Audit log export schemas
23 Zoho schemas with complete fields and constraints.
← Audit log export operations · All schemas
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: between
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries audited within a time range. The range must not exceed 180 days. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: between |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: audited_time |
value | array | Required within parent | Start and end of the range, as exactly two ISO 8601 timestamps. Maximum items: 2 Minimum items: 2 |
value[] | string | Each item | An ISO 8601 timestamp. Format: date-time |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries performed by a single user. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: equal |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: done_by |
value | array | Required within parent | Exactly one user reference. Maximum items: 1 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries belonging to a single module. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: equal |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: module |
value | array | Required within parent | Exactly one module reference. Maximum items: 1 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Module Value |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal, value: added, updated, deleted
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries whose action equals a single value. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: equal |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: action |
value | string | Required within parent | Action to match. One of: added, updated, deleted |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User reference for the done_by filter. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the user. Maximum length: 64 |
name | string | Optional | Display name of the user. Maximum length: 256 |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Module Value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module reference. Supply api_name, id, or both. Additional keys: not allowed |
api_name | string | Optional | API name of the module. Maximum length: 128 |
id | string | Optional | Unique identifier of the module. Maximum length: 64 |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 2) | JSON | Alternative |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Action In Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries whose action is one of several values. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: in |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: action |
value | array | Required within parent | Actions to match. Maximum items: 3 Minimum items: 1 |
value[] | string | Each item | Action to match. One of: added, updated, deleted |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries performed by any of several users. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: in |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: done_by |
value | array | Required within parent | User references to match. Maximum items: 500 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value |
Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Module In Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries belonging to any of several modules. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. One of: in |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. One of: module |
value | array | Required within parent | Module references to match. Maximum items: 500 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Module Value |
Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A group of filter conditions combined with a logical operator. Additional keys: not allowed |
group | array | Required within parent | Conditions to combine. Maximum items: 2 Minimum items: 1 |
group[] | JSON | Each item | A condition within the group. |
group[] (anyOf 1) | Model | Alternative | Expand Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition |
group[] (anyOf 2) | Model | Alternative | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and |
group_operator | string | Required within parent | Logical operator applied between the grouped conditions. One of: and |
Referenced models: Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and, Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition
Create an audit log export job — request body — body audit log export item criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Filter criteria for an audit log export job. |
$ (anyOf 1) | Model | Alternative | Expand Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition |
$ (anyOf 2) | Model | Alternative | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and |
Referenced models: Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and, Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition
Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition
Referenced models: Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal, value: added, updated, deleted, Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Action In Criterion, Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: between, Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion, Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion, Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion, Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Module In Criterion
Get audit log export jobs — response body — audit log export audit log export item criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Filter criteria stored for this export job. Null when the job was created without criteria. |
$ (anyOf 1) | Model | Alternative | Expand Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job |
$ (anyOf 2) | null | Alternative | No criteria were stored for this export job. |
Referenced models: Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job
Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Filter criteria for an audit log export job. |
$ (anyOf 1) | Model | Alternative | Expand Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition |
$ (anyOf 2) | Model | Alternative | Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and |
Referenced models: Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and, Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition
Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition
Referenced models: Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal, value: added, updated, deleted, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Action In Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: between, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Module In Criterion
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: between
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries audited within a time range. The range must not exceed 180 days. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: between |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: audited_time |
value | array | Required within parent | Start and end of the range, as exactly two ISO 8601 timestamps. Maximum items: 2 Minimum items: 2 |
value[] | string | Each item | An ISO 8601 timestamp. Format: date-time |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries performed by a single user. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: equal |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: done_by |
value | array | Required within parent | Exactly one user reference. Maximum items: 1 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries belonging to a single module. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: equal |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: module |
value | array | Required within parent | Exactly one module reference. Maximum items: 1 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Module Value |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal, value: added, updated, deleted
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries whose action equals a single value. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: equal |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: action |
value | string | Required within parent | Action to match. Known values: added, updated, deleted |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Action In Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries whose action is one of several values. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: in |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: action |
value | array | Required within parent | Actions to match. Maximum items: 3 Minimum items: 1 |
value[] | string | Each item | Action to match. Known values: added, updated, deleted |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries performed by any of several users. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: in |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: done_by |
value | array | Required within parent | User references to match. Maximum items: 500 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Module In Criterion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Match audit log entries belonging to any of several modules. Additional keys: not allowed |
comparator | string | Required within parent | Comparison operator. Known values: in |
field | object | Required within parent | Field to apply the filter on. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the field. Known values: module |
value | array | Required within parent | Module references to match. Maximum items: 500 Minimum items: 1 |
value[] | Model | Each item | Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Module Value |
Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A group of filter conditions combined with a logical operator. Additional keys: not allowed |
group | array | Required within parent | Conditions to combine. Maximum items: 2 Minimum items: 1 |
group[] | JSON | Each item | A condition within the group. |
group[] (anyOf 1) | Model | Alternative | Expand Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition |
group[] (anyOf 2) | Model | Alternative | Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and |
group_operator | string | Required within parent | Logical operator applied between the grouped conditions. Known values: and |
Referenced models: Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and, Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition