Metadata Filters
While querying the resources under the _Meta resource, the result set can be filtered based on the selected subset of fields which are defined in various input object types.
ModuleFilter
Filters the result set of Modules type based on the below fields.
- exclude_subform: Boolean
- api_name: String
- api_names: List of Strings, if provided, empty list of api_names is not allowed
input ModuleFilter
Copiedinput ModuleFilter {
exclude_subform: Boolean
api_name: String
api_names: [String!]
}
Example
Copiedquery{
Meta {
Modules(filter: { api_names: ["Leads", "Contacts"] }) {
_data {
id
api_name
}
}
}
}UserFilter
Filters the result set of Users type based on the below fields.
- USERTYPE: Enum, pass a valid value : AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser, DeveloperUsers, ParentRoleUsers, ChildRoleUsers, SubordinateRoleUsers, AllActiveUsers, ConfirmedReportingUsers, ActiveAndDeactive, ActiveLiteUser.
- include_lite_user: Boolean
input UserFilter
Copiedinput UserFilter {
type: USERTYPE
include_lite_user: Boolean
}
Example
Copiedquery {
Meta {
Users(filter: { type: AdminUsers }) {
_data {
id
}
}
}
}input ModuleFieldFilter
Copiedinput ModuleFieldFilter {
api_names: [String!]
api_name: String
}Example
Copiedquery {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
id
fields(filter: { api_names: ["Owner", "First_Name"] }) {
_data {
id
api_name
}
}
}
}
}
}
KanbanView Filter
Filters the result set of KanbanView based on the below fields.
- module_api_name: String Mandatory
input FieldFilter
Copiedinput FieldFilter {
module_api_name: String!
}Example
Copiedquery {
Meta {
KanbanView(filter: { module_api_name: "Leads" }) {
id
view_name
color_scheme
}
}
}
UserPropertyFilter
Filters the result set of UserProperty type based on the below fields.
- user_id: Long
- current_user: Boolean
input UserPropertyFilter
Copiedinput UserPropertyFilter {
user_id: Long
current_user: Boolean
}Example
Copiedquery {
Meta {
UserProperties(filter: { current_user: true }) {
user {
id
last_name
}
}
}
}
PermissionsFilter
Filters the result set of ProfilePermissions type based on the below field.
- profile_id: Long, Mandatory
input PermissionFilter
Copiedinput PermissionFilter {
profile_id: Long!
}Example
Copiedquery {
Meta {
ProfilePermissions(filter: { profile_id: "2484261000000015972" }) {
_data {
name
id
}
}
}
}
ProfileFilter
Filters the result set of Profiles type based on the below fields.
- api_name: String
- api_names: List of Strings, if provided, empty list of api_names is not allowed
input ProfileFilter
Copiedinput ProfileFilter {
api_name: String
api_names: [String!]
}Example
Copiedquery {
Meta {
Profiles(filter: { api_names: ["Standard","Administrator"] }) {
_data {
id
display_label
}
}
}
}
RoleFilter
Filters the result set of Roles type based on the below fields.
- api_name: String
- api_names: List of Strings, if provided, empty list of api_names is not allowed
Copiedinput RoleFilter {
api_name: String
api_names: [String!]
}Example
Copiedquery {
Meta {
Roles(filter: { api_names: ["CEO","Manager"] }) {
_data {
id
display_label
api_name
}
}
}
}
WidgetFilter
Filters the result set of Widgets type based on the below fields.
- api_name: String
- api_names: List of Strings, if provided, empty list of api_names is not allowed
input WidgetFilter
Copiedinput WidgetFilter {
api_name: String
api_names: [String!]
}Example
Copiedquery {
Meta {
Widgets(filter: { api_names: ["maps", "Lists"] }) {
_data {
id
api_name
}
}
}
}
LayoutFilter
Filters the result set of Layouts type based on the below fields.
- layout_id: Long
- api_name: String
- api_names: List of Strings, if provided, empty list of api_names is not allowed
input LayoutFilter
Copiedinput LayoutFilter {
layout_id: Long
api_names: [String!]
api_name: String
}Example
Copiedquery {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
api_name
layouts(filter: { api_name: "Standard__s" }) {
_data {
id
created_time
api_name
id
show_business_card
modified_time
name
api_name
status
source
generated_type
created_for
}
}
}
}
}
}
CustomViewFilter
Filters the result set of CustomViews type based on the below fields.
- custom_view_id: Long
- api_name: String
- api_names: List of Strings, if provided, empty list of api_names is not allowed
input CustomViewFilter
Copiedinput CustomViewFilter {
custom_view_id: Long
api_names: [String!]
api_name: String
}Example
Copiedquery {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
api_name
custom_view(filter: { api_name: "All_Locked_Leads__s" }) {
_data {
id
api_name
display_value
access_type
system_name
default
modified_time
name
system_defined
category
last_accessed_time
sort_order
favorite
locked
criteria
}
}
}
}
}
}
ModuleProfileFilter
Filters the result set of ProfileModuleProperties type based on the below fields.
- profile_ids: Long
input ModuleProfileFilter
Copiedinput ModuleProfileFilter {
profile_ids: [Long!]
}Example
Copiedquery Meta {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
plural_label
presence_sub_menu
id
status
profiles(filter: { profile_ids: [2484261000000015972] }) {
_data {
id
display_label
created_time
modified_time
api_name
custom
name
description
}
}
}
}
}
}
LayoutModeFilter
Filters the result set of LayoutMode type based on the below fields.
- type : enum LayoutMode
input LayoutModeFilter
Copiedinput LayoutModeFilter {
type: LAYOUTMODE!
}
enum LAYOUTMODE {
all
quick_create
quick_view
business_card
view
}Example
Copiedquery {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
plural_label
presence_sub_menu
id
layouts(filter: { api_name: "Standard__s" }) {
_data {
mode(filter: { type: view }) {
sections {
_data {
id
display_label
}
}
}
}
}
}
}
}
}
ProfileFieldPermissionFilter
Filters the result set of ProfileFieldProperties type based on the below fields.
- profile_id : List of profile_ids , if provided, empty list of profile_ids is not allowed.
input ProfileFieldPermissionFilter
Copiedinput ProfileFieldPermissionFilter {
profile_ids: [Long!]
}Example
Copiedquery {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
plural_label
presence_sub_menu
id
status
fields {
_data {
id
api_name
profile_permissions(filter: { profile_ids: [2484261000000015972] }) {
_data {
permission_type
visible
profile {
id
display_label
created_time
modified_time
api_name
custom
name
description
}
}
}
}
}
}
}
}
}
SectionFilter
Filters the result set of Sections type based on the below field.
- section_id : Long
input SectionFilter
Copiedinput SectionFilter {
section_id: Long
}Example
Copiedquery {
Meta {
Modules(filter: { api_name: "Leads" }) {
_data {
plural_label
presence_sub_menu
id
layouts(filter: { api_name: "Standard__s" }) {
_data {
mode(filter: { type: view }) {
sections {
_data {
id
display_label
}
}
}
}
}
}
}
}
}
ViewableModuleFilter
Filters the result set of viewable_modules that is of type Modules inside UserProperties type based on the below field.
- exclude_subform : Boolean
input ViewableModuleFilter
Copiedinput ViewableModuleFilter {
exclude_subform: Boolean
}Example
Copiedquery {
Meta {
UserProperties(filter: { current_user: true }) {
viewable_modules(filter: { exclude_subform: true }) {
_data {
plural_label
presence_sub_menu
id
properties
visibility
on_demand_properties
web_link
api_name
module_name
description
modified_time
show_as_tab
sequence_number
singular_label
api_supported
generated_type
feeds_required
business_card_field_limit
status
}
}
}
}
}