operation - APEXlang Reference

`operation`

Parent: restDataSource

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	No		data type=`string`; maxLen=255 Enter a name of the REST Operation.
`label`	`string`	No		data type=`string`; maxLen=255 Display label for the REST Operation.

Property Groups:

operation

Property	Type	Required	Details
`urlPattern`	`string`	Yes	data type=`string`; maxLen=500
`httpMethod`	`enum`	Yes	data type=`string`; lov=`STATIC` Valid values: `get` `post` `put` `delete` `patch`
`databaseOperation`	`enum`	No	data type=`string`; lov=`STATIC` Valid values: `fetchRows` `fetchSingleRow` `insert` `update` `delete`

operation {
  urlPattern: value
  httpMethod: get
  databaseOperation: fetchRows
}

requestBody

Property	Type	Required	Default Value	Details
`template`	`multiline string`	No		data type=`multiline string`; maxLen=32760
`versionNumber`	`enum`	Yes	`2`	data type=`string`; lov=`STATIC` Valid values: `1` `2`

requestBody {
  template: ```
    value
  ```
  versionNumber: "1"
}

dataProfile

Property	Type	Required	Default Value	Details
`nestedRows`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`dataProfileColumn`

dataProfile {
  nestedRows: @component
}

remoteCache

Property	Type	Required	Default Value	Details
`caching`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `allUsers` `user` `session` Applies when`httpMethod in (get) and databaseOperation in (fetchRows)httpMethod in (get) and databaseOperation in (fetchSingleRow)httpMethod in (post) and databaseOperation in (fetchRows)httpMethod in (post) and databaseOperation in (fetchSingleRow)` Select how the Oracle APEX engine can cache REST Source responses on the server side. If caching can be used, the component will be rendered based on cached results instead of fetching from the REST service again. Only HTTP "GET" or "POST" requests that fetch data will be cached, which will cut down expensive HTTP requests. This feature is unrelated to the browser's caching capabilities.
`timeout`	`multiline string`	No		data type=`multiline string`; maxLen=255 Applies when`httpMethod in (get) and databaseOperation in (fetchRows) and caching is sethttpMethod in (get) and databaseOperation in (fetchSingleRow) and caching is sethttpMethod in (post) and databaseOperation in (fetchRows) and caching is sethttpMethod in (post) and databaseOperation in (fetchSingleRow) and caching is set`

remoteCache {
  caching: allUsers
  timeout: ```
    value
  ```
}

advanced

Property	Type	Required	Default Value	Details
`fixedPageSize`	`integer`	No		data type=`integer`; maxLen=32767
`allowFetchingAllRows`	`boolean`	Yes	`false`	data type=`boolean` Applies when`databaseOperation = fetchRows`
`fetchAllRowsTimeout`	`integer`	No		data type=`integer`; maxLen=32767 Applies when`databaseOperation = fetchRows and allowFetchingAllRows = true`
`forceRaiseHttp404Error`	`boolean`	Yes	`false`	data type=`boolean` Applies when`databaseOperation = fetchRows`
`staticId`	`string`	No		data type=`string`; maxLen=255

advanced {
  fixedPageSize: 42
  allowFetchingAllRows: false
  fetchAllRowsTimeout: 42
  forceRaiseHttp404Error: false
  staticId: value
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

operation sample (
    name: value
    label: value
    operation {
        urlPattern: value
        httpMethod: get
        databaseOperation: fetchRows
    }
    requestBody {
        template: ```
          value
        ```
        versionNumber: "1"
    }
    dataProfile {
        nestedRows: @component
    }
    remoteCache {
        caching: allUsers
        timeout: ```
          value
        ```
    }
    advanced {
        fixedPageSize: 42
        allowFetchingAllRows: false
        fetchAllRowsTimeout: 42
        forceRaiseHttp404Error: false
        staticId: value
    }
    comments {
        comments: ```
          value
        ```
    }
)