sdk.lusid.api.workspace_api.WorkspaceApi

class WorkspaceApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

`create_item`	[EXPERIMENTAL] CreateItem: Create a new item in a workspace.
`create_item_with_http_info`	[EXPERIMENTAL] CreateItem: Create a new item in a workspace.
`create_workspace`	[EXPERIMENTAL] CreateWorkspace: Create a new workspace.
`create_workspace_with_http_info`	[EXPERIMENTAL] CreateWorkspace: Create a new workspace.
`delete_item`	[EXPERIMENTAL] DeleteItem: Delete an item from a workspace.
`delete_item_with_http_info`	[EXPERIMENTAL] DeleteItem: Delete an item from a workspace.
`delete_workspace`	[EXPERIMENTAL] DeleteWorkspace: Delete a workspace.
`delete_workspace_with_http_info`	[EXPERIMENTAL] DeleteWorkspace: Delete a workspace.
`get_item`	[EXPERIMENTAL] GetItem: Get a single workspace item.
`get_item_with_http_info`	[EXPERIMENTAL] GetItem: Get a single workspace item.
`get_workspace`	[EXPERIMENTAL] GetWorkspace: Get a workspace.
`get_workspace_with_http_info`	[EXPERIMENTAL] GetWorkspace: Get a workspace.
`list_items`	[EXPERIMENTAL] ListItems: List the items in a workspace.
`list_items_with_http_info`	[EXPERIMENTAL] ListItems: List the items in a workspace.
`list_workspaces`	[EXPERIMENTAL] ListWorkspaces: List workspaces.
`list_workspaces_with_http_info`	[EXPERIMENTAL] ListWorkspaces: List workspaces.
`search_items`	[EXPERIMENTAL] SearchItems: List items across all workspaces.
`search_items_with_http_info`	[EXPERIMENTAL] SearchItems: List items across all workspaces.
`update_item`	[EXPERIMENTAL] UpdateItem: Update an item in a workspace.
`update_item_with_http_info`	[EXPERIMENTAL] UpdateItem: Update an item in a workspace.
`update_workspace`	[EXPERIMENTAL] UpdateWorkspace: Update a workspace.
`update_workspace_with_http_info`	[EXPERIMENTAL] UpdateWorkspace: Update a workspace.

create_item(visibility, workspace_name, workspace_item_creation_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateItem: Create a new item in a workspace. # noqa: E501

Create a new item in a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_item(visibility, workspace_name, workspace_item_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The item’s workspace name. (required)
workspace_item_creation_request (WorkspaceItemCreationRequest) – The item to be created.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

WorkspaceItem

create_item_with_http_info(visibility, workspace_name, workspace_item_creation_request=None, **kwargs)[source]

[EXPERIMENTAL] CreateItem: Create a new item in a workspace. # noqa: E501

Create a new item in a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_item_with_http_info(visibility, workspace_name, workspace_item_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The item’s workspace name. (required)
workspace_item_creation_request (WorkspaceItemCreationRequest) – The item to be created.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))

create_workspace(visibility, workspace_creation_request, include_item_access=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateWorkspace: Create a new workspace. # noqa: E501

Create a new workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_workspace(visibility, workspace_creation_request, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace being created; case is important. Available values: shared, personal. (required)
workspace_creation_request (WorkspaceCreationRequest) – The workspace to be created. (required)
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Workspace

create_workspace_with_http_info(visibility, workspace_creation_request, include_item_access=None, **kwargs)[source]

[EXPERIMENTAL] CreateWorkspace: Create a new workspace. # noqa: E501

Create a new workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_workspace_with_http_info(visibility, workspace_creation_request, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace being created; case is important. Available values: shared, personal. (required)
workspace_creation_request (WorkspaceCreationRequest) – The workspace to be created. (required)
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Workspace, status_code(int), headers(HTTPHeaderDict))

delete_item(visibility, workspace_name, group_name, item_name, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. # noqa: E501

Delete an item from a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_item(visibility, workspace_name, group_name, item_name, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The name of the workspace. (required)
group_name (str) – The group containing the item. (required)
item_name (str) – The name of the item. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_item_with_http_info(visibility, workspace_name, group_name, item_name, **kwargs)[source]

[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. # noqa: E501

Delete an item from a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_item_with_http_info(visibility, workspace_name, group_name, item_name, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The name of the workspace. (required)
group_name (str) – The group containing the item. (required)
item_name (str) – The name of the item. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_workspace(visibility, workspace_name, recurse=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. # noqa: E501

Delete a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_workspace(visibility, workspace_name, recurse, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The name of the workspace. (required)
recurse (bool) – If true, recursively delete items in the workspace.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_workspace_with_http_info(visibility, workspace_name, recurse=None, **kwargs)[source]

[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. # noqa: E501

Delete a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_workspace_with_http_info(visibility, workspace_name, recurse, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The name of the workspace. (required)
recurse (bool) – If true, recursively delete items in the workspace.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

get_item(visibility, workspace_name, group_name, item_name, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetItem: Get a single workspace item. # noqa: E501

Get a single workspace item. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_item(visibility, workspace_name, group_name, item_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The name of the workspace. (required)
group_name (str) – The group containing the item. (required)
item_name (str) – The name of the item. (required)
as_at (datetime) – The datetime at which to request the workspace item. If not provided, defaults to ‘latest’.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

WorkspaceItem

get_item_with_http_info(visibility, workspace_name, group_name, item_name, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetItem: Get a single workspace item. # noqa: E501

Get a single workspace item. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_item_with_http_info(visibility, workspace_name, group_name, item_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The name of the workspace. (required)
group_name (str) – The group containing the item. (required)
item_name (str) – The name of the item. (required)
as_at (datetime) – The datetime at which to request the workspace item. If not provided, defaults to ‘latest’.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))

get_workspace(visibility, workspace_name, as_at=None, include_item_access=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetWorkspace: Get a workspace. # noqa: E501

Get a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_workspace(visibility, workspace_name, as_at, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Workspace

get_workspace_with_http_info(visibility, workspace_name, as_at=None, include_item_access=None, **kwargs)[source]

[EXPERIMENTAL] GetWorkspace: Get a workspace. # noqa: E501

Get a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_workspace_with_http_info(visibility, workspace_name, as_at, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Workspace, status_code(int), headers(HTTPHeaderDict))

list_items(visibility, workspace_name, as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListItems: List the items in a workspace. # noqa: E501

List the items in a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_items(visibility, workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The item’s workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspace items. Defaults to ‘latest’ if not specified.
page (str) – The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfWorkspaceItem

list_items_with_http_info(visibility, workspace_name, as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

[EXPERIMENTAL] ListItems: List the items in a workspace. # noqa: E501

List the items in a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_items_with_http_info(visibility, workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The item’s workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspace items. Defaults to ‘latest’ if not specified.
page (str) – The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfWorkspaceItem, status_code(int), headers(HTTPHeaderDict))

list_workspaces(visibility, as_at=None, page=None, sort_by=None, limit=None, filter=None, include_item_access=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListWorkspaces: List workspaces. # noqa: E501

List workspaces. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_workspaces(visibility, as_at, page, sort_by, limit, filter, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspaces; case is important. Available values: shared, personal. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
page (str) – The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfWorkspace

list_workspaces_with_http_info(visibility, as_at=None, page=None, sort_by=None, limit=None, filter=None, include_item_access=None, **kwargs)[source]

[EXPERIMENTAL] ListWorkspaces: List workspaces. # noqa: E501

List workspaces. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_workspaces_with_http_info(visibility, as_at, page, sort_by, limit, filter, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspaces; case is important. Available values: shared, personal. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
page (str) – The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfWorkspace, status_code(int), headers(HTTPHeaderDict))

search_items(visibility, as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SearchItems: List items across all workspaces. # noqa: E501

List items across all workspaces. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_items(visibility, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspace items. Defaults to ‘latest’ if not specified.
page (str) – The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfItemAndWorkspace

search_items_with_http_info(visibility, as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

[EXPERIMENTAL] SearchItems: List items across all workspaces. # noqa: E501

List items across all workspaces. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_items_with_http_info(visibility, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspace items. Defaults to ‘latest’ if not specified.
page (str) – The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfItemAndWorkspace, status_code(int), headers(HTTPHeaderDict))

update_item(visibility, workspace_name, group_name, item_name, workspace_item_update_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpdateItem: Update an item in a workspace. # noqa: E501

Update an item in a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_item(visibility, workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The workspace name. (required)
group_name (str) – The group containing the item. (required)
item_name (str) – The item name. (required)
workspace_item_update_request (WorkspaceItemUpdateRequest) – The new item details.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

WorkspaceItem

update_item_with_http_info(visibility, workspace_name, group_name, item_name, workspace_item_update_request=None, **kwargs)[source]

[EXPERIMENTAL] UpdateItem: Update an item in a workspace. # noqa: E501

Update an item in a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_item_with_http_info(visibility, workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the containing workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The workspace name. (required)
group_name (str) – The group containing the item. (required)
item_name (str) – The item name. (required)
workspace_item_update_request (WorkspaceItemUpdateRequest) – The new item details.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))

update_workspace(visibility, workspace_name, workspace_update_request, include_item_access=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpdateWorkspace: Update a workspace. # noqa: E501

Update a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_workspace(visibility, workspace_name, workspace_update_request, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The workspace name. (required)
workspace_update_request (WorkspaceUpdateRequest) – The new workspace details. (required)
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Workspace

update_workspace_with_http_info(visibility, workspace_name, workspace_update_request, include_item_access=None, **kwargs)[source]

[EXPERIMENTAL] UpdateWorkspace: Update a workspace. # noqa: E501

Update a workspace. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_workspace_with_http_info(visibility, workspace_name, workspace_update_request, include_item_access, async_req=True)
>>> result = thread.get()

Parameters:

visibility (str) – The visibility for the workspace; case is important. Available values: shared, personal. (required)
workspace_name (str) – The workspace name. (required)
workspace_update_request (WorkspaceUpdateRequest) – The new workspace details. (required)
include_item_access (bool) – If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Workspace, status_code(int), headers(HTTPHeaderDict))