debug
Add Debugging Information
|
Setting to true will add a number of properties to either the context (in the Query case) or the document (in the indexing case)
type: boolean
default value: 'false '
|
errorHandling
Error Handling
|
type: string
default value: 'ignore '
enum: {
ignore
error
map
}
|
hasNoSideEffects
Run in simulation mode
|
To run this stage in simulation mode, set to 'true'.
type: boolean
default value: 'false '
|
mappingRules
Mapping of Returned Values (as XPath Expressions) to Context, Request or Response Values
|
type: array of object
object attributes: {
append
: {
display name: Append to Existing Values in Target Location. Only Valid when the Target Location is 'Request'
type: boolean
default value: 'false '
}
path
(required)
: {
display name: XPath Expression
type: string
}
target
(required)
: {
display name: Target Key
type: string
}
targetLocation
: {
display name: Target Location
type: string
default value: 'Request '
enum: {
Request
Response
Context
}
}
xml
: {
display name: Add as an XML Fragment
type: boolean
default value: 'false '
}
}
|
params
Call Parameters
required
|
type: object
object attributes: {
entity
: {
display name: Request entity (as string)
type: string
}
headers
: {
display name: Request protocol headers
type: object
}
method
: {
display name: Call method
type: string
description : One of GET, POST, PUT, or DELETE
enum: {
get
put
post
delete
}
}
queryParams
: {
display name: Query parameters
type: object
}
uri
: {
display name: Endpoint URI
type: string
}
}
|
resultsKey
Results Key
required
|
The name of the key to store the results object under. See the documentation for the type of objects stored.
type: string
default value: 'queryRPC '
|
resultsLocation
Results Location
|
If As Response is chosen, then the result of the RPC call will be the one and only response. In all other cases, the stage will put the response from the REST/RPC call into the target location using the resultsKey.
type: string
default value: 'Request '
enum: {
Request
Response
Context
As Response
}
|
useIncomingRequestEntity
Use the Incoming Request Entity
|
If an input entity is POSTed or PUT from the client, we can pass that along to the RPC target.
type: boolean
default value: 'false '
|