IDOL Category Component 24.4
IDOL Category Component Help

# Query with the State Token

When you query the IDOL Content component, you can use the `StateID`, `StateMatchID`, and `StateDontMatchID` parameters to pass a state token. These parameters are similar to the `ID`, `MatchID`, and `DontMatchID` parameters that specify individual document IDs.

Action | State parameters supported
--- | ---
`GetQueryTagValues` | `StateMatchID`, `StateDontMatchID`
`GetContent` | `StateID`
`List` | `StateMatchID`, `StateDontMatchID`
`Query` | `StateMatchID`, `StateDontMatchID`
`Suggest` | `StateID`, `StateMatchID`, `StateDontMatchID`
`SuggestOnText` | `StateMatchID`, `StateDontMatchID`
`Summarize` | `StateID`
`TermGetBest` | `StateID`

If you use `StateMatchID` and `StateDontMatchID` in the same action, Content removes any documents in the `StateDontMatchID` list from the `StateMatchID` list.

Examples:

- Retrieve all documents. Use the `StateID` parameter to retrieve all documents in the token:

      action=GetContent&StateID=CWQ4FJ9LZSE5-6

- Query only the specified documents. Use the `StateMatchID` parameter to, for example, query only the first four documents in the stored result set:

      action=Query&Text=pear&StateMatchID=CWQ4FJ9LZSE5-6[0-3]

- Query all but the specified documents. Use the `StateDontMatchID` parameter to, for example, query all content except for the documents specified in the token:

      action=Query&Text=pear&StateDontMatchID=CWQ4FJ9LZSE5-6

NOTE: A stored-state-aware DAH forwards any query that includes a state token to the IDOL Content component that originally created the token.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 24.4

Topic Title: Query with the State Token