Connections

Each Nintex Apps connection is represented by a JSON file with following properties.

Field Name	Type	Description
authentication	String	Relates to the Authentication Method of the connection
authRequestBody	JSON Object	Relates to the Authentication Request Body property. Available if Separate Authentication URL is selected as the authentication method.
authRequestBodyContentType	JSON Object	Relates to the Authentication Request Body Content Type property. Available if Separate Authentication URL is selected as the authentication method. null until set.
authRequestHeaders	JSON Object	Relates to the Auth Request Headers property. Available if Separate Authentication URL is selected as the authentication method
authRequestVerb	String	The HTTP request method used for the authentication request, which can be configured if Separate Authentication URL is selected as the authentication method
authUrl	String	The URL which the connection send its authentication to if Separate Authentication URL is selected as the authentication method. Relates to the Authentication URL property. null until set.
config	JSON Object	Additional configurations—which vary based on connector—stored as key-value pairs (If available on the connection, relates to the Custom Configuration property)
credentialSource	String	Relates to the Credential source property, available if Basic HTTP Authentication is used for the authentication method
name	String	The name of the connection
requestBodyParameters	JSON Object	Relates to the connection's Body parameters to include with every request > Common Request Body Data property
requestHeaders	JSON Object	An object of key-value pairs used as headers for all requests sent to this connection's external system. Relates to the connection's Headers to send with every request > Common Request Headers property.
requestUrlParameters	JSON Object	Relates to the connection's URL Parameters to send with every request > Common URL Parameters property
objects	Array	An array of JSON objects, which represent the connections created within the connection
type	String	The connector used to create this connection
url	String	The base URL for all requests sent to the external system
useProxy	Boolean	Determines if Nintex Apps will use its proxy—whether on Nintex Apps or Apex—to make requests to the connection

config Objects

Field Name	Type	Description
odata-version	String	The OData version selected for the connection
ssl	Boolean	Determines whether or not SSL is configured for this connection
ssl-ca	String	Relates to the Server CA property
ssl-cert	String	Relates to the Client Certificate property
ssl-key	String	Relates to the Client Key property
supports-batch	Boolean	Determines whether or not Nintex Apps will attempt batch requests to the external system

object Objects

These JSON objects represent individual connections

Each connection is represented as a JSON object, typically made up of the following fields:

Field Name	Type	Description
batchable	Boolean	Correlates to the Request data in the same transfer as other Models property
conditionsLogic	String	The grouping logic of the object's conditions
fields	Array	An array of JSON field objects, each representing a single field in theconnection

field Objects

Field Name	Type	Description
displayType	String	Relates to the Display Type property
filterable	Boolean	Relates to the Filterable property
groupable	Boolean	Relates to the Groupable property
isIdField	Boolean	Relates to the Id Field property
isNameField	Boolean	Relates to the Name Field property
label	String	Relates to the Label property
name	String	Relates to the Name property
precision	Number	The number of digits to the left of the decimal point (only applicable to number fields)
required	Boolean	Determines whether or not a value must be present for this field in order for the model to save
scale	Number	The number of digits to the right of the decimal point (only applicable to number fields)
sortable	Boolean	Relates to the Sortable property