Support for API Builder 3.x will cease on 30 April 2020. Use the v3 to v4 upgrade guide to migrate all your applications to API Builder 4.x. Contact support@axway.com if you require migration assistance. |
The examples and configuration information in this topic use a model named simpleuser with the default endpoints generated. |
The API Orchestration user interface is accessed from the APIs List page on the API Builder Console by selecting a Flow icon or a Create Flow icon for a generated or imported endpoint depending upon the current endpoint status. The API Orchestration user interface is divided into the following panels:
This topic is divided into the following sections:
The Model flow-node methods, parameters, and outputs are described in the following sections.
The method selections for a Model flow-node are:
count
- Gets a count of records.create
- Creates a new model object.delete
- Deletes the model object.deleteAll
- Deletes all the model objects.distinct
- Finds unique values using the provided field.findAll
- Finds all model instances.findAndModify
- Finds one model instance and modifies it.findByID
- Finds model instance by ID.query
- Queries for particular model records.update
- Updates a model instance.upsert
- Creates a model record if not found, or updates the model record if found.The Model flow-node parameters are described in the following sections.
The count
method parameters are:
Parameter | Type | Default | Description | Configuration selection |
---|---|---|---|---|
limit | integer | 10 | The number of records to fetch. | Selector, Number |
order | object | - | 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 |
page | integer | 1 | Starting page number. | Selector, Number |
per_page | integer | 10 | Results per page. | Selector, Number |
sel | object | - | 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 |
skip | integer | - | The number of records to skip. | Selector, Number |
unsel | object | - | 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 |
where | string | - | The JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value. | Selector, String |
All parameters can be enabled or disabled.
The create
method parameter is:
Parameter | Type | Configuration selection |
---|---|---|
data | object | Selector, Object |
The delete
method parameter is:
Parameter | Type | Configuration selection |
---|---|---|
id | any | Selector, String, Number, Boolean, Object, Array, Null |
There are no configurable deleteAll
method parameters.
The distinct
method parameters are:
Parameter | Type | Default | Description | Configuration selection |
---|---|---|---|---|
field | string | - | The field must be distinct. | Selector, String |
limit | integer | 10 | The number of records to fetch. | Selector, Number |
order | object | - | 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 |
page | number | 1 | Starting page number. | Selector, Number |
per_page | integer | 10 | Results per page. | Selector, Number |
sel | object | - | 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 |
skip | integer | - | The number of records to skip. | Selector, Number |
unsel | object | - | 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 |
where | string | - | The JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value. | Selector, String |
The limit
, order
, page
, per_page
, sel
, skip
, unsel
, and where
parameters can be enabled or disabled.
There are no configurable findAll
method parameters.
The findAndModify
method parameters are:
Parameter | Type | Default | Description | Configuration selection |
---|---|---|---|---|
data | object | - | - | Selector, Object |
args | object | - | Optional parameters. | Selector, Object |
limit | integer | 10 | The number of records to fetch. | Selector, Number |
order | object | - | 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 |
page | integer | 1 | Starting page number. | Selector, Number |
per_page | integer | 10 | Results per page. | Selector, Number |
sel | object | - | 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 |
skip | integer | - | The number of records to skip. | Selector, Number |
unsel | object | - | 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 |
where | string | - | The JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value. | Selector, String |
The args
, limit
, order
, page
, per_page
, sel
, skip
, unsel
, and where
parameters can be enabled or disabled.
The findByID
method parameter is:
Parameter | Type | Default | Description | JSONPath | Configuration selections |
---|---|---|---|---|---|
id | any | - | - | $.params.id | Selector, String, Number, Boolean, Object, Array, Null |
The query
method parameters are:
Parameter | Type | Default | Description | Configuration selection |
---|---|---|---|---|
limit | integer | 10 | The number of records to fetch. | Selector, Number |
order | object | - | 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 |
page | integer | - | Starting page number. | Selector, Number |
per_page | integer | 10 | Results per page. | Selector, Number |
sel | object | - | 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 |
skip | integer | - | The number of records to skip. | Selector, Number |
unsel | object | - | 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 |
where | string | - | The JSON-encoded object specifying field constraints. The field name is the key and the value is the constraint statement or value. | Selector, String |
All parameters can be enabled or disabled.
The update
method parameters are:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
data | object | Dependent on configured model fields. | Selector, Object |
id | any | - | Selector, String, Number, Boolean, Object, Array, Null |
The upsert
method parameter is:
Parameter | Type | Configuration selections |
---|---|---|
data | object | Selector, Object |
The Model flow-node outputs are described in the following sections.
The count
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | number | Successfully counted records of simpleuser. | $.count |
The create
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | object | Successfully created a simpleuser. | $.model |
The delete
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | object | Successfully deleted the simpleuser. | $.delete |
notfound | any | No model instance found. | - |
The deleteAll
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | array | Successfully deleted all the simpleusers. | - |
The distinct
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | array | Successfully found all unique values of simpleuser. | $.models |
The findAll
method output is:
Outputs | Type | Description | Save output value as: |
---|---|---|---|
next | array | Successfully found all simpleusers. | $.models |
The findAndModity
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | object | Successfully found and modified simpleuser. | $.model |
notfound | any | No matching model found. | - |
The findByID
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | object | Successfully found instance of simpleuser by ID. | $.model |
notfound | any | No model instance found. | - |
The query
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | array | Successfully queried the simpleuser. | $.models |
The update
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | object | Successfully updated the simpleuser. | $.model |
notfound | any | No model instance found. | - |
The upsert
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
update | object | Successfully updated the model. | $.model |
insert | object | Successfully inserted the model. | $.model |
The Codeblock flow-node methods, parameters, and outputs for the Greet Codeblock flow-node are described in the following sections. Each method in a Codeblock flow-node corresponds to a single codeblock. The Greet Codeblock flow-node is created when a new application is created, but it can be deleted.
The default method for the Greet Codeblock flow-node is:
Greet
- Some codeblock to run with the greet flow.The Greet
method parameter is:
Parameter | Type | Configuration selection |
---|---|---|
| string | Selector, String |
The Greet method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
| string | The codeblock completed. |
|
| object | The codeblock failed to complete. |
|
The Condition flow-node methods, parameters, and outputs are described in the following sections.
The default methods for a Condition flow-node are:
equals
- Tests is a value is equal.exists
- Tests does a value exists, true or false.greater-than
- Tests is a value is greater than another value.greater-than-equal
- Tests is a value is greater than or equal to another value.less-than
- Tests is a value is less than another value.less-than-equal
- Tests is a value is less than or equal to another value.The Condition parameters are described in the following sections.
The equals
method parameters are:
Parameter | Type | Minimum length | Description | Configuration selection |
---|---|---|---|---|
source | any | 1 | The input to test. | Selector, String, Number, Boolean, Object, Array, Null |
value | any | 1 | The value to test input against. | Selector, String, Number, Boolean, Object, Array, Null |
The exists
method parameter is:
Parameter | Type | Minimum length | Description | Configuration selection |
---|---|---|---|---|
source | any | - | The input to test. | Selector, String, Number, Boolean, Object, Array, Null |
The greater-than
method parameters are:
Parameter | Type | Minimum length | Description | Configuration selection |
---|---|---|---|---|
source | any | 1 | The input to test. | Selector, String, Number, Boolean, Object, Array, Null |
value | any | 1 | The value to test input against. | Selector, String, Number, Boolean, Object, Array, Null |
The greater-than-equal
method parameters are:
Parameter | Type | Minimum length | Description | Configuration selection |
---|---|---|---|---|
source | any | 1 | The input to test. | Selector, String, Number, Boolean, Object, Array, Null |
value | any | 1 | The value to test input against. | Selector, String, Number, Boolean, Object, Array, Null |
The less-than
method parameters are:
Parameter | Type | Minimum length | Description | Configuration selection |
---|---|---|---|---|
source | any | 1 | The input to test. | Selector, String, Number, Boolean, Object, Array, Null |
value | any | 1 | The value to test input against. | Selector, String, Number, Boolean, Object, Array, Null |
The less-than-equal
method parameters are:
Parameter | Type | Minimum length | Description | Configuration selection |
---|---|---|---|---|
source | any | 1 | The input to test. | Selector, String, Number, Boolean, Object, Array, Null |
value | any | 1 | The value to test input against. | Selector, String, Number, Boolean, Object, Array, Null |
The Condition flow-node outputs are described in the following sections.
The equals
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
true | boolean | The condition tested true. | $.equals |
false | boolean | The condition tested false. | $.equals |
The exists
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
true | boolean | The condition tested true. | $.exists |
false | boolean | The condition tested false. | $.exists |
The greater-than
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
true | boolean | The condition tested true. | $.greaterThan |
false | boolean | The condition tested false. | $.greaterThan |
The greater-than-equal
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
true | boolean | The condition tested true. | $.greaterThanEqual |
false | boolean | The condition tested false. | $.greaterThanEqual |
The greater-than-equal
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
true | boolean | The condition tested true. | $.lessThan |
false | boolean | The condition tested false. | $.lessThan |
The less-than-equal
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
true | boolean | The condition tested true. | $.lessThanEqual |
false | boolean | The condition tested false. | $.lessThanEqual |
The Delay flow-node method, parameter, and output are described in the following sections.
The method for a Delay flow-node is:
delay
- Wait for a certain amount of time before continuing to the next flow-node.The Delay flow-node parameter is described in the following section.
The delay
method parameter is:
Parameter | Type | Default | Description | Configuration selection |
---|---|---|---|---|
delay | integer | - | The length of delay, in milliseconds. | Selector, Number |
The Delay flow-node output is described in the following section.
The delay
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | integer | The delay is completed. | $.delayed |
The method for a HTTP flow-node is:
setHTTPResponse
The HTTP flow-node parameter is described in the following section.
The setHTTPResponse
method parameters are:
Parameter | Type | Minimum | Maximum | Description | Configuration selection |
---|---|---|---|---|---|
status | integer | 100 | 599 | - | Selector, Number |
body | any | - | - | - | Selector, String, Number, Boolean, Object, Array, Null |
headers | object | - | - | - | Selector, Object |
The body
and headers
parameters can be enabled or disabled.
The HTTP flow-node output is described in the following section.
The setHTTPResponse
method does not have any configurable outputs.
The Set Context flow-node method, parameter, and output are described in the following sections.
The method for a Set Context flow-node is:
setContext
The Set Context flow-node parameter is described in the following section.
The setContext
method parameter is:
Parameter | Type | Default | Description | Configuration selection |
---|---|---|---|---|
value | any | - | - | Selector, String, Number, Boolean, Object, Array, Null |
The Set Context flow-node output is described in the following section.
The setContext
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
next | any | - | - |
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.
The custom flow-nodes currently provided with a new project are:
The flow-node methods, parameters, output for the Base64 flow-node are described in the following sections. The Base64 flow-node is created when NPM installs the nodehandler-base64
code. The Base64 flow-node is included in the default application, but it can be removed.
The Base64 flow-node default methods are:
Decode
- Decodes base64 encoded data.Encode
- Encodes base64 data.The Base64 flow-node parameters are described in the following sections.
The Decode
method parameters are:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
| string | The date to decode. | Selector, String |
| string | Expected decoded data format. | Selector, String |
The as
parameter can be enabled or disabled.
The Encode
method parameter is:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
| any | The data to encode. | Selector, String, Number, Boolean, Object, Array, Null |
The Base64 flow-node outputs are described in the following sections.
The Decode
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
| string | The base64 decoded data. |
|
| any | - |
|
The Encode
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
| string | The base64 encoded data. |
|
The Compose flow-node methods, parameters, and outputs are described in the following sections. The Compose flow-node is created when NPM installs the nodehandler-dot
code. The Compose flow-node is included in the default application, but it can be removed.
The default methods for a Compose flow-node are:
Format object
- Compose an object by evaluating a template. The evaluated template is JSON parsed and so must be a valid JSON encoded string.Format string
- Compose a string by evaluating a template.The Compose flow-node parameters are described in the following sections.
The Format object
method parameters are:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
| object | The data to evaluate the template with. Use $ to access the entire context. | Selector, Object |
| string | The doT template. | Selector, String |
The Format string
method parameters are:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
data | object | The data to evaluate the template with. Use $ to access the entire context. | Selector, Object |
template | string | The doT template. | Selector, String |
The Compose flow-node outputs are described in the following sections.
The Format object
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
| any | - |
|
| any | This output is triggered if the evaluated template is not a valid JSON string. The output value is the error object. |
|
The Format string
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
| any | - |
|
| any | This output is triggered if the evaluated template is not valid. The output value is error object. |
|
The JSON flow-node methods, parameters, and output are described in the following sections. The JSON flow-node is created when NPM installs the nodehandler-json
code. The JSON flow-node is included in the default application, but it can be removed.
The default methods for a JSON flow-node are:
Parse
- The parse method parses a JSON string, constructing the JavaScript value or object described by the string.Stringify
- The stringify method converts a JavaScript value to a JSON string.The JSON flow-node parameters are described in the following sections.
The Parse
method parameter is:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
| string | The JSON string to parse. | Selector, String |
The Stringify
method parameters are:
Parameter | Type | Description | Configuration selection |
---|---|---|---|
| any | The value to convert to a JSON string. | Selector, String, Number, Boolean, Object, Array, Null |
| any | A string or number object that's used to insert white space into the output JSON string for readability purposes. If this is a number, it indicates the number of space characters to use as white space; this number is capped at 10. If this is a string, its maximum length is 10; the string is used as white space. If this parameter is not provided, no white space is used. | Selector, String, Number, Boolean, Object, Array, Null |
The space
parameter can be enabled or disabled.
The JSON flow-node outputs are described in the following sections.
The Parse
method outputs are:
Output | Type | Description | Save output value as: |
---|---|---|---|
| any | - |
|
| any | This output is triggered if the input is not a valid JSON string. The output value is the error object. |
|
The Stringify
method output is:
Output | Type | Description | Save output value as: |
---|---|---|---|
| string | - |
|