Change REST API search functionality does not support dot walk parameters when using sysparm_query - Known Error

Change REST API search functionality does not support dot walk parameters when using sysparm_query Description When using the search endpoints of the Change REST API and using dot-walk parameters in the sysparm_query header GET parameter, rather then validating the first field of the dot-walk, the whole dot-walk term is validated as a single field of the change_request table. This always fails.

Steps to Reproduce

1. Navigate to REST API Explorer 2. Select sn_chg_rest in Namespace 3. Use Normal- Search (Get) method 4. Click on Add query parameter and enter the following value: sysparm_query assignment_group.name=Hardware 5. Click Send

Workaround This problem has been fixed. If you are able to upgrade, review the Fixed In section to determine the latest version with a permanent fix your instance can be upgraded to.

The workaround would be to modify script include: ChangeCommon sys_id: ba686ea3b773130096c3e4f6ee11a9d3 function: ChangeCommon.buildEncodedQuery to the following:

ChangeCommon.buildEncodedQuery = function(nameValuePairs, tableName) { var result = { encodedQuery: '', fields: { applied: [], ignored: [] } }; if (!nameValuePairs || typeof nameValuePairs === 'undefined') return result; if (!tableName || typeof tableName === 'undefined') tableName = 'change_request'; var gr = new GlideRecord(tableName); var qc = null; if (nameValuePairs.sysparm_query && typeof nameValuePairs.sysparm_query !== 'undefined') { var sysparmQuery = nameValuePairs.sysparm_query + ''; var queryString = new GlideQueryString(tableName, sysparmQuery); queryString.deserialize(); var terms = queryString.getTerms(); var previousTerm = null; for (var i = 0; i 0) previousTerm = terms.get(i - 1); var term = terms.get(i); var field = term.getTermField(); // handle ^EQ at end of encoded query if (field !== null) { // Validate only the first dot walk field var dotWalkField = (field + '').split('.'); if (gr.isValidField(field) || (dotWalkField.length > 1 && gr.isValidField(dotWalkField[0]))) { // handle ^OR inside of encoded query if (term.isOR() && previousTerm !== null && qc !== null) qc.addOrCondition(field, term.getOperator(), term.getValue()); else qc = gr.addQuery(field, term.getOperator(), term.getValue()); result.fields.applied.push(field); } else result.fields.ignored.push(field); } } result.encodedQuery = gr.getEncodedQuery(); } else { Object.keys(nameValuePairs).forEach(function(name) { var value = nameValuePairs[name] + ''; if (gr.isValidField(name)) { gr.addQuery(name, value); result.fields.applied.push(name); } else result.fields.ignored.push(name); }, this); result.encodedQuery = gr.getEncodedQuery(); } return result; };