Request Path
  • 05 Dec 2022
  • Dark
    Light
  • PDF

Request Path

  • Dark
    Light
  • PDF

Article Summary

Path Variables are used to dynamically set data in the call path to the other system.

  • When the call path is defined (see path example below), the path variables will be used to replace {pathv1} and {pathv2} in the call path.
    • uriPathVars is an array
    • uriPathVars[0] will be used to replace {pathv1} and uriPathVars[1] will be used to replace {pathv2}

Example: Request path variables.

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}
Replaced With
api/v1/devices/dev123/interface/int123?{query}


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.