Developer Guide

6.1.2
- 6.2
- 6.1

Back Next

Search API

You can use the search API to search for objects with a filter clause. The filter clause accepts the name of the property, operator, and one or more values of the property you want to search for. You can also specify the state and validity for each property. Add the additional flags for a property as enumerations in brackets in the same query.

To search for the deployment state in a query, you must can have an IN query and specify the list of all the values you want to search. The three values for the deployment states include DRAFT, NEEDS_DEPLOYMENT, and DEPLOYED.

For example, the following query creates a FilterClause that queries for objects with deployState either DEPLOYED or NEEDS_DEPLOYMENT:

FilterClause clause = new FilterClause("deployState", OPCODE.IN, "NEEDS_DEPLOYMENT", "DEPLOYED");

deployState is the name of the property, OPCODE.IN is the operator, and "NEEDS_DEPLOYMENT", and "DEPLOYED" are values of the property that you want to search.

You can also query date fields, such as lastModifiedDate or createDate. You must specify the date in the following format:

yyyy-MM-dd'T'HH:mm:ss.SSSZZ

The following list provides the common properties that you can query for all objects, with the enumerations in brackets. Specify the property in exact same case:

name

deployState(DRAFT, NEEDS_DEPLOYMENT, DEPLOYED)

createdBy

createDate

artifactType(topics, sources, connections, rules, templates, responders, analytics, watchlists, responses)

predefined (true/false)

valid (true/false)

lastModifiedBy

lastModifiedDate

Java Adapter for REST API

Object Specific Fields in a Filter Clause

Filter Clause Example