Versions Compared

Key

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

...

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:  

  • Flow-node list (left side of the API Orchestration user interface) - Provides a graphical listing of the Model and Core flow-nodes. The default Core flow-node types are: Custom, Codeblock, Compose, Condition, Delay, HTTP, JSON, and Set Context. A model flow-node is displayed for each configured model and an endpoint flow-node is displayed for each imported endpoint.
  • Flow editor (center of the API Orchestration user interface) - Provides a graphical space to view, edit, and create flows.
  • Flow-node configuration (right side of the API Orchestration user interface) - Provides the functionality to configure the Name, Method, Parameters, and Outputs of flow-nodes.

...

The count method parameters are:

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-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:

ParameterTypeConfiguration selection
dataobjectSelector, Object

delete parameters

The delete method parameter is:

ParameterTypeConfiguration selection
idanySelector, String, Number, Boolean, Object, Array, Null

deleteAll parameters

There are no configurable deleteAll method parameters.

...

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-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.

...

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-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.

...

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

query parameters

The query method parameters are:

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-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:

ParameterTypeDescriptionConfiguration selection
dataobjectDependent on configured model fields.Selector, Object
idany-Selector, String, Number, Boolean, Object, Array, Null

upsert parameters

The upsert method parameter is:

ParameterTypeConfiguration selections
dataobjectSelector, Object

Outputs

The Model flow-node outputs are described in the following sections.

...

The count method output is:

OutputTypeDescriptionSave output value as:
nextnumberSuccessfully counted records of simpleuser.$.count

create outputs

The create method output is:

OutputTypeDescriptionSave output value as:
nextobjectSuccessfully created a simpleuser.$.model

delete outputs

The delete method outputs are:

OutputTypeDescriptionSave output value as:
nextobjectSuccessfully deleted the simpleuser.$.delete
notfoundanyNo model instance found.-

deleteAll outputs

The deleteAll method output is:

OutputTypeDescriptionSave output value as:
nextarraySuccessfully deleted all the simpleusers.-

distinct outputs

The distinct method output is:

OutputTypeDescriptionSave output value as:
nextarraySuccessfully found all unique values of simpleuser.$.models

findAll outputs

The findAll method output is:

OutputsTypeDescriptionSave output value as:
nextarraySuccessfully found all simpleusers.$.models

findAndModify outputs

The findAndModity method outputs are:

OutputTypeDescriptionSave output value as:
nextobjectSuccessfully found and modified simpleuser.$.model
notfoundanyNo matching model found.-

findByID outputs

The findByID method outputs are:

OutputTypeDescriptionSave output value as:
nextobjectSuccessfully found instance of simpleuser by ID.$.model
notfoundanyNo model instance found.-

query outputs

The query method output is:

OutputTypeDescriptionSave output value as:
nextarraySuccessfully queried the simpleuser.$.models

update outputs

The update method outputs are:

OutputTypeDescriptionSave output value as:
nextobjectSuccessfully updated the simpleuser.$.model
notfoundanyNo model instance found.-

upsert outputs

The upsert method outputs are:

OutputTypeDescriptionSave output value as:
updateobjectSuccessfully updated the model.$.model
insertobjectSuccessfully inserted the model.$.model

Codeblock flow-node

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 Greet method outputs are:

OutputTypeDescriptionSave output value as:

next

stringThe codeblock completed.

$.greeting

error

objectThe codeblock failed to complete.

$.error

Condition flow-node

The Condition flow-node methods, parameters, and outputs are described in the following sections.

...

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

exists parameters

The exists method parameter is:

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

greater-than parameters

The greater-than method parameters are:

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

greater-than-equal parameters

...

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

less-than parameters

The less-than method parameters are:

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

less-than-equal parameters

...

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

Outputs

The Condition flow-node outputs are described in the following sections.

...

The equals method outputs are:

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.equals
falsebooleanThe condition tested false.$.equals

exists outputs

The exists method outputs are:

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.exists
falsebooleanThe condition tested false.$.exists

greater-than outputs

The greater-than method outputs are:

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.greaterThan
falsebooleanThe condition tested false.$.greaterThan

greater-than-equal outputs

The greater-than-equal method outputs are:

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.greaterThanEqual
falsebooleanThe condition tested false.$.greaterThanEqual

less-than outputs

The greater-than-equal method outputs are:

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.lessThan
falsebooleanThe condition tested false.$.lessThan

less-than-equal outputs

The less-than-equal method outputs are:

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.lessThanEqual
falsebooleanThe condition tested false.$.lessThanEqual

Delay flow-node

The Delay flow-node method, parameter, and output are described in the following sections.

...

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

Output

The Delay flow-node output is described in the following section.

...

The delay method output is:

OutputTypeDescriptionSave output value as:
nextintegerThe delay is completed.$.delayed

HTTP flow-node

Method

The method for a HTTP flow-node is:

...

The setHTTPResponse method parameters are:

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

Output

The Set Context flow-node output is described in the following section.

...

The setContext method output is:

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.

The custom flow-nodes currently provided with a new project are:

Anchor
Base64
Base64
Base64 flow-node

...

The Encode method output is:

OutputTypeDescriptionSave output value as:

Encoded

stringThe base64 encoded data.

$.b64data

Anchor
Compose
Compose
Compose flow-node

...

The Stringify method output is:

OutputTypeDescriptionSave output value as:

Next

string-

$.json