Filtering the Response
  • 05 Dec 2022
  • Dark
    Light
  • PDF

Filtering the Response

  • Dark
    Light
  • PDF

Article summary

Not all systems provide filtering capabilities.

  • The adapter will filter the response data based on dynamic criteria provided in the request.
  • The filter string is a JSON Query used to filter the incoming data. Since the filter is in the request object it can be set-up on a request-by-request basis.
  • This param is used to request that a system return all the devices that start with “ABC”.

Example: Filtering a response.

const reqObj =
  payload: { garbage: 'need since post' },
  uriPathVars: [groupId, deviceId],
  uriQuery: { name: 'anyname' },
  uriOptions: { page: 2 },
  addlHeaders: { audit: 'turnOn' },
  authData: { domain: 'abc' },
  callProperties: {
    stub: true,
    request: {
      attempt_timeout = 60000
    }
  }, 
  filter: '[*name=abc]',
  priority: 1,
  event: 'giveMeMyData'
};

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.