Search for business workspaces
GET {{baseUrl}}/v2/businessworkspaces?where_workspace_type_id=exercitation sed volupt&where_workspace_type_name=exercitation sed volupt&expanded_view=false&where_is_early=true&where_ext_system_id=exercitation sed volupt&where_bo_type=exercitation sed volupt&where_bo_id=exercitation sed volupt&sort=exercitation sed volupt&where_name=exercitation sed volupt&where_column_query=exercitation sed volupt&page=7053409&limit=7053409&where_barcode=exercitation sed volupt&where_botype_node_id=true&expand=exercitation sed volupt&expand_users=true&fields=exercitation sed volupt&action=exercitation sed volupt
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} (parameter 'action' must also be provided) | |
expand_users | boolean | Expand users (parameter 'action' must also be provided) | |
fields | string | Filter fields, e.g. properties{id, parent_id} (parameter 'action' must also be provided) | |
action | string | Action, e.g. properties- |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"data":{"self":{"body":"anim do","content_type":"sit","href":"magna adipisicing do dolore ullamco","method":"culpa labore","name":"magna do aute amet moll"}}},"paging":{"limit":-54769681,"links":{},"page":30062698,"page_total":-2020722,"range_max":20475911,"range_min":21882963,"total_count":53984653},"results":[{"actions":{"data":{},"map":{},"order":["Duis","eu dolore"]},"data":{"properties":{"container":false,"create_date":"nostrud qui","create_user_id":92687384,"description":"ut id ad aliquip cupidatat","favorite":true,"icon":"minim d","id":-79043747,"modify_date":"occaecat magna amet et","modify_user_id":-6961203,"name":"ipsum exercitation sed enim","original_id":-86082853,"parent_id":-80693486,"perm_add_major_version":false,"perm_create":false,"perm_delete":true,"perm_delete_versions":false,"perm_modify":false,"perm_modify_attributes":false,"perm_modify_permissions":true,"perm_reserve":true,"perm_see":true,"perm_see_contents":true,"reserved":false,"reserved_date":"officia ad dolor Ut","reserved_user_id":7300747,"size":37251672,"type":-94469329,"type_name":"veniam nisi","user_id":88063242,"volume_id":25853584,"wnd_comments":{},"wnd_comments_formatted":{},"wnf_bo_type_id":{},"wnf_bo_type_id_formatted":{},"wnf_readydate":{},"wnf_readydate_formatted":{},"wnf_wksp_name_en":"ad laborum dolore","wnf_wksp_name_en_formatted":"labore","wnf_wksp_template_id":-80688466,"wnf_wksp_type_id":42312843,"wnf_wksp_type_id_formatted":"exercitation non quis"}}},{"actions":{"data":{},"map":{},"order":["Ut laborum ex aute","nulla sint ullamco"]},"data":{"properties":{"container":false,"create_date":"magna minim","create_user_id":80626373,"description":"mollit velit ad sunt","favorite":false,"icon":"ulla","id":51253870,"modify_date":"eu ut incididunt Lorem ex","modify_user_id":54060119,"name":"oc","original_id":-42393957,"parent_id":-42592950,"perm_add_major_version":true,"perm_create":true,"perm_delete":true,"perm_delete_versions":false,"perm_modify":false,"perm_modify_attributes":false,"perm_modify_permissions":false,"perm_reserve":false,"perm_see":true,"perm_see_contents":false,"reserved":false,"reserved_date":"sed laboris sunt","reserved_user_id":84501728,"size":14086153,"type":-27752930,"type_name":"aute","user_id":13467896,"volume_id":15925881,"wnd_comments":{},"wnd_comments_formatted":{},"wnf_bo_type_id":{},"wnf_bo_type_id_formatted":{},"wnf_readydate":{},"wnf_readydate_formatted":{},"wnf_wksp_name_en":"deserunt","wnf_wksp_name_en_formatted":"elit","wnf_wksp_template_id":-79636164,"wnf_wksp_type_id":-10689662,"wnf_wksp_type_id_formatted":"qui sint incidid"}}}],"wksp_info":{"wksp_type_icon":"aliquip sint Excepteur","wksp_type_icon_content_type":"tempor eiusmod"}}