restDataSource (oracleCloudAppsSaas)

Parent: restDataSource

Applies whentype = oracleCloudAppsSaas

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter a name of the REST Data Source.

Property Groups:

  • settings
  • dataProfile
  • source
  • advanced
  • authentication
  • synchronization
  • synchronizationRateLimit
  • invocationScope
  • restSourceCatalog
  • subscription
  • comments
settings
PropertyTypeRequiredDefault ValueDetails
useBatchDmlbooleanYestruedata type=boolean
rootResourceNamestringNodata type=string; maxLen=4000
useTotalResultsbooleanYesfalsedata type=boolean
usePaginationbooleanYestruedata type=boolean
settings {
  useBatchDml: false
  rootResourceName: value
  useTotalResults: false
  usePagination: false
}
dataProfile
PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
formatenumYesjsondata type=string; lov=STATIC
Valid values: csv json xml
rowSelectorstringNodata type=string; maxLen=255
containsSingleRowbooleanYesfalsedata type=boolean
singleRowSelectorstringNodata type=string; maxLen=255
useRawSelectorsbooleanYesfalsedata type=boolean
commentsmultiline stringNodata type=multiline string; maxLen=4000
dataProfile {
  name: value
  format: csv
  rowSelector: value
  containsSingleRow: false
  singleRowSelector: value
  useRawSelectors: false
  comments: ```
    value
  ```
}
source
PropertyTypeRequiredDefault ValueDetails
typeenumYesdata type=string; lov=PLUGINS
Valid values: oracleCloudAppsSaas
remoteServerreferenceYesdata type=reference; lov=COMPONENT; references=restDataSourceServer
remoteServerreferenceYesdata type=reference; lov=COMPONENT; references=restEnabledSqlDatabase
urlPathPrefixstringYesdata type=string; maxLen=500
source {
  type: oracleCloudAppsSaas
  remoteServer: @component
  urlPathPrefix: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
encodingenumNodata type=string; lov=STATIC
Valid values: iso-8859-6 windows-1256 big5 gbk iso-8859-5 koi8-r koi8-u windows-1251 iso-8859-2 windows-1250 iso-8859-7 windows-1253 iso-8859-8-i windows-1255 euc-jp shift-jis euc-kr iso-8859-4 windows-1257 iso-8859-3 tis-620 iso-8859-9 windows-1254 us-ascii utf-16be utf-16le utf-8 windows-1258 iso-8859-1 windows-1252
numericCharsstringNodata type=string; maxLen=2
xmlNamespacesmultiline stringNodata type=multiline string; maxLen=4000
csvSeparatorstringNodata type=string; maxLen=5
csvEnclosedBystringNodata type=string; maxLen=1
skipRowsnumberNodata type=number; maxLen=5
firstLineContainsHeadersbooleanYestruedata type=boolean
staticIdstringYesdata type=string; maxLen=255
Use the Static ID to reference the REST Data Source in API Calls.
passEcidstringNodata type=string; maxLen=32767
httpTransferTimeoutintegerNodata type=integer; maxLen=32767
openapiUrlstringNodata type=string; maxLen=4000
advanced {
  encoding: iso-8859-6
  numericChars: value
  xmlNamespaces: ```
    value
  ```
  csvSeparator: value
  csvEnclosedBy: value
  skipRows: 42
  firstLineContainsHeaders: false
  staticId: value
  passEcid: value
  httpTransferTimeout: 42
  openapiUrl: value
}
authentication
PropertyTypeRequiredDefault ValueDetails
credentialsreferenceNodata type=reference; lov=COMPONENT; references=webCredential
serverreferenceNodata type=reference; lov=COMPONENT; references=authenticationServer
Applies whencredentials is set
urlPathPrefixstringNodata type=string; maxLen=500
Applies whencredentials is set and server is set
authentication {
  credentials: @component
  server: @component
  urlPathPrefix: value
}
synchronization
PropertyTypeRequiredDefault ValueDetails
jobIsActivebooleanYesfalsedata type=boolean
localTableOwnerstringNodata type=string; maxLen=32767
localTableNamestringNodata type=string; maxLen=128
nestedRowsreferenceNodata type=reference; lov=COMPONENT; references=dataProfileColumn
Applies whenlocalTableName is set
typeenumYesappenddata type=string; lov=STATIC
Valid values: append merge fullRefreshDelete fullRefreshTruncate
Applies whenlocalTableName is set
schedulemultiline stringNodata type=multiline string; maxLen=255
Applies whenlocalTableName is set
commitIntervalintegerNodata type=integer; maxLen=32767
Applies whenlocalTableName is set
httpRequestLimitintegerNodata type=integer; maxLen=32767
Applies whenlocalTableName is set
synchronization {
  jobIsActive: false
  localTableOwner: value
  localTableName: value
  nestedRows: @component
  type: append
  schedule: ```
    value
  ```
  commitInterval: 42
  httpRequestLimit: 42
}
synchronizationRateLimit
PropertyTypeRequiredDefault ValueDetails
timeframeintegerNodata type=integer; maxLen=32767
Applies whenlocalTableName is set
httpRequestsintegerYesdata type=integer; maxLen=32767
Applies whenlocalTableName is set and timeframe is set
whenExceededenumYesraiseErrordata type=string; lov=STATIC
Valid values: raiseError wait
Applies whenlocalTableName is set and timeframe is set
synchronizationRateLimit {
  timeframe: 42
  httpRequests: 42
  whenExceeded: raiseError
}
invocationScope
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: staticValue item sqlQuery expression functionBody
Applies whencredentials is set
textmultiline stringYesdata type=multiline string; maxLen=32767
Applies whencredentials is set and type = staticValue
itemstringYesdata type=string; maxLen=255; textCase=UPPER
Applies whencredentials is set and type = staticValue
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whencredentials is set and type = sqlQuery
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whencredentials is set and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whencredentials is set and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whencredentials is set and type = functionBody and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whencredentials is set and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whencredentials is set and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whencredentials is set and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whencredentials is set and type = expression and language = javaScript-mle
invocationScope {
  type: staticValue
  text: ```
    value
  ```
  item: value
  sqlQuery: ```sql
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
}
restSourceCatalog
PropertyTypeRequiredDefault ValueDetails
namestringNodata type=string; maxLen=32767
servicestringNodata type=string; maxLen=32767
versionstringNodata type=string; maxLen=32767
restSourceCatalog {
  name: value
  service: value
  version: value
}
subscription
PropertyTypeRequiredDefault ValueDetails
masterreferenceNodata type=reference; lov=COMPONENT; references=restDataSource
subscription {
  master: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

restDataSource sample (
    name: value
    settings {
        useBatchDml: false
        rootResourceName: value
        useTotalResults: false
        usePagination: false
    }
    dataProfile {
        name: value
        format: csv
        rowSelector: value
        containsSingleRow: false
        singleRowSelector: value
        useRawSelectors: false
        comments: ```
          value
        ```
    }
    source {
        type: oracleCloudAppsSaas
        remoteServer: @component
        urlPathPrefix: value
    }
    advanced {
        encoding: iso-8859-6
        numericChars: value
        xmlNamespaces: ```
          value
        ```
        csvSeparator: value
        csvEnclosedBy: value
        skipRows: 42
        firstLineContainsHeaders: false
        staticId: value
        passEcid: value
        httpTransferTimeout: 42
        openapiUrl: value
    }
    authentication {
        credentials: @component
        server: @component
        urlPathPrefix: value
    }
    synchronization {
        jobIsActive: false
        localTableOwner: value
        localTableName: value
        nestedRows: @component
        type: append
        schedule: ```
          value
        ```
        commitInterval: 42
        httpRequestLimit: 42
    }
    synchronizationRateLimit {
        timeframe: 42
        httpRequests: 42
        whenExceeded: raiseError
    }
    invocationScope {
        type: staticValue
        text: ```
          value
        ```
        item: value
        sqlQuery: ```sql
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
    }
    restSourceCatalog {
        name: value
        service: value
        version: value
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)