Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Data Structures
These are some of the data structures used in the Data Flow Management Web Service API.
CIProperties
is a collection of collections. Each collection contains properties of a different data type. For example, there can be a dateProps
collection, a strListProps
collection, an xmlProps
collection, and so on.
Each type collection contains individual properties of the given type. The names of these properties elements is the same as the container, but in singular. For example, dateProps
contains dateProp
elements. Each property is a name-value pair.
See CIProperties
A list of IP
elements, each of which contains an IPv4 or IPv6 Address.
See IPList
An IPRange
has two elements, Start
and End
. Each element contains an Address
element, which is an IPv4 or IPv6 Address.
See IPRange
Two IPRanges
. Exclude
is a collection of IPRanges
to exclude from the job. Include
is a collection of IPRanges
to include in the job.
See Scope