Search for business workspaces
GET {{baseUrl}}/v2/businessworkspaces?where_workspace_type_id=Excepteur&where_workspace_type_name=Excepteur&expanded_view=false&where_is_early=true&where_ext_system_id=Excepteur&where_bo_type=Excepteur&where_bo_id=Excepteur&sort=Excepteur&where_name=Excepteur&where_column_query=Excepteur&page=76387060&limit=76387060&where_barcode=Excepteur&where_botype_node_id=true&expand=Excepteur&expand_users=true&fields=Excepteur&action=Excepteur&metadata=true&global_metadata=true
Gets the recently accessed business workspaces or searches for business workspaces.
NOTE: Using filtering can be slow depending on the used operators, amount of data in the system, system resources and so on. Filtering must therefore be tuned system specific with regards to the used columns, operators, etc..
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
where_workspace_type_id | string | Filter for a specific workspace type. | |
where_workspace_type_name | string | Workspace type name in supported language | |
expanded_view | boolean | Select between the collapsed view and the expanded view. The collapsed view returns the recently accessed business workspaces and the expanded view searches for business workspaces. | |
where_is_early | boolean | Filter early workspaces | |
where_ext_system_id | string | Filter based on external system ID | |
where_bo_type | string | Filter based on business object type | |
where_bo_id | string | Filter based on business object ID | |
sort | string | Sort supports the prefixes 'asc_ 'and 'desc_' like sort=asc_name. | |
where_name | string | Filter for a specific column value. The parameters are concatenated using a logical 'AND' and the values are compared with the equals operator. If the data type is 'String' then the prefixes 'contains_' and 'startswith_' are supported like where_name=contains_Test. | |
where_column_query | string | Query to support filtering in a more generic way. The following BNF is supported: <p> <query> ::= <condition> [<sort>] <p> <condition> ::= <expression> ("OR" | |
page | number | Limit the number of pages to retrieve (parameter 'limit' must also be provided) | |
limit | number | Limit items on the page (parameter 'page' must also be provided) | |
where_barcode | string | Barcode | |
where_botype_node_id | boolean | Business object type node IDs | |
expand | string | Expand, e.g. properties{parent_id} | |
expand_users | boolean | Expand users | |
fields | string | Filter fields, e.g. properties{id, parent_id} (parameter 'action' must also be provided) | |
action | string | Action, e.g. properties- | |
metadata | boolean | Returns the metadata globally and with each found item | |
global_metadata | boolean | Returns the metadata globally |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"data":{"self":{"body":"Duis ipsum","content_type":"nostrud elit cupidatat laborum","href":"dolore exercitation","method":"deserunt","name":"ad eiusmod"}}},"paging":{"limit":13195082,"links":{},"page":-64605409,"page_total":-38255131,"range_max":-34479914,"range_min":-26029989,"total_count":-8371676},"results":[{"actions":{"data":{},"map":{},"order":["sit dolore mollit Ut anim","elit voluptate"]},"data":{"properties":{"container":false,"create_date":"ut","create_user_id":-29437467,"description":"aliqua Lorem veniam","favorite":true,"icon":"elit laborum","id":34230429,"image_url":"id in sed nostrud","modify_date":"aliquip et","modify_user_id":-76690523,"name":"consect","original_id":54573639,"parent_id":-27391673,"perm_add_major_version":true,"perm_create":false,"perm_delete":false,"perm_delete_versions":false,"perm_modify":true,"perm_modify_attributes":true,"perm_modify_permissions":true,"perm_reserve":true,"perm_see":false,"perm_see_contents":false,"reserved":false,"reserved_date":"m","reserved_user_id":-15976958,"size":-68691334,"type":19630068,"type_name":"proident Duis irure laborum mollit","user_id":-51477365,"volume_id":-24746502,"wnd_comments":{},"wnd_comments_formatted":{},"wnf_bo_type_id":{},"wnf_bo_type_id_formatted":{},"wnf_readydate":{},"wnf_readydate_formatted":{},"wnf_wksp_name_en":"sunt esse nisi","wnf_wksp_name_en_formatted":"magna eiusmod consequat qui dolore","wnf_wksp_template_id":26310693,"wnf_wksp_type_id":53592122,"wnf_wksp_type_id_formatted":"Lorem ad in"}}},{"actions":{"data":{},"map":{},"order":["Duis irure aute","sed laboris veniam dolore non"]},"data":{"properties":{"container":true,"create_date":"consectetur eu dolor amet","create_user_id":54472671,"description":"officia aliquip minim aliqua","favorite":false,"icon":"quis reprehenderit","id":19913712,"image_url":"consequat aliquip eiusmod","modify_date":"dolor","modify_user_id":41428592,"name":"non minim nulla dolor","original_id":-919352,"parent_id":73097366,"perm_add_major_version":true,"perm_create":true,"perm_delete":true,"perm_delete_versions":true,"perm_modify":false,"perm_modify_attributes":true,"perm_modify_permissions":false,"perm_reserve":true,"perm_see":false,"perm_see_contents":true,"reserved":true,"reserved_date":"consequat aliquip","reserved_user_id":64863248,"size":71219809,"type":1895891,"type_name":"deserunt elit ad id","user_id":98745559,"volume_id":45718509,"wnd_comments":{},"wnd_comments_formatted":{},"wnf_bo_type_id":{},"wnf_bo_type_id_formatted":{},"wnf_readydate":{},"wnf_readydate_formatted":{},"wnf_wksp_name_en":"ex ut n","wnf_wksp_name_en_formatted":"proident elit velit","wnf_wksp_template_id":78741613,"wnf_wksp_type_id":26616875,"wnf_wksp_type_id_formatted":"exercitation consectetur amet"}}}],"wksp_info":{"wksp_type_icon":"Excepteur cupidatat in et"}}