From Bright Pattern Documentation
< 3.12:Scenario-builder-reference-guide
Revision as of 20:59, 3 August 2016 by Sasha (talk | contribs) (Created new topic from branched topic Documentation:ServicePattern:scenario-builder-reference-guide:ZendeskSearch:3.11)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Zendesk Search

This block executes the specified Zendesk record selection statement. For more information, see the following articles:

https://developer.zendesk.com/rest_api/docs/core/search

https://support.zendesk.com/hc/en-us/articles/203663226

The columns of the first record of retrieved recordset are stored in variables <recordset_name>.<column_name>. For the statement above the results will be stored in variables Recorset.id and Recordset.name.

The number of returned records is stored in variable <recordset_name>.__count__, for example RS.__count__. (Note the double underscores in front and after count; they are used to reduce the chance of confusing the name of this variable with a column name in a recordset.)

To iterate through the recordset, use the Get Next Record block.


Conditional Exits

  • Failed – Executes if the search operation failed.
  • No data - Executes if no data matching the specified search criteria is found.


Settings

  • Title text - The name of the block instance.
  • Recordset name – Name of the recordset that will be retrieved via this search operation.
  • Max results – Maximum number of records in the recordset.
  • Search string – Record selection statement (see the links above). May contain application variables specified in the $(varname) format.


The code and the body of the received HTTP response is stored in local variables $(integrationResultCode) and $(integrationResultBody) respectively. For troubleshooting purposes, use EMail or Internal Message block to obtain content of responses indicating a failed search attempt. For more information, see description of variable $(integrationResultBody).


< Previous | Next >
< Previous | Next >