sdk.lusid.api.workspace_api.WorkspaceApi

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

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

Create a new item in a personal 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_personal_item_with_http_info(workspace_name, workspace_item_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

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_personal_workspace(workspace_creation_request=None, async_req=None, **kwargs)[source]

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

Create a new personal 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_personal_workspace(workspace_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_creation_request (WorkspaceCreationRequest) – The workspace 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:

create_personal_workspace_with_http_info(workspace_creation_request=None, **kwargs)[source]

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

Create a new personal 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_personal_workspace_with_http_info(workspace_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_creation_request (WorkspaceCreationRequest) – The workspace 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(Workspace, status_code(int), headers(HTTPHeaderDict))

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

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

Create a new item in a shared 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_shared_item(workspace_name, workspace_item_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

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:

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

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

Create a new item in a shared 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_shared_item_with_http_info(workspace_name, workspace_item_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

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_shared_workspace(workspace_creation_request=None, async_req=None, **kwargs)[source]

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

Create a new shared 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_shared_workspace(workspace_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_creation_request (WorkspaceCreationRequest) – The workspace 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:

create_shared_workspace_with_http_info(workspace_creation_request=None, **kwargs)[source]

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

Create a new shared 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_shared_workspace_with_http_info(workspace_creation_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_creation_request (WorkspaceCreationRequest) – The workspace 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(Workspace, status_code(int), headers(HTTPHeaderDict))

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

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

Delete an item from a personal 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_personal_item(workspace_name, group_name, item_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the personal 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:

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

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

Delete an item from a personal 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_personal_item_with_http_info(workspace_name, group_name, item_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the personal 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_personal_workspace(workspace_name, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeletePersonalWorkspace: Delete a personal workspace. # noqa: E501

Delete a personal 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_personal_workspace(workspace_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the personal workspace. (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:

delete_personal_workspace_with_http_info(workspace_name, **kwargs)[source]

[EXPERIMENTAL] DeletePersonalWorkspace: Delete a personal workspace. # noqa: E501

Delete a personal 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_personal_workspace_with_http_info(workspace_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the personal workspace. (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_shared_item(workspace_name, group_name, item_name, async_req=None, **kwargs)[source]

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

Delete an item from a shared 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_shared_item(workspace_name, group_name, item_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the shared 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:

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

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

Delete an item from a shared 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_shared_item_with_http_info(workspace_name, group_name, item_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the shared 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_shared_workspace(workspace_name, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteSharedWorkspace: Delete a shared workspace. # noqa: E501

Delete a shared 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_shared_workspace(workspace_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the shared workspace. (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:

delete_shared_workspace_with_http_info(workspace_name, **kwargs)[source]

[EXPERIMENTAL] DeleteSharedWorkspace: Delete a shared workspace. # noqa: E501

Delete a shared 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_shared_workspace_with_http_info(workspace_name, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the shared workspace. (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))

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

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

Get a single personal 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_personal_item(workspace_name, group_name, item_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the personal 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:

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

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

Get a single personal 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_personal_item_with_http_info(workspace_name, group_name, item_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the personal 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_personal_workspace(workspace_name, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace. # noqa: E501

Get a personal 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_personal_workspace(workspace_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The personal workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
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:

get_personal_workspace_with_http_info(workspace_name, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace. # noqa: E501

Get a personal 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_personal_workspace_with_http_info(workspace_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The personal workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
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))

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

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

Get a single shared 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_shared_item(workspace_name, group_name, item_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the shared 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:

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

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

Get a single shared 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_shared_item_with_http_info(workspace_name, group_name, item_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The name of the shared 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_shared_workspace(workspace_name, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace. # noqa: E501

Get a shared 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_shared_workspace(workspace_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The shared workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
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

get_shared_workspace_with_http_info(workspace_name, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace. # noqa: E501

Get a shared 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_shared_workspace_with_http_info(workspace_name, as_at, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The shared workspace name. (required)
as_at (datetime) – The asAt datetime at which to retrieve workspaces. Defaults to ‘latest’ if not specified.
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_personal_items(workspace_name, as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

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

List the items in a personal 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_personal_items(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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:

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

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

List the items in a personal 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_personal_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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_personal_workspaces(as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces. # noqa: E501

List personal 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_personal_workspaces(as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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.
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_personal_workspaces_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

[EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces. # noqa: E501

List personal 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_personal_workspaces_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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.
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))

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

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

List the items in a shared 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_shared_items(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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_shared_items_with_http_info(workspace_name, as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

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

List the items in a shared 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_shared_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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_shared_workspaces(as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces. # noqa: E501

List shared 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_shared_workspaces(as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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.
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_shared_workspaces_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

[EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces. # noqa: E501

List shared 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_shared_workspaces_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

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.
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))

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

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

Update an item in a personal 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_personal_item(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The personal 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:

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

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

Update an item in a personal 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_personal_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The personal 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_personal_workspace(workspace_name, workspace_update_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace. # noqa: E501

Update a personal 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_personal_workspace(workspace_name, workspace_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The personal workspace name. (required)
workspace_update_request (WorkspaceUpdateRequest) – The new workspace 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:

update_personal_workspace_with_http_info(workspace_name, workspace_update_request=None, **kwargs)[source]

[EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace. # noqa: E501

Update a personal 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_personal_workspace_with_http_info(workspace_name, workspace_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The personal workspace name. (required)
workspace_update_request (WorkspaceUpdateRequest) – The new workspace 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(Workspace, status_code(int), headers(HTTPHeaderDict))

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

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

Update an item in a shared 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_shared_item(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The shared 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:

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

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

Update an item in a shared 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_shared_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The shared 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_shared_workspace(workspace_name, workspace_update_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpdateSharedWorkspace: Update a shared workspace. # noqa: E501

Update a shared 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_shared_workspace(workspace_name, workspace_update_request, async_req=True)
>>> result = thread.get()

Parameters:

workspace_name (str) – The shared workspace name. (required)
workspace_update_request (WorkspaceUpdateRequest) – The new workspace 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: