Versions Compared

Key

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

...

PropertyDescription
loadPath (required)Denotes the path (relative to webserver root) where the webservice is located. It can contain variable names in the form of ${variableName}. JSON connector will replace that name for the actual value. Eventually, complex expressions can be written in, but it's discouraged
loadMethod (required)Denotes the HTTP method to use: PUT, POST, GET and DELETE are allowed
loadParams (required)Put the character '-' in case you would avoid its value
loadCheck (optional)Denotes a script that will check wether the invokation has been successful or not. Each json attribute received from target web service will be available as context variables
loadResults (optional)

But highly recommended) denotes the json portion that containes current data for the user. It this element is not present, or empty, the connector will conclude the user does not exist yet. This property will contain a simple json attribute name, but complex scripts are also allowed

loadHeader (optional)Optional HTTP header(s) to send. More than one header can be sent by adding multiple propertis .....Header1, .Header2, and so on

...

PropertyDescription
deletePath (required)Denotes the path (relative to webserver root) where the webservice is located
deleteMethod (required)Denotes the HTTP method to use: PUT, POST, GET and DELETE are allowed
deleteEncoding (optional)Denotes the encoding used to send to the target webservice. application/json and application/x-www-form-urlencoded are supported. The first one is used by default to POST and PUT requests. The second one is used by default for GET and DELETE requests
deleteCheck (optional)Denotes a script that will check wether the invokation has been successful or not. Each json attribute received from target web service will be available as context variables
deleteHeader (optional)Optional HTTP header(s) to send. More than one header can be sent by adding multiple propertis .....Header1, .Header2, and so on
deleteParams (optional)Type in the attributes that will be sent to the rest server. If this property is not set, all attributes will be sent.
preventDeletion (required)Set to false to enable delete method

 

How to retrieve data from the response with the *Results properties

a) One level

No Format
If the JSON has one level you have to avoid the property
{
    "userName" : "soffid"
}

b) Two level

No Format
If the JSON has two levels you have to create the property *Result and put the name of the parent attribute, for example:
{
    "user" : {    
        "userName" : "soffid"
    }
}
And the property must be for example loadResults = user

c) More than two levels

No Format
If the JSON has more than two levels you have to create the property *Result and put the atributes in the next pattern

*Results = attribure1{"attribute2"}{"attribute3"}...

For example:
{
	"data" : {
        "user" : {    
            "userName" : {
                "string" : "soffid"
            }
        }
    }
}

And the property must be for example:

loadResults = data{"user"}{"userName"}

 

Attributes

You may map the attributes of the target system with the Soffid available attributes.

...