Request Options

Updated on 05 Dec 2022

Dark

Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Call options are query parameters that are not translated. These are generally metadata on the request. Some examples include page or page_size.

The call option object is converted to a querystring by the Adapter libraries and appended to the call.

Example: Request Options

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=doggie]',
  priority: 1,
  event: 'giveMeMyData'
};

"/api/v1/devices/{pathv1}/interface/{pathv2}?{query}"
                  is replaced with
"/api/v1/devices/grp123/interface/dev123?name=anyname&page=2"

Was this article helpful?

What's Next

Dynamic Headers

Changing your password will log you out immediately. Use the new password to log back in.

Current password

New password

Confirm password

First Name

First name must have atleast 2 characters. Numbers and special characters are not allowed.

Last Name

Last name must have atleast 1 characters. Numbers and special characters are not allowed.

New email

Enter a valid email

Re-enter your password

Enter a valid password

Your profile has been successfully updated.

Logout