report_templates
Protocol buffer definition for report_templates
sift/report_templates/v1/report_templates.proto
CreateReportTemplateRequest
The request of a call to ReportTemplateService_CreateReportTemplate
to create a report template.
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
client_key | string | optional | |
description | string | optional | |
tag_names | string | repeated | |
organization_id | string | organization_id is only required if your user belongs to multiple organizations | |
rule_ids | CreateReportTemplateRequestRuleIds | ||
rule_client_keys | CreateReportTemplateRequestClientKeys |
CreateReportTemplateRequestClientKeys
Field | Type | Label | Description |
---|---|---|---|
rule_client_keys | string | repeated |
CreateReportTemplateRequestRuleIds
Field | Type | Label | Description |
---|---|---|---|
rule_ids | string | repeated |
CreateReportTemplateResponse
The response of a call to ReportTemplateService_CreateReportTemplate
to create a report template.
Field | Type | Label | Description |
---|---|---|---|
report_template | ReportTemplate |
GetReportTemplateRequest
The request for a call to ReportTemplateService_GetReportTemplate
to retrieve a report template.
If report_template_id
is provided then all other arguments will be ignored. The argument report_template_id
should not be used together with client_key
. The organization_id
argument is only required
if using client_key
and the user belongs to multiple organizations.
GetReportTemplateResponse
The request of a call to ReportTemplateService_GetReportTemplate
to retrieve a report template.
Field | Type | Label | Description |
---|---|---|---|
report_template | ReportTemplate |
ListReportTemplatesRequest
The request for a call to ReportTemplateService_ListReportTemplates
to retrieve report templates.
Field | Type | Label | Description |
---|---|---|---|
page_size | uint32 | The maximum number of report templates to return. The service may return fewer than this value. If unspecified, at most 50 report templates will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
page_token | string | A page token, received from a previous ListReportTemplates call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListReportTemplates must match the call that provided the page token. Optional. | |
filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are report_template_id , tag_id , tag_name , client_key , and name . For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
organization_id | string | This field is only required if your user belongs to multiple organizations. | |
include_archived | bool | If true then archived report templates will be included in the query. Defaults to false . | |
order_by | string | How to order the retrieved report templates. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and modified_date . If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date" |
ListReportTemplatesResponse
The response of a call to ReportTemplateService_ListReportTemplatesResponse
.
Field | Type | Label | Description |
---|---|---|---|
report_templates | ReportTemplate | repeated | |
next_page_token | string |
ReportTemplate
Field | Type | Label | Description |
---|---|---|---|
report_template_id | string | ||
organization_id | string | ||
client_key | string | optional | |
name | string | ||
description | string | optional | |
archived_date | google.protobuf.Timestamp | optional | |
created_by_user_id | string | ||
modified_by_user_id | string | ||
created_date | google.protobuf.Timestamp | ||
modified_date | google.protobuf.Timestamp | ||
rules | ReportTemplateRule | repeated | |
tags | ReportTemplateTag | repeated |
ReportTemplateRule
Field | Type | Label | Description |
---|---|---|---|
rule_id | string | ||
rule_version_id | string | ||
rule_version_number | uint32 | ||
client_key | string |
ReportTemplateTag
Field | Type | Label | Description |
---|---|---|---|
tag_name | string |
UpdateReportTemplateRequest
The request for a call to ReportTemplateService_UpdateReportTemplate
to update a report template. When updating
tags or rules, the update will perform a full replace. Additionally, when updating rules, only the rule ID or the rule client key
is required, but it is okay to provide both. If some rules contain only client keys and others only rule IDs, they will be consolidated.
Field | Type | Label | Description |
---|---|---|---|
report_template | ReportTemplate | The report template to update. | |
update_mask | google.protobuf.FieldMask | The list of fields to be updated. The fields available to be updated are name , archived_date , description , tags , and rules . |
UpdateReportTemplateResponse
The response of a call to ReportTemplateService_UpdateReportTemplate
.
Field | Type | Label | Description |
---|---|---|---|
report_template | ReportTemplate |
ReportTemplateService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetReportTemplate | GetReportTemplateRequest | GetReportTemplateResponse | Retrieve a report template. |
CreateReportTemplate | CreateReportTemplateRequest | CreateReportTemplateResponse | Create a report template. |
ListReportTemplates | ListReportTemplatesRequest | ListReportTemplatesResponse | List report templates. |
UpdateReportTemplate | UpdateReportTemplateRequest | UpdateReportTemplateResponse | Updates an existing report template using the list of fields specified in update_mask . |