...
| Expand | ||
|---|---|---|
| ||
You need to have the full URL to the WSDL description, as described above, and the token. Basic authentication is also possible, the client will ask you to provide login information automatically. In this example we use  SoapUI will read the description and create example SOAP requests for all available services. Double-clicking on a request will open the following window, click on the green execute button to submit the request and a response will be shown.  |
| Expand | ||
|---|---|---|
| ||
You can create single requests by clicking on “New” and selecting “Request”, selecting the correct method and pasting the link to the service. When using POST requests, you need to specify the Body, selecting “raw” and “JSON” in the respective settings. All other tabs can be left to default values.  To import all available EFS Service-Layer REST services, you will need to download the RAML file (  The collections tab will now have a list of all available services on the EFS installation.
|
Filtering results with conditions
Requests with “ByCriteria” in their name have the possibility to filter results by condition. These conditions can be simple one to one comparisons and complex requests joined by an operator. All examples are based on the POST /panel/circles/listByCondition REST service, which returns a list of Portals groups (circles).
Comparison
This is the easiest request, it matches the items based on a single property of the item, in this case the circleType.
| Code Block |
|---|
{
"condition": {
"comparison": {
"variable": "circleType",
"operator": "EQUAL",
"value": "COMPANY_MANAGED"
}
}
} |
Possible operator values for comparison: EQUAL, UNEQUAL, LESS_EQUAL, LESS_THAN, GREATER_EQUAL, GREATER_THAN, CONTAINS. Greater/smaller operators should only be applied to numeric values.
InComparison
This request allows comparison of a property to a list of acceptable values.
| Code Block |
|---|
{
"condition": {
"inComparison": {
"variable": "circleType",
"operator": "IN",
"value": [
"COMPANY_MANAGED",
"USER_MANAGED"
]
}
}
} |
The only acceptable operator value for inComparison is IN.
Join
This type allows more complex requests, allowing two conditions (comparison, inComparison or join) to be joined by an AND or OR operator.
| Code Block |
|---|
{
"condition": {
"join": {
"operator": "AND",
"condition1": {
"comparison": {
"variable": "title",
"operator": "CONTAINS",
"value": "Test"
}
},
"condition2": {
"inComparison": {
"variable": "circleType",
"operator": "IN",
"value": [
"COMPANY_MANAGED",
"USER_MANAGED"
]
}
}
}
}
} |
The operator for joining two or more conditions can be AND, OR, the individual conditions are similarly structured as their single instances. Since join is an acceptable condition, more complex structures are allowed:
| Code Block | ||
|---|---|---|
| ||
{
"condition": {
"join": {
"operator": "AND",
"condition1": {
"join": {
"operator": "AND",
"condition1": {
"comparison": {
"variable": "title",
"operator": "CONTAINS",
"value": "Test"
}
},
"condition2": {
"inComparison": {
"variable": "circleProcessStatus",
"operator": "IN",
"value": [
"IDLE","IN_PROGRESS"
]
}
}
}
},
"condition2": {
"inComparison": {
"variable": "circleType",
"operator": "IN",
"value": [
"COMPANY_MANAGED",
"USER_MANAGED"
]
}
}
}
}
} |
List of available services
...