1.Available end points
It is possible to access diverse objects in the HS/FS via HTTP. The calls for the individual objects are described in more detail in the following.
End points are available for the following objects:
End points are available for the following objects:
2.Call
The basic call looks as follows (placeholder in UPPER CASE):
A description of the methods (and, if necessary, of the parameters you require) are specified in the case of individual objects.
https://HS_IP/endpoints/call?key=OBJECT-KEY&method=METHOD&PARAMETER=VALUE&user=USER&pw=PWD| Placeholders | Explanation |
|---|---|
| HS_IP | The IP address of HS/FS. |
OBJECT-KEY | The object key is made up of a prefix for the type of respective object, followed by an '@' character and the ID specified at the object in Expert. Example for the object key of a communication object: CO@100_2_3. |
METHOD | The method specified here depends on the type of object activated. A list of the methods available for the respective objects is specified in the help of the object concerned. |
PARAMETER=VALUE | Optional, can occur several times! The number of parameters varies for the methods (0 to n). These are integrated by a '&' character, followed by the parameter type, an equal sign and the value of the parameter in the call. Whether a parameter is required, and if so, which, depends on the object used and the methods used. Example: In order to set a communication object to the value 7, "value" must be entered as PARAMETER and "7" as VALUE: &value=7. |
USER | User name of a user in HS/FS Expert. This user must have access rights to the respective object for reading and writing. |
PWD | Password of the previously entered user in HS/FS Expert. |
A description of the methods (and, if necessary, of the parameters you require) are specified in the case of individual objects.