restDataSource (http)
Applies when
type = http| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
name | string | Yes | data type=string; maxLen=255Enter a name of the REST Data Source. |
settings
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
paginationType | enum | No | data type=string; maxLen=4000; lov=STATICValid values: pageSizeAndPageNo pageNo pageSizeAndFetchOffset pageSizeAndPageToken | |
pageSizeUrlParam | string | No | data type=string; maxLen=255Applies when pagination_type in (FLEXIBLE)pagination_type in (PAGE_NUMBER_FLEXIBLE_SIZE)pagination_type in (PAGE_TOKEN_FLEXIBLE_SIZE) | |
pageSizeMax | number | No | data type=number; maxLen=10Applies when pagination_type in (PAGE_NUMBER_FLEXIBLE_SIZE)pagination_type in (FLEXIBLE)pagination_type in (PAGE_TOKEN_FLEXIBLE_SIZE) | |
pageNoUrlParam | string | Yes | data type=string; maxLen=255Applies when pagination_type in (PAGE_NUMBER_FLEXIBLE_SIZE)pagination_type in (PAGE_NUMBER_FIXED_SIZE) | |
indexOfFirstPage | enum | Yes | 1 | data type=string; maxLen=4000; lov=STATICValid values: 0 1Applies when pagination_type in (PAGE_NUMBER_FLEXIBLE_SIZE)pagination_type in (PAGE_NUMBER_FIXED_SIZE) |
fixedPageSize | number | Yes | data type=number; maxLen=10Applies when pagination_type = PAGE_NUMBER_FIXED_SIZE | |
rowOffsetUrlParam | string | Yes | data type=string; maxLen=255Applies when pagination_type = FLEXIBLE | |
rowOffsetType | enum | Yes | rowsToSkip | data type=string; maxLen=4000; lov=STATICValid values: rowsToSkip firstRowToFetchApplies when pagination_type = FLEXIBLE |
hasMoreRowsSelector | string | No | data type=string; maxLen=255Applies when pagination_type is set | |
hasMoreRowsWhenValue | enum | Yes | equals | data type=string; maxLen=4000; lov=STATICValid values: isNotNull equalsApplies when pagination_type is set and has_more_rows_selector is set |
hasMoreRowsAttrValue | string | Yes | true | data type=string; maxLen=255Applies when pagination_type is set and has_more_rows_selector is set and has_more_rows_when_value = EQUALS |
totalRowsSelector | string | No | data type=string; maxLen=255Applies when pagination_type is set | |
pageTokenUrlParam | string | Yes | data type=string; maxLen=4000Applies when pagination_type = PAGE_TOKEN_FLEXIBLE_SIZE | |
nextPageTokenSelector | string | Yes | data type=string; maxLen=4000Applies when pagination_type = PAGE_TOKEN_FLEXIBLE_SIZE |
settings {
paginationType: pageSizeAndPageNo
pageSizeUrlParam: value
pageSizeMax: 42
pageNoUrlParam: value
indexOfFirstPage: "0"
fixedPageSize: 42
rowOffsetUrlParam: value
rowOffsetType: rowsToSkip
hasMoreRowsSelector: value
hasMoreRowsWhenValue: isNotNull
hasMoreRowsAttrValue: value
totalRowsSelector: value
pageTokenUrlParam: value
nextPageTokenSelector: value
}dataProfile
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
name | string | Yes | data type=string; maxLen=255 | |
format | enum | Yes | json | data type=string; lov=STATICValid values: csv json xml |
rowSelector | string | No | data type=string; maxLen=255 | |
containsSingleRow | boolean | Yes | false | data type=boolean |
singleRowSelector | string | No | data type=string; maxLen=255 | |
useRawSelectors | boolean | Yes | false | data type=boolean |
comments | multiline string | No | data type=multiline string; maxLen=4000 |
dataProfile {
name: value
format: csv
rowSelector: value
containsSingleRow: false
singleRowSelector: value
useRawSelectors: false
comments: ```
value
```
}source
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | data type=string; lov=PLUGINSValid values: http | |
remoteServer | reference | Yes | data type=reference; lov=COMPONENT; references=restDataSourceServer | |
remoteServer | reference | Yes | data type=reference; lov=COMPONENT; references=restEnabledSqlDatabase | |
urlPathPrefix | string | Yes | data type=string; maxLen=500 |
source {
type: http
remoteServer: @component
urlPathPrefix: value
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
encoding | enum | No | data type=string; lov=STATICValid 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 | |
numericChars | string | No | data type=string; maxLen=2 | |
xmlNamespaces | multiline string | No | data type=multiline string; maxLen=4000 | |
csvSeparator | string | No | data type=string; maxLen=5 | |
csvEnclosedBy | string | No | data type=string; maxLen=1 | |
skipRows | number | No | data type=number; maxLen=5 | |
firstLineContainsHeaders | boolean | Yes | true | data type=boolean |
staticId | string | Yes | data type=string; maxLen=255Use the Static ID to reference the REST Data Source in API Calls. | |
passEcid | string | No | data type=string; maxLen=32767 | |
httpTransferTimeout | integer | No | data type=integer; maxLen=32767 | |
openapiUrl | string | No | data 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
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
credentials | reference | No | data type=reference; lov=COMPONENT; references=webCredential | |
server | reference | No | data type=reference; lov=COMPONENT; references=authenticationServerApplies when credentials is set | |
urlPathPrefix | string | No | data type=string; maxLen=500Applies when credentials is set and server is set |
authentication {
credentials: @component
server: @component
urlPathPrefix: value
}synchronization
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
jobIsActive | boolean | Yes | false | data type=boolean |
localTableOwner | string | No | data type=string; maxLen=32767 | |
localTableName | string | No | data type=string; maxLen=128 | |
nestedRows | reference | No | data type=reference; lov=COMPONENT; references=dataProfileColumnApplies when localTableName is set | |
type | enum | Yes | append | data type=string; lov=STATICValid values: append merge fullRefreshDelete fullRefreshTruncateApplies when localTableName is set |
schedule | multiline string | No | data type=multiline string; maxLen=255Applies when localTableName is set | |
commitInterval | integer | No | data type=integer; maxLen=32767Applies when localTableName is set | |
httpRequestLimit | integer | No | data type=integer; maxLen=32767Applies when localTableName is set |
synchronization {
jobIsActive: false
localTableOwner: value
localTableName: value
nestedRows: @component
type: append
schedule: ```
value
```
commitInterval: 42
httpRequestLimit: 42
}synchronizationRateLimit
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
timeframe | integer | No | data type=integer; maxLen=32767Applies when localTableName is set | |
httpRequests | integer | Yes | data type=integer; maxLen=32767Applies when localTableName is set and timeframe is set | |
whenExceeded | enum | Yes | raiseError | data type=string; lov=STATICValid values: raiseError waitApplies when localTableName is set and timeframe is set |
synchronizationRateLimit {
timeframe: 42
httpRequests: 42
whenExceeded: raiseError
}invocationScope
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | No | data type=string; lov=STATICValid values: staticValue item sqlQuery expression functionBodyApplies when credentials is set | |
text | multiline string | Yes | data type=multiline string; maxLen=32767Applies when credentials is set and type = staticValue | |
item | string | Yes | data type=string; maxLen=255; textCase=UPPERApplies when credentials is set and type = staticValue | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when credentials is set and type = sqlQuery | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when credentials is set and type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when credentials is set and type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when credentials is set and type = functionBody and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when credentials is set and type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when credentials is set and type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when credentials is set and type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when credentials 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
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
name | string | No | data type=string; maxLen=32767 | |
service | string | No | data type=string; maxLen=32767 | |
version | string | No | data type=string; maxLen=32767 |
restSourceCatalog {
name: value
service: value
version: value
}subscription
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
master | reference | No | data type=reference; lov=COMPONENT; references=restDataSource |
subscription {
master: @component
}comments
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
comments | multiline string | No | data type=multiline string; maxLen=4000 |
comments {
comments: ```
value
```
}APEXlang Example
restDataSource sample (
name: value
settings {
paginationType: pageSizeAndPageNo
pageSizeUrlParam: value
pageSizeMax: 42
pageNoUrlParam: value
indexOfFirstPage: "0"
fixedPageSize: 42
rowOffsetUrlParam: value
rowOffsetType: rowsToSkip
hasMoreRowsSelector: value
hasMoreRowsWhenValue: isNotNull
hasMoreRowsAttrValue: value
totalRowsSelector: value
pageTokenUrlParam: value
nextPageTokenSelector: value
}
dataProfile {
name: value
format: csv
rowSelector: value
containsSingleRow: false
singleRowSelector: value
useRawSelectors: false
comments: ```
value
```
}
source {
type: http
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
```
}
)