IDOL Category Component 12.11

# SUBSTRING

The `SUBSTRING` field specifier (case sensitive) allows you to return documents whose field value is a substring of a specified string (or equal to a specified strings).

## Format

    FieldText=SUBSTRING{yourStrings}:yourFields

`yourStrings` | Type one or more strings. A document is only returned if one of `yourFields` contains a substring of one of the specified strings. You can match strings that contain punctuation (but see Note below) or consist of several words. NOTE: Strings in the query should be percent-encoded. This ensures that any commas or curly braces that are part of a string are not interpreted as query syntax. If you are sending HTTP requests using the content-type `application/x-www-form-urlencoded` you should then percent-encode all parameter values, meaning that any commas or curly braces that are part of a string are percent-encoded twice (such that a comma is represented by the sequence `%252c`). For more information, see Percent Encoding in Queries.
`yourFields` | Type one or more fields. A document is only returned if it contains one of these fields, and if the value in this field is a substring of `yourStrings`. Separate multiple fields with colons (`:`). There must be no space before or after a colon.

## Example

    FieldText=SUBSTRING{Telecommunications,Technology}:SECTOR

A document's `SECTOR` field must contain a string that is a substring of `Telecommunications` or `Technology`. If a document's `SECTOR` field, for example, has the value `Telecom` or `Technology`, the document is returned. If a document's `SECTOR` field has the value `Latest Technology`, the document is not returned.

    FieldText=SUBSTRING{scattering,doggedly}:ANIMAL

A document's `ANIMAL` field value must contain a substring of `scattering` or `doggedly` for this document to be returned. If a document's `ANIMAL` field, for example, has the value `cat` or `dog`, this document is returned.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.11 | Last updated February 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 12.11

Topic Title: SUBSTRING