Microsoft Graph filter operators are the OData $filter expressions you add to Graph API requests to narrow results on the server before they’re returned. They let you select only the resources that match certain criteria—such as equality and comparison checks (eq, ne, gt, ge, lt, le), logical combinations (and, or, not), string matching (startswith, endswith, contains), membership tests (in), and collection predicates (any, all).
openapi: 3.1.0
info:
title: Microsoft Graph Filteroperators
description: Needs a description.
paths:
/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators():
description: Provides operations to call the filterOperators method.
get:
tags:
- Applications.synchronization
summary: Microsoft Graph Invoke function filterOperators
description: List all operators supported in the scoping filters.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: >-
applications.application.synchronization.jobs.synchronizationJob.schema.filterOperators
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.filterOperatorSchema
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
schema:
type: string
x-ms-docs-key-type: synchronizationJob
x-ms-docs-grouped-path:
- >-
/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators()
/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators():
description: Provides operations to call the filterOperators method.
get:
tags:
- Applications.synchronization
summary: Microsoft Graph Invoke function filterOperators
description: List all operators supported in the scoping filters.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: >-
applications.application.synchronization.templates.synchronizationTemplate.schema.filterOperators
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.filterOperatorSchema
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
x-ms-docs-grouped-path:
- >-
/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators()
/filterOperators:
description: >-
Provides operations to manage the collection of filterOperatorSchema
entities.
get:
tags:
- filterOperators.filterOperatorSchema
summary: Microsoft Graph Get entities from filterOperators
operationId: filterOperators.filterOperatorSchema.ListFilterOperatorSchema
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.filterOperatorSchemaCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- filterOperators.filterOperatorSchema
summary: Microsoft Graph Add new entity to filterOperators
operationId: filterOperators.filterOperatorSchema.CreateFilterOperatorSchema
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/filterOperators/{filterOperatorSchema-id}:
description: >-
Provides operations to manage the collection of filterOperatorSchema
entities.
get:
tags:
- filterOperators.filterOperatorSchema
summary: Microsoft Graph Get entity from filterOperators by key
operationId: filterOperators.filterOperatorSchema.GetFilterOperatorSchema
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- filterOperators.filterOperatorSchema
summary: Microsoft Graph Update entity in filterOperators
operationId: filterOperators.filterOperatorSchema.UpdateFilterOperatorSchema
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- filterOperators.filterOperatorSchema
summary: Microsoft Graph Delete entity from filterOperators
operationId: filterOperators.filterOperatorSchema.DeleteFilterOperatorSchema
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: filterOperatorSchema-id
in: path
description: The unique identifier of filterOperatorSchema
required: true
schema:
type: string
x-ms-docs-key-type: filterOperatorSchema
/filterOperators/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- filterOperators.filterOperatorSchema
summary: Microsoft Graph Get the number of the resource
operationId: filterOperators.GetCount-b21d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators():
description: Provides operations to call the filterOperators method.
get:
tags:
- servicePrincipals.synchronization
summary: Microsoft Graph Invoke function filterOperators
description: List all operators supported in the scoping filters.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: >-
servicePrincipals.servicePrincipal.synchronization.jobs.synchronizationJob.schema.filterOperators
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.filterOperatorSchema
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
schema:
type: string
x-ms-docs-key-type: synchronizationJob
x-ms-docs-grouped-path:
- >-
/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators()
/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators():
description: Provides operations to call the filterOperators method.
get:
tags:
- servicePrincipals.synchronization
summary: Microsoft Graph Invoke function filterOperators
description: List all operators supported in the scoping filters.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: >-
servicePrincipals.servicePrincipal.synchronization.templates.synchronizationTemplate.schema.filterOperators
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.filterOperatorSchema
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
x-ms-docs-grouped-path:
- >-
/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators()
components:
schemas:
BaseCollectionPaginationCountResponse:
title: Base collection pagination and count responses
type: object
properties:
'@odata.count':
type: integer
format: int64
nullable: true
'@odata.nextLink':
type: string
nullable: true
microsoft.graph.filterOperatorSchema:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: filterOperatorSchema
required:
- '@odata.type'
type: object
properties:
arity:
$ref: '#/components/schemas/microsoft.graph.scopeOperatorType'
multivaluedComparisonType:
$ref: >-
#/components/schemas/microsoft.graph.scopeOperatorMultiValuedComparisonType
supportedAttributeTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeType'
description: >-
Attribute types supported by the operator. The possible values
are: Boolean, Binary, Reference, Integer, String.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.filterOperatorSchema'
parameters:
top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
filter:
name: $filter
in: query
description: Filter items by property values
style: form
explode: false
schema:
type: string
count:
name: $count
in: query
description: Include count of items
style: form
explode: false
schema:
type: boolean
examples: {}
responses:
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
ODataCountResponse:
description: The count of the resource
content:
text/plain:
schema:
$ref: '#/components/schemas/ODataCountResponse'
tags:
- name: Applications.synchronization
- name: filterOperators.filterOperatorSchema
- name: servicePrincipals.synchronization