parameter

Parent: restDataSource

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
operationreferenceNodata type=reference; lov=COMPONENT; references=operation

Property Groups:

  • parameter
  • value
  • validation
  • multipleValues
  • advanced
  • comments
parameter
PropertyTypeRequiredDefault ValueDetails
typeenumYesurlPatterndata type=string; lov=STATIC
Valid values: urlPattern urlQueryString httpHeader dataProfileColumn requestOrResponseBody httpStatusCode httpReasonPhrase httpCookie
dataTypeenumYesstringdata type=string; lov=STATIC
Valid values: string numeric date timestamp timestampWithTimeZone boolean binary
Applies whentype in (httpHeader)type in (httpCookie)type in (urlPattern)type in (urlQueryString)type in (requestOrResponseBody)
directionenumYesindata type=string; lov=STATIC
Valid values: in out inOut
omitWhenValueIsEmptybooleanYesfalsedata type=boolean
Applies whentype in (httpHeader) and type in (urlPattern) and static = falsetype in (httpHeader) and type in (urlQueryString) and static = falsetype in (httpHeader) and type in (requestOrResponseBody) and static = falsetype in (httpHeader) and static = falsetype in (httpHeader) and type in (httpCookie) and static = falsetype in (httpCookie) and type in (urlPattern) and static = falsetype in (httpCookie) and type in (urlQueryString) and static = falsetype in (httpCookie) and type in (requestOrResponseBody) and static = falsetype in (httpCookie) and type in (httpHeader) and static = falsetype in (httpCookie) and static = falsetype in (urlQueryString) and type in (urlPattern) and static = falsetype in (urlQueryString) and static = falsetype in (urlQueryString) and type in (requestOrResponseBody) and static = falsetype in (urlQueryString) and type in (httpHeader) and static = falsetype in (urlQueryString) and type in (httpCookie) and static = false
parameter {
  type: urlPattern
  dataType: string
  direction: in
  omitWhenValueIsEmpty: false
}
value
PropertyTypeRequiredDefault ValueDetails
formatMaskstringNodata type=string; maxLen=255
Applies whentype in (httpHeader) and dataType in (boolean)type in (httpHeader) and dataType in (numeric)type in (httpHeader) and dataType in (date)type in (httpHeader) and dataType in (timestamp)type in (httpHeader) and dataType in (timestampWithTimeZone)type in (httpCookie) and dataType in (boolean)type in (httpCookie) and dataType in (numeric)type in (httpCookie) and dataType in (date)type in (httpCookie) and dataType in (timestamp)type in (httpCookie) and dataType in (timestampWithTimeZone)type in (urlPattern) and dataType in (boolean)type in (urlPattern) and dataType in (numeric)type in (urlPattern) and dataType in (date)type in (urlPattern) and dataType in (timestamp)type in (urlPattern) and dataType in (timestampWithTimeZone)type in (urlQueryString) and dataType in (boolean)type in (urlQueryString) and dataType in (numeric)type in (urlQueryString) and dataType in (date)type in (urlQueryString) and dataType in (timestamp)type in (urlQueryString) and dataType in (timestampWithTimeZone)type in (requestOrResponseBody) and dataType in (boolean)type in (requestOrResponseBody) and dataType in (numeric)type in (requestOrResponseBody) and dataType in (date)type in (requestOrResponseBody) and dataType in (timestamp)type in (requestOrResponseBody) and dataType in (timestampWithTimeZone)
staticbooleanYesfalsedata type=boolean
Applies whentype in (urlPattern)type in (urlQueryString)type in (requestOrResponseBody)type in (httpHeader)type in (httpCookie)
defaultValueTypeenumNodata type=string; lov=STATIC
Valid values: staticValue item sqlQuery expression functionBody
staticValuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = staticValue
itemstringYesdata type=string; maxLen=255; textCase=UPPER
Applies whendefaultValueType = item
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = sqlQuery
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whendefaultValueType = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = functionBody and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whendefaultValueType = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whendefaultValueType = expression and language = javaScript-mle
value {
  formatMask: value
  static: false
  defaultValueType: staticValue
  staticValue: ```
    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
  ```
}
validation
PropertyTypeRequiredDefault ValueDetails
requiredbooleanYesfalsedata type=boolean
Applies whentype in (urlPattern) and static = falsetype in (urlQueryString) and static = falsetype in (requestOrResponseBody) and static = falsetype in (httpHeader) and static = falsetype in (httpCookie) and static = false
regexPatternstringNodata type=string; maxLen=255
Applies whentype in (httpHeader) and dataType = stringtype in (httpCookie) and dataType = stringtype in (urlPattern) and dataType = stringtype in (urlQueryString) and dataType = stringtype in (requestOrResponseBody) and dataType = string
validation {
  required: false
  regexPattern: value
}
multipleValues
PropertyTypeRequiredDefault ValueDetails
multipleValuesbooleanYesfalsedata type=boolean
Applies whentype = urlQueryString and type in (httpHeader) and type in (urlPattern) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpHeader) and type in (urlQueryString) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpHeader) and type in (requestOrResponseBody) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpHeader) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpHeader) and type in (httpCookie) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpCookie) and type in (urlPattern) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpCookie) and type in (urlQueryString) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpCookie) and type in (requestOrResponseBody) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpCookie) and type in (httpHeader) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (httpCookie) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (urlQueryString) and type in (urlPattern) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (urlQueryString) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (urlQueryString) and type in (requestOrResponseBody) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (urlQueryString) and type in (httpHeader) and static = false and omitWhenValueIsEmpty = truetype = urlQueryString and type in (urlQueryString) and type in (httpCookie) and static = false and omitWhenValueIsEmpty = true
separatorstringNodata type=string; maxLen=5
Applies whentype = urlQueryString and type in (httpHeader) and type in (urlPattern) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpHeader) and type in (urlQueryString) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpHeader) and type in (requestOrResponseBody) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpHeader) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpHeader) and type in (httpCookie) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpCookie) and type in (urlPattern) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpCookie) and type in (urlQueryString) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpCookie) and type in (requestOrResponseBody) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpCookie) and type in (httpHeader) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (httpCookie) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (urlQueryString) and type in (urlPattern) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (urlQueryString) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (urlQueryString) and type in (requestOrResponseBody) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (urlQueryString) and type in (httpHeader) and static = false and omitWhenValueIsEmpty = true and multipleValues = truetype = urlQueryString and type in (urlQueryString) and type in (httpCookie) and static = false and omitWhenValueIsEmpty = true and multipleValues = true
Enter the separator character to use for splitting up the value. If empty, values will be separated by the colon character (":").
multipleValues {
  multipleValues: false
  separator: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
useForRowSearchbooleanYesfalsedata type=boolean
Applies whentype in (urlPattern) and static = falsetype in (urlQueryString) and static = falsetype in (requestOrResponseBody) and static = falsetype in (httpHeader) and static = falsetype in (httpCookie) and static = false
staticIdstringYesdata type=string; maxLen=255
advanced {
  useForRowSearch: false
  staticId: value
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

parameter sample (
    name: value
    operation: @component
    parameter {
        type: urlPattern
        dataType: string
        direction: in
        omitWhenValueIsEmpty: false
    }
    value {
        formatMask: value
        static: false
        defaultValueType: staticValue
        staticValue: ```
          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
        ```
    }
    validation {
        required: false
        regexPattern: value
    }
    multipleValues {
        multipleValues: false
        separator: value
    }
    advanced {
        useForRowSearch: false
        staticId: value
    }
    comments {
        comments: ```
          value
        ```
    }
)