Skip to content

Backend REST Services

wehrlean edited this page Nov 10, 2020 · 5 revisions

** IN PROGRESS** This page lists all services, which are provided by the backend via the REST-interface.

CRUD

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

CONNECTORS

Service name REST-Call HTTP-Method Description
ALMExportService syncalm POST
SyncSingleRequirementService syncrequirement GET Syncs a single requirement with the given id

SEARCH

Service name REST-Call HTTP-Method Description
LuceneBasedModelSearchService reindex GET Reindex the searchresult, thus new elements found
SearchService search GET Search for elements