-
Notifications
You must be signed in to change notification settings - Fork 5
Backend REST Services
junkerm edited this page Nov 17, 2022
·
5 revisions
** IN PROGRESS** This page lists all services, which are provided by the backend via the REST-interface.
| Service name | REST-Call | HTTP-Method | Description |
|---|---|---|---|
| Login | login | POST | Logs a user in with given credentials |
| Logout | logout | GET | Performs logout of the current user |
| Service name | REST-Call | HTTP-Method | Description |
|---|---|---|---|
| CopyService | duplicate | POST | Duplicate the given element |
| DeleteService | delete | DELETE | Delete an element |
| DetailsService | details | GET | Return an element (Gets overwritten by connectors) |
| DetailsService | details | PUT | Update the element (Gets overwritten by connectors) |
| ListRecursiveService | listRecursive | GET | Return all descendents (children and children of children...) |
| ListService | list | GET | Return all direct children |
| ListService | list | POST | Create a new direct child |
| ModelImageService | listModelImage | GET | Return an png-image of a model |
| RecycleService | recycle | POST | Recycle an element and all descendents |
| RestoreService | restore | POST | Restore an element and all descendents |
| BatchService | batch | POST | Performs many operations in a single call |
| Service name | REST-Call | HTTP-Method | Description |
|---|---|---|---|
| ProjectNames | projectnames | GET | Retrieves all configured projects |
| Service name | REST-Call | HTTP-Method | Description |
|---|---|---|---|
| SyncSingleRequirementService | syncrequirement | GET | Syncs a single requirement with the given id |
| TestExportListService | exporterlist | GET | Returns a list of configured exporters |
| TestExportService | export | GET | Exports a given test using a given exporter |
| Service name | REST-Call | HTTP-Method | Description |
|---|---|---|---|
| LuceneBasedModelSearchService | reindex | GET | Reindex the searchresult, thus new elements found |
| SearchService | search | GET | Search for elements |
| Service name | REST-Call | HTTP-Method | Description |
|---|---|---|---|
| TestGeneratorService | generateTests | POST | Generates a test specification for a given model |
| GenerateModelFromRequirementService | generateModel | POST | Generates a model content from model requirements |