restDataSourceServer

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter a descriptive name for this REST Data Source Server.

Property Groups:

  • endpointUrl
  • dynamicConfig
  • advanced
  • comments
endpointUrl
PropertyTypeRequiredDefault ValueDetails
urlstringYesdata type=string; maxLen=4000
Enter the endpoint URL for this REST Data Source Server.
 
endpointUrl {
  url: value
}
dynamicConfig
PropertyTypeRequiredDefault ValueDetails
plsqlCodemultiline stringNodata type=multiline string; maxLen=32000

A procedure which configures the Endpoint URL at runtime can be defined here.

procedureNamestringNodata type=string; maxLen=255

Enter the name of a procedure which configures the Endpoint URL at runtime. This can be a stored procedure or a procedure defined in item PL/SQL Code. The code below is for an application that implements multi-tenancy and supports different variations of Endpoint URL for the tenants. It changes the domain name in the URL, depending on the customer (Example URLs: https://cust-01.example.com, https://cust-02.example.com): 

dynamicConfig {
  plsqlCode: ```plsql
    value
  ```
  procedureName: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
Use the Static ID to reference the REST Data Source Server in API Calls. Static IDs are also used to identify an existing REST Data Source Server when the application is being exported and imported to another workspace.
promptOnInstallbooleanYesfalsedata type=boolean
Choose whether prompts for this REST Data Source Server should be displayed when the application is being imported on another Application Express instance.
httpsHostNamestringNodata type=string; maxLen=500
The host name to be matched against the common name (CN) of the remote server's certificate for an HTTPS request. It can also be a domain name like *.example.com. If NULL, the host name in the given URL will be used.
 
advanced {
  staticId: value
  promptOnInstall: false
  httpsHostName: value
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

restDataSourceServer sample (
    name: value
    endpointUrl {
        url: value
    }
    dynamicConfig {
        plsqlCode: ```plsql
          value
        ```
        procedureName: value
    }
    advanced {
        staticId: value
        promptOnInstall: false
        httpsHostName: value
    }
    comments {
        comments: ```
          value
        ```
    }
)