Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.IWorkspaceApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< WorkspaceItem >	CreateItemAsync (string visibility, string workspaceName, WorkspaceItemCreationRequest? workspaceItemCreationRequest=default(WorkspaceItemCreationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateItem: Create a new item in a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< WorkspaceItem > >	CreateItemWithHttpInfoAsync (string visibility, string workspaceName, WorkspaceItemCreationRequest? workspaceItemCreationRequest=default(WorkspaceItemCreationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateItem: Create a new item in a workspace. More...

System.Threading.Tasks.Task< Workspace >	CreateWorkspaceAsync (string visibility, WorkspaceCreationRequest workspaceCreationRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateWorkspace: Create a new workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Workspace > >	CreateWorkspaceWithHttpInfoAsync (string visibility, WorkspaceCreationRequest workspaceCreationRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateWorkspace: Create a new workspace. More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteItemAsync (string visibility, string workspaceName, string groupName, string itemName, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteItemWithHttpInfoAsync (string visibility, string workspaceName, string groupName, string itemName, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteWorkspaceAsync (string visibility, string workspaceName, bool? recurse=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteWorkspaceWithHttpInfoAsync (string visibility, string workspaceName, bool? recurse=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. More...

System.Threading.Tasks.Task< WorkspaceItem >	GetItemAsync (string visibility, string workspaceName, string groupName, string itemName, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetItem: Get a single workspace item. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< WorkspaceItem > >	GetItemWithHttpInfoAsync (string visibility, string workspaceName, string groupName, string itemName, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetItem: Get a single workspace item. More...

System.Threading.Tasks.Task< Workspace >	GetWorkspaceAsync (string visibility, string workspaceName, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetWorkspace: Get a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Workspace > >	GetWorkspaceWithHttpInfoAsync (string visibility, string workspaceName, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetWorkspace: Get a workspace. More...

System.Threading.Tasks.Task< PagedResourceListOfWorkspaceItem >	ListItemsAsync (string visibility, string workspaceName, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListItems: List the items in a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfWorkspaceItem > >	ListItemsWithHttpInfoAsync (string visibility, string workspaceName, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListItems: List the items in a workspace. More...

System.Threading.Tasks.Task< PagedResourceListOfWorkspace >	ListWorkspacesAsync (string visibility, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListWorkspaces: List workspaces. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfWorkspace > >	ListWorkspacesWithHttpInfoAsync (string visibility, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListWorkspaces: List workspaces. More...

System.Threading.Tasks.Task< PagedResourceListOfItemAndWorkspace >	SearchItemsAsync (string visibility, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SearchItems: List items across all workspaces. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfItemAndWorkspace > >	SearchItemsWithHttpInfoAsync (string visibility, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SearchItems: List items across all workspaces. More...

System.Threading.Tasks.Task< WorkspaceItem >	UpdateItemAsync (string visibility, string workspaceName, string groupName, string itemName, WorkspaceItemUpdateRequest? workspaceItemUpdateRequest=default(WorkspaceItemUpdateRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateItem: Update an item in a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< WorkspaceItem > >	UpdateItemWithHttpInfoAsync (string visibility, string workspaceName, string groupName, string itemName, WorkspaceItemUpdateRequest? workspaceItemUpdateRequest=default(WorkspaceItemUpdateRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateItem: Update an item in a workspace. More...

System.Threading.Tasks.Task< Workspace >	UpdateWorkspaceAsync (string visibility, string workspaceName, WorkspaceUpdateRequest workspaceUpdateRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateWorkspace: Update a workspace. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Workspace > >	UpdateWorkspaceWithHttpInfoAsync (string visibility, string workspaceName, WorkspaceUpdateRequest workspaceUpdateRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateWorkspace: Update a workspace. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateItemAsync()

System.Threading.Tasks.Task<WorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiAsync.CreateItemAsync	(	string	visibility,
		string	workspaceName,
		WorkspaceItemCreationRequest?	workspaceItemCreationRequest = `default(WorkspaceItemCreationRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

Create a new item in a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The item's workspace name.
workspaceItemCreationRequest	The item to be created. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ CreateItemWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<WorkspaceItem> > Lusid.Sdk.Api.IWorkspaceApiAsync.CreateItemWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		WorkspaceItemCreationRequest?	workspaceItemCreationRequest = `default(WorkspaceItemCreationRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

Create a new item in a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The item's workspace name.
workspaceItemCreationRequest	The item to be created. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (WorkspaceItem)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ CreateWorkspaceAsync()

System.Threading.Tasks.Task<Workspace> Lusid.Sdk.Api.IWorkspaceApiAsync.CreateWorkspaceAsync	(	string	visibility,
		WorkspaceCreationRequest	workspaceCreationRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateWorkspace: Create a new workspace.

Create a new workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace being created; case is important. Available values: shared, personal.
workspaceCreationRequest	The workspace to be created.
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ CreateWorkspaceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Workspace> > Lusid.Sdk.Api.IWorkspaceApiAsync.CreateWorkspaceWithHttpInfoAsync	(	string	visibility,
		WorkspaceCreationRequest	workspaceCreationRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateWorkspace: Create a new workspace.

Create a new workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace being created; case is important. Available values: shared, personal.
workspaceCreationRequest	The workspace to be created.
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Workspace)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteItemAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IWorkspaceApiAsync.DeleteItemAsync	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

Delete an item from a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The name of the workspace.
groupName	The group containing the item.
itemName	The name of the item.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteItemWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IWorkspaceApiAsync.DeleteItemWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

Delete an item from a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The name of the workspace.
groupName	The group containing the item.
itemName	The name of the item.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteWorkspaceAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IWorkspaceApiAsync.DeleteWorkspaceAsync	(	string	visibility,
		string	workspaceName,
		bool?	recurse = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteWorkspace: Delete a workspace.

Delete a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace; case is important. Available values: shared, personal.
workspaceName	The name of the workspace.
recurse	If true, recursively delete items in the workspace. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteWorkspaceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IWorkspaceApiAsync.DeleteWorkspaceWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		bool?	recurse = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteWorkspace: Delete a workspace.

Delete a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace; case is important. Available values: shared, personal.
workspaceName	The name of the workspace.
recurse	If true, recursively delete items in the workspace. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetItemAsync()

System.Threading.Tasks.Task<WorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiAsync.GetItemAsync	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetItem: Get a single workspace item.

Get a single workspace item.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The name of the workspace.
groupName	The group containing the item.
itemName	The name of the item.
asAt	The datetime at which to request the workspace item. If not provided, defaults to 'latest'. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetItemWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<WorkspaceItem> > Lusid.Sdk.Api.IWorkspaceApiAsync.GetItemWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetItem: Get a single workspace item.

Get a single workspace item.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The name of the workspace.
groupName	The group containing the item.
itemName	The name of the item.
asAt	The datetime at which to request the workspace item. If not provided, defaults to 'latest'. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (WorkspaceItem)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetWorkspaceAsync()

System.Threading.Tasks.Task<Workspace> Lusid.Sdk.Api.IWorkspaceApiAsync.GetWorkspaceAsync	(	string	visibility,
		string	workspaceName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetWorkspace: Get a workspace.

Get a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace; case is important. Available values: shared, personal.
workspaceName	The workspace name.
asAt	The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified. (optional)
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetWorkspaceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Workspace> > Lusid.Sdk.Api.IWorkspaceApiAsync.GetWorkspaceWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetWorkspace: Get a workspace.

Get a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace; case is important. Available values: shared, personal.
workspaceName	The workspace name.
asAt	The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified. (optional)
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Workspace)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListItemsAsync()

System.Threading.Tasks.Task<PagedResourceListOfWorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiAsync.ListItemsAsync	(	string	visibility,
		string	workspaceName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

List the items in a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The item's workspace name.
asAt	The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfWorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListItemsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfWorkspaceItem> > Lusid.Sdk.Api.IWorkspaceApiAsync.ListItemsWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

List the items in a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The item's workspace name.
asAt	The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfWorkspaceItem)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListWorkspacesAsync()

System.Threading.Tasks.Task<PagedResourceListOfWorkspace> Lusid.Sdk.Api.IWorkspaceApiAsync.ListWorkspacesAsync	(	string	visibility,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListWorkspaces: List workspaces.

List workspaces.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspaces; case is important. Available values: shared, personal.
asAt	The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfWorkspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListWorkspacesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfWorkspace> > Lusid.Sdk.Api.IWorkspaceApiAsync.ListWorkspacesWithHttpInfoAsync	(	string	visibility,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListWorkspaces: List workspaces.

List workspaces.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspaces; case is important. Available values: shared, personal.
asAt	The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfWorkspace)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ SearchItemsAsync()

System.Threading.Tasks.Task<PagedResourceListOfItemAndWorkspace> Lusid.Sdk.Api.IWorkspaceApiAsync.SearchItemsAsync	(	string	visibility,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] SearchItems: List items across all workspaces.

List items across all workspaces.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
asAt	The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfItemAndWorkspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ SearchItemsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfItemAndWorkspace> > Lusid.Sdk.Api.IWorkspaceApiAsync.SearchItemsWithHttpInfoAsync	(	string	visibility,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] SearchItems: List items across all workspaces.

List items across all workspaces.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
asAt	The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfItemAndWorkspace)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateItemAsync()

System.Threading.Tasks.Task<WorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiAsync.UpdateItemAsync	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		WorkspaceItemUpdateRequest?	workspaceItemUpdateRequest = `default(WorkspaceItemUpdateRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

Update an item in a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The workspace name.
groupName	The group containing the item.
itemName	The item name.
workspaceItemUpdateRequest	The new item details. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateItemWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<WorkspaceItem> > Lusid.Sdk.Api.IWorkspaceApiAsync.UpdateItemWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		WorkspaceItemUpdateRequest?	workspaceItemUpdateRequest = `default(WorkspaceItemUpdateRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

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

Update an item in a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the containing workspace; case is important. Available values: shared, personal.
workspaceName	The workspace name.
groupName	The group containing the item.
itemName	The item name.
workspaceItemUpdateRequest	The new item details. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (WorkspaceItem)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateWorkspaceAsync()

System.Threading.Tasks.Task<Workspace> Lusid.Sdk.Api.IWorkspaceApiAsync.UpdateWorkspaceAsync	(	string	visibility,
		string	workspaceName,
		WorkspaceUpdateRequest	workspaceUpdateRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateWorkspace: Update a workspace.

Update a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace; case is important. Available values: shared, personal.
workspaceName	The workspace name.
workspaceUpdateRequest	The new workspace details.
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateWorkspaceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Workspace> > Lusid.Sdk.Api.IWorkspaceApiAsync.UpdateWorkspaceWithHttpInfoAsync	(	string	visibility,
		string	workspaceName,
		WorkspaceUpdateRequest	workspaceUpdateRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateWorkspace: Update a workspace.

Update a workspace.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

visibility	The visibility for the workspace; case is important. Available values: shared, personal.
workspaceName	The workspace name.
workspaceUpdateRequest	The new workspace details.
includeItemAccess	If true, includes the workspace item actions the user is permitted to perform in the response. Defaults to false. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Workspace)

Implemented in Lusid.Sdk.Api.WorkspaceApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/WorkspaceApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateItemAsync()

◆ CreateItemWithHttpInfoAsync()

◆ CreateWorkspaceAsync()

◆ CreateWorkspaceWithHttpInfoAsync()

◆ DeleteItemAsync()

◆ DeleteItemWithHttpInfoAsync()

◆ DeleteWorkspaceAsync()

◆ DeleteWorkspaceWithHttpInfoAsync()

◆ GetItemAsync()

◆ GetItemWithHttpInfoAsync()

◆ GetWorkspaceAsync()

◆ GetWorkspaceWithHttpInfoAsync()

◆ ListItemsAsync()

◆ ListItemsWithHttpInfoAsync()

◆ ListWorkspacesAsync()

◆ ListWorkspacesWithHttpInfoAsync()

◆ SearchItemsAsync()

◆ SearchItemsWithHttpInfoAsync()

◆ UpdateItemAsync()

◆ UpdateItemWithHttpInfoAsync()

◆ UpdateWorkspaceAsync()

◆ UpdateWorkspaceWithHttpInfoAsync()