Service calls and return values

Service calls send the information about the action to perform in the Alfabet database or the information to send back to the URL of the Alfabet RESTful API. The endpoints that are available to access and to change data are predefined and require a specific set of parameters to be sent to the Alfabet RESTful API.

To make a service call, a valid URL consisting of the address of the Alfabet API server and the body specification of the request endpoint must be sent to the web server via an HTTPS request. The header of the request must contain a valid authorization. Click for details about authorization.

A valid URL has the following structure: URLOfTheAlfabetAPIServer/api/v2/EndpointName

Variable in URL	Required Value
ServerAdress	The web address of the Alfabet API Server. The specification of the web address is case-sensitive.
api/v2	The specification of the Alfabet RESTful API. The current version is api/v2.
EndpointName	The endpoint to be called. Allowed values are: enums: Use for calls returning information about all or a subset of enumerations defined in the Alfabet meta-model. Click for details about the service call. objects: Use for calls returning property values of one or multiple defined objects in the Alfabet database or the result of a query executed via an Alfabet configured report. Click for details about the service call. delete: Use for calls updating objects and relations from the Alfabet database. Click for details about the service call. update: Use for calls updating data in the Alfabet database and to create new objects and relations. Click for details about the service call. regeneratepassword: Use for calls to regenerate the password of selected users in the Alfabet database. Click for details about the service call. anonymizeuser: Use for calls to anonymize the data of one or multiple selected users in the Alfabet database. Click for details about the service call.