Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterTypeDefaultDescriptionConfiguration selection
limitinteger10The number of records to fetch.Selector, Number
orderobject-A dictionary of key-value pairs describing the field(s) for sorting. The field name is the key and the value is set to either -1 for ascending order or 1 for descending order.Selector, Object
pageinteger1Starting page number.Selector, Number
per_pageinteger10Results per page.Selector, Number
selobject-A dictionary of key-value pairs describing which fields to include in the query results. The field name is the key and the value is set to 1.Selector, Object
skipinteger-The number of records to skip.Selector, Number
unselobject-A dictionary of key-value pairs describing which fields to exclude from the query results. The field name is the key and the value is set to 1.Selector, Object
wherestring-JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value.Selector, String

...

ParameterTypeDefaultDescriptionConfiguration selection
fieldstring-The field must be distinct.Selector, String
limitinteger10The number of records to fetch.Selector, Number
orderobject-A dictionary of key-value pairs describing the field(s) for sorting. The field name is the key and the value is set to either -1 for ascending order or 1 for descending order.Selector, Object
pagenumber1Starting page number.Selector, Number
per_pageinteger10Results per page.Selector, Number
selobject-A dictionary of key-value pairs describing which fields to include in the query results. The field name is the key and the value is set to 1.Selector, Object
skipinteger-The number of records to skip.Selector, Number
unselobject-A dictionary of key-value pairs describing which fields to exclude from the query results. The field name is the key and the value is set to 1.Selector, Object
wherestring-JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value.Selector, String

...

ParameterTypeDefaultDescriptionConfiguration selection
dataobject--Selector, Object
argsobject-Optional parameters.Selector, Object
limitinteger10The number of records to fetch.Selector, Number
orderobject-A dictionary of key-value pairs describing the field(s) for sorting. The field name is the key and the value is set to either -1 for ascending order or 1 for descending order.Selector, Object
pageinteger1Starting page number.Selector, Number
per_pageinteger10Results per page.Selector, Number
selobject-A dictionary of key-value pairs describing which fields to include in the query results. The field name is the key and the value is set to 1.Selector, Object
skipinteger-The number of records to skip.Selector, Number
unselobject-A dictionary of key-value pairs describing which fields to exclude from the query results. The field name is the key and the value is set to 1.Selector, Object
wherestring-JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value.Selector, String

...

ParameterTypeDefaultDescriptionJSONPathConfiguration selections
idany--$.params.idSelector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeDefaultDescriptionConfiguration selection
limitinteger10The number of records to fetch.Selector, Number
orderobject-A dictionary of key-value pairs describing the field(s) for sorting. The field name is the key and the value is set to either -1 for ascending order or 1 for descending order.Selector, Object
pageinteger-Starting page number.Selector, Number
per_pageinteger10Results per page.Selector, Number
selobject-A dictionary of key-value pairs describing which fields to include in the query results. The field name is the key and the value is set to 1.Selector, Object
skipinteger-The number of records to skip.Selector, Number
unselobject-A dictionary of key-value pairs describing which fields to exclude from the query results. The field name is the key and the value is set to 1.Selector, Object
wherestring-JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value.Selector, String

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany1The input to test.Selector, String, Number, Boolean, Object, Array, Null
valueany1The value to test input against.Selector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany-The input to test.Selector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany1The input to test.Selector, String, Number, Boolean, Object, Array, Null
valueany1The value to test input against.Selector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany1The input to test.Selector, String, Number, Boolean, Object, Array, Null
valueany1The value to test input against.Selector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany1The input to test.Selector, String, Number, Boolean, Object, Array, Null
valueany1The value to test input against.Selector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany1The input to test.Selector, String, Number, Boolean, Object, Array, Null
valueany1The value to test input against.Selector, String, Number, Boolean, Object, Array, Null

...

ParameterTypeDefaultDescriptionConfiguration selection
delayinteger-The length of delay, in milliseconds.Selector, Number

...

ParameterTypeMinimumMaximumDescriptionConfiguration selection
statusinteger100599-Selector, Number
bodyany---Selector, String, Number, Boolean, Object, Array, Null
headersobject---Selector, Object

The body and headers parameters can be enabled or disabled.

...

ParameterTypeDefaultDescriptionConfiguration selection
valueany--Selector, String, Number, Boolean, Object, Array, Null

...

OutputTypeDescriptionSave output value as:
nextany--

Custom flow-nodes

Custom flow-nodes which are not built into the API Builder Console can be created and installed. Axway provides three custom flow-nodes with new projects and more planned for the future. The custom flow-node handlers are created and their methods, parameters, and outputs are defined using the Axway Flow SDK. For additional information, see Axway Flow SDK.

...