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

Inheritance diagram for Lusid.Sdk.Api.IWorkspaceApiSync:

[legend]

Public Member Functions
WorkspaceItem	CreateItem (string visibility, string workspaceName, WorkspaceItemCreationRequest? workspaceItemCreationRequest=default(WorkspaceItemCreationRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateItem: Create a new item in a workspace. More...

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

Workspace	CreateWorkspace (string visibility, WorkspaceCreationRequest workspaceCreationRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateWorkspace: Create a new workspace. More...

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

DeletedEntityResponse	DeleteItem (string visibility, string workspaceName, string groupName, string itemName, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. More...

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

DeletedEntityResponse	DeleteWorkspace (string visibility, string workspaceName, bool? recurse=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. More...

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

WorkspaceItem	GetItem (string visibility, string workspaceName, string groupName, string itemName, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetItem: Get a single workspace item. More...

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

Workspace	GetWorkspace (string visibility, string workspaceName, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeItemAccess=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetWorkspace: Get a workspace. More...

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

PagedResourceListOfWorkspaceItem	ListItems (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListItems: List the items in a workspace. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfWorkspaceItem >	ListItemsWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListItems: List the items in a workspace. More...

PagedResourceListOfWorkspace	ListWorkspaces (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListWorkspaces: List workspaces. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfWorkspace >	ListWorkspacesWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListWorkspaces: List workspaces. More...

PagedResourceListOfItemAndWorkspace	SearchItems (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SearchItems: List items across all workspaces. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfItemAndWorkspace >	SearchItemsWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SearchItems: List items across all workspaces. More...

WorkspaceItem	UpdateItem (string visibility, string workspaceName, string groupName, string itemName, WorkspaceItemUpdateRequest? workspaceItemUpdateRequest=default(WorkspaceItemUpdateRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateItem: Update an item in a workspace. More...

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

Workspace	UpdateWorkspace (string visibility, string workspaceName, WorkspaceUpdateRequest workspaceUpdateRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateWorkspace: Update a workspace. More...

Lusid.Sdk.Client.ApiResponse< Workspace >	UpdateWorkspaceWithHttpInfo (string visibility, string workspaceName, WorkspaceUpdateRequest workspaceUpdateRequest, bool? includeItemAccess=default(bool?), int operationIndex=0, 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

◆ CreateItem()

WorkspaceItem Lusid.Sdk.Api.IWorkspaceApiSync.CreateItem	(	string	visibility,
		string	workspaceName,
		WorkspaceItemCreationRequest?	workspaceItemCreationRequest = `default(WorkspaceItemCreationRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ CreateItemWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<WorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiSync.CreateItemWithHttpInfo	(	string	visibility,
		string	workspaceName,
		WorkspaceItemCreationRequest?	workspaceItemCreationRequest = `default(WorkspaceItemCreationRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ CreateWorkspace()

Workspace Lusid.Sdk.Api.IWorkspaceApiSync.CreateWorkspace	(	string	visibility,
		WorkspaceCreationRequest	workspaceCreationRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ CreateWorkspaceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Workspace> Lusid.Sdk.Api.IWorkspaceApiSync.CreateWorkspaceWithHttpInfo	(	string	visibility,
		WorkspaceCreationRequest	workspaceCreationRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteItem()

DeletedEntityResponse Lusid.Sdk.Api.IWorkspaceApiSync.DeleteItem	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteItemWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IWorkspaceApiSync.DeleteItemWithHttpInfo	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteWorkspace()

DeletedEntityResponse Lusid.Sdk.Api.IWorkspaceApiSync.DeleteWorkspace	(	string	visibility,
		string	workspaceName,
		bool?	recurse = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ DeleteWorkspaceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IWorkspaceApiSync.DeleteWorkspaceWithHttpInfo	(	string	visibility,
		string	workspaceName,
		bool?	recurse = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetItem()

WorkspaceItem Lusid.Sdk.Api.IWorkspaceApiSync.GetItem	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetItemWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<WorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiSync.GetItemWithHttpInfo	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetWorkspace()

Workspace Lusid.Sdk.Api.IWorkspaceApiSync.GetWorkspace	(	string	visibility,
		string	workspaceName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ GetWorkspaceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Workspace> Lusid.Sdk.Api.IWorkspaceApiSync.GetWorkspaceWithHttpInfo	(	string	visibility,
		string	workspaceName,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListItems()

PagedResourceListOfWorkspaceItem Lusid.Sdk.Api.IWorkspaceApiSync.ListItems	(	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`,
		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.
opts	Options for this request.

Returns: PagedResourceListOfWorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListItemsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfWorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiSync.ListItemsWithHttpInfo	(	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`,
		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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfWorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListWorkspaces()

PagedResourceListOfWorkspace Lusid.Sdk.Api.IWorkspaceApiSync.ListWorkspaces	(	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`,
		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.
opts	Options for this request.

Returns: PagedResourceListOfWorkspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ ListWorkspacesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfWorkspace> Lusid.Sdk.Api.IWorkspaceApiSync.ListWorkspacesWithHttpInfo	(	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`,
		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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfWorkspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ SearchItems()

PagedResourceListOfItemAndWorkspace Lusid.Sdk.Api.IWorkspaceApiSync.SearchItems	(	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`,
		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.
opts	Options for this request.

Returns: PagedResourceListOfItemAndWorkspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ SearchItemsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfItemAndWorkspace> Lusid.Sdk.Api.IWorkspaceApiSync.SearchItemsWithHttpInfo	(	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`,
		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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfItemAndWorkspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateItem()

WorkspaceItem Lusid.Sdk.Api.IWorkspaceApiSync.UpdateItem	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		WorkspaceItemUpdateRequest?	workspaceItemUpdateRequest = `default(WorkspaceItemUpdateRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateItemWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<WorkspaceItem> Lusid.Sdk.Api.IWorkspaceApiSync.UpdateItemWithHttpInfo	(	string	visibility,
		string	workspaceName,
		string	groupName,
		string	itemName,
		WorkspaceItemUpdateRequest?	workspaceItemUpdateRequest = `default(WorkspaceItemUpdateRequest?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of WorkspaceItem

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateWorkspace()

Workspace Lusid.Sdk.Api.IWorkspaceApiSync.UpdateWorkspace	(	string	visibility,
		string	workspaceName,
		WorkspaceUpdateRequest	workspaceUpdateRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: Workspace

Implemented in Lusid.Sdk.Api.WorkspaceApi.

◆ UpdateWorkspaceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Workspace> Lusid.Sdk.Api.IWorkspaceApiSync.UpdateWorkspaceWithHttpInfo	(	string	visibility,
		string	workspaceName,
		WorkspaceUpdateRequest	workspaceUpdateRequest,
		bool?	includeItemAccess = `default(bool?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of 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

◆ CreateItem()

◆ CreateItemWithHttpInfo()

◆ CreateWorkspace()

◆ CreateWorkspaceWithHttpInfo()

◆ DeleteItem()

◆ DeleteItemWithHttpInfo()

◆ DeleteWorkspace()

◆ DeleteWorkspaceWithHttpInfo()

◆ GetItem()

◆ GetItemWithHttpInfo()

◆ GetWorkspace()

◆ GetWorkspaceWithHttpInfo()

◆ ListItems()

◆ ListItemsWithHttpInfo()

◆ ListWorkspaces()

◆ ListWorkspacesWithHttpInfo()

◆ SearchItems()

◆ SearchItemsWithHttpInfo()

◆ UpdateItem()

◆ UpdateItemWithHttpInfo()

◆ UpdateWorkspace()

◆ UpdateWorkspaceWithHttpInfo()