Forms › The Form Designer › Form Element Functions › Form Elements › REST Methods › ca_pam_getRESTDataAuth(url, userName, password, doNotValidateCert, headers, callBack)

ca_pam_getRESTDataAuth(url, userName, password, doNotValidateCert, headers, callBack)

Starts the REST service at a specified URL that requires authentication. This method supports only Basic HTTP authentication. You can use this method with the following signatures:

ca_pam_getRESTDataAuth (url, userName, password, callBack)

ca_pam_getRESTDataAuth (url, userName, password, doNotValidateCert, callBack)

Note: The dataset expressions are supported in the ca_pam_getRESTDataAuth function.

Input Parameters

url (string)

Defines the URL of the HTTP request. The URL starts with http:// or https://.

username (string)

Defines the user name for which to authenticate the specified URL.

password (string)

Defines the password associated with the specified user name.

doNotValidateCert (boolean)

Specifies whether a valid SSL certificate is found. This field is relevant when querying an HTTPS URL.

• false - Validates the SSL certificate and fails the operation if the certificate is invalid.
• true - Accepts the SSL certificate even if it is invalid and continues to make the HTTP call.

headers (object)

Defines a list of key/value pairs that sets headers in the request.

callBack (object)

Defines a reference to the function object to call after retrieving the data, including its onSuccess and onFailure methods.

Return Value

When the function retrieves the data, either the onSuccess(result) or onFailure(caught) callBack function runs. The function itself does not return any value.

Example

The dataset expressions are supported in the ca_pam_getRESTDataAuth function as shown in the following example:

ca_pam_getRESTDataAuth('Datasets["/Forms/RestDataset"].Authurl','Datasets["/Forms/RestDataset"].Authusername','Datasets["/Forms/RestDataset"].Authpwd',callBack);

Note: You need to provide an absolute path of the dataset.