/rest/api/workspace
Provides services for WorkSpace access.
POST v1/count
Determines the result count of the search defined by the given QueryContainerDTO.
Response
application/json; charset=UTF-8
CountResultDTO - Result object of a count request.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
queryContainer
the QueryContainerDTO to execute.
false
Status Codes
Status Code
Description
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.
DELETE v1/entry/delete
Deletes the entry defined by the given WorkSpaceAccessDTO.
Response
application/json; charset=UTF-8
WorkSpaceResultContainerDTO - DTO that represents a WorkSpace.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
wsAccessDTO
The WorkSpaceAccessDTO.
false
Status Codes
Status Code
Description
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.
703
The referenced entry could not be resolved.
705
It is not allowed to remove the entry.
DELETE v1/entry/delete/{entity}/{pk}
Deletes the entry defined by the given entity name and pk.
Response
application/json; charset=UTF-8
WorkSpaceResultContainerDTO - DTO that represents a WorkSpace.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
PATH
entity
The entity name.
false
PATH
pk
The primary key of an entry to delete.
false
Status Codes
Status Code
Description
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.
703
The referenced entry could not be resolved.
705
It is not allowed to remove the entry.
POST v1/entry/new
Return a WorkSpaceResultContainerDTO containing a single new entry prepared for insertion.
Response
application/json; charset=UTF-8
WorkSpaceResultContainerDTO - DTO that represents a WorkSpace.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
wsAccessDTO
The WorkSpaceAccessDTO.
false
Status Codes
Status Code
Description
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.
704
It is not allowed to insert an entry.
POST v1/entry/save
Inserts or saves the element contained in the given WorkSpaceAccessDTO. Returns an updated WorkSpaceResultContainerDTO containing a single AttributeContainerDTO with updated values.
Response
application/json; charset=UTF-8
WorkSpaceResultContainerDTO - DTO that represents a WorkSpace.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
wsAccessDTO
The WorkSpaceAccessDTO.
false
Status Codes
Status Code
Description
607
Status validation failed. Check response for detailed information.
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.
705
It is not allowed to insert the entry.
POST v1/search
Executes the search defined by the given QueryContainerDTO to retrieve a WorkSpace.
Response
application/json; charset=UTF-8
WorkSpaceResultContainerDTO - DTO that represents a WorkSpace.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
queryContainer
the QueryContainerDTO to execute.
false
Status Codes
Status Code
Description
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.
DELETE v1/workspaces/{id}
Deletes the WorkSpace with the given ID.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
PATH
id
the ID of the WorkSpace to delete.
false
Status Codes
Status Code
Description
700
A general error occurred during workspace handling.
701
The query is not valid.
702
The workspace could not be resolved.