searchAndOpenRecords (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0

Artigo
12/10/2024

The method searches for the record from the communication widget during the inbound communication and opens the record.

Syntax

Microsoft.CIFramework.searchAndOpenRecords(entityLogicalName, queryParameters, searchOnly, correlationId, searchType).then(successCallback, errorCallback);

Parameters

Name	Type	Required	Description
entityLogicalName	String	Yes	Name of the entity to search and open.
queryParameters	String	Yes	OData system query options, $select and $expand, to retrieve your data. - Use the $select system query option to limit the properties returned by including a comma-separated list of property names. This is an important performance best practice. If properties aren’t specified using $select, all properties will be returned. - Use the $expand system query option to control the data returned by related entities. If you just include the name of the navigation property, you’ll receive all the properties for related records. You can limit the properties returned for related records using the $select system query option in parentheses after the navigation property name. Use this for both single-valued and collection-valued navigation properties. You can specify the query options starting with `?`. You can also specify multiple query options by using `&` to separate the query options. For example: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`
searchOnly	Boolean	Yes	Set the `searchOnly` to false when you want the search to display a single record based on the search context. If the search result has multiple records and if you've used `queryParameters` to indicate the search option, then setting `searchOnly` to false opens and populates the search page with the search option. Note: If the search result has multiple records, then records for Account, Contact, and Activity entities only are opened. Set to true to get results of the search as a Promise object, instead of the record or search page.
searchType	Number	No	Type of search page to open—0 for relevance search and 1 for categorized search. If no parameter is provided, the records are searched by category.
correlationId	GUID	No	Used to group the related API calls together for diagnostic telemetry.
successCallback	Function	No	A function to call when the request is successful.
errorCallback	Function	No	A function to call when the request fails.

Return value

Returns a Promise object of type String. On success, the method returns the search results as per the search query.

Note

You can fetch a maximum of 5000 records at once (if more than 5000 records exist). You can narrow down the results by using query options such as $filter, $select, and $top in the method parameters as shown in the Examples section. More information: Query options overview
To search based on relevance, you must configure relevance search. If relevance search isn't enabled, then the search will be performed based on category.

Examples

Search and open the contact record

This sample code searches the name and phone number of a contact record. It opens an empty search results page.


// retrieve contact record
Microsoft.CIFramework.searchAndOpenRecords("contact", "?$select=fullname,telephone1", false).
then(
    function success(result) { 
    res=JSON.parse(result);
        console.log(`Record values: Full Name: ${res[0].fullname}, Telephone Number: ${res[0].telephone1}`);
        // perform operations on record retrieval and opening
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Search and display on the list of contact records

This sample code searches and displays the name and phone number of Contact entity records where the first name is Contoso. Using $search, you can make sure that the search results page is populated with the search term Contoso.

Note

If you're using $search in the query and the searchOnly parameter is set to false, it'll always open the search results page and not the retrieved record. If you want to open the retrieved record, don't use $search parameter in the query.


// Retrieve Contact entity record
// Change searchOnly parameter to true, if you do not want to open the search results page
Microsoft.CIFramework.searchAndOpenRecords("contact", "?$select=fullname,telephone1&$filter=firstname eq 'Contoso'&$search=Contoso", false).
then(
    function success(result) {
    res=JSON.parse(result);
        console.log(`The caller name is: ${res[0].fullname}, Telephone Number: ${res[0].telephone1}`);
        // perform operations on record retrieval and opening
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Search and display top 10 active contact records

This sample code searches and displays the top 10 active contact records.

Microsoft.CIFramework.searchAndOpenRecords("contact", "$filter=statecode eq 0&$select=description&$top=10", false).
then(
    function success(result) { 
    res=JSON.parse(result);
        // perform operations on record retrieval and opening
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Search and display name and phone number by specifying the relevance search type

This sample code searches and displays the name and phone number of Contact entity records by specifying the relevance search type.

Microsoft.CIFramework.searchAndOpenRecords("contact", "?$select=fullname,telephone1", false, "b44d31ac-5fd1-e811-8158-000d3af97055", 0).
then(     
    function success(result) {     
    res=JSON.parse(result);         
    console.log(`Record values: Full Name: ${res[0].fullname}, Telephone Number: ${res[0].telephone1}`);         
       // perform operations on record retrieval and opening 
    },     
    function (error) {         
        console.log(error.message);         
        // handle error conditions     
    } 
);

Partilhar via