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

Inheritance diagram for Lusid.Sdk.Api.IBlocksApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteBlock (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteBlock: Delete block More...

ApiResponse< DeletedEntityResponse >	DeleteBlockWithHttpInfo (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteBlock: Delete block More...

Block	GetBlock (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] GetBlock: Get Block More...

ApiResponse< Block >	GetBlockWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] GetBlock: Get Block More...

PagedResourceListOfBlock	ListBlocks (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListBlocks: List Blocks More...

ApiResponse< PagedResourceListOfBlock >	ListBlocksWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListBlocks: List Blocks More...

ResourceListOfBlock	UpsertBlocks (BlockSetRequest? blockSetRequest=default(BlockSetRequest?), int operationIndex=0)
	[EARLY ACCESS] UpsertBlocks: Upsert Block More...

ApiResponse< ResourceListOfBlock >	UpsertBlocksWithHttpInfo (BlockSetRequest? blockSetRequest=default(BlockSetRequest?), int operationIndex=0)
	[EARLY ACCESS] UpsertBlocks: Upsert Block More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteBlock()

DeletedEntityResponse Lusid.Sdk.Api.IBlocksApiSync.DeleteBlock	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EARLY ACCESS] DeleteBlock: Delete block

Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The block scope.
code	The block's code. This, together with the scope uniquely identifies the block to delete.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ DeleteBlockWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IBlocksApiSync.DeleteBlockWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EARLY ACCESS] DeleteBlock: Delete block

Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The block scope.
code	The block's code. This, together with the scope uniquely identifies the block to delete.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ GetBlock()

Block Lusid.Sdk.Api.IBlocksApiSync.GetBlock	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetBlock: Get Block

Fetch a Block that matches the specified identifier

Exceptions

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

Parameters

scope	The scope to which the block belongs.
code	The block's unique identifier.
asAt	The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional)
propertyKeys	A list of property keys from the "Block" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional)
operationIndex	Index associated with the operation.

Returns: Block

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ GetBlockWithHttpInfo()

ApiResponse<Block> Lusid.Sdk.Api.IBlocksApiSync.GetBlockWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetBlock: Get Block

Fetch a Block that matches the specified identifier

Exceptions

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

Parameters

scope	The scope to which the block belongs.
code	The block's unique identifier.
asAt	The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional)
propertyKeys	A list of property keys from the "Block" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Block

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ ListBlocks()

PagedResourceListOfBlock Lusid.Sdk.Api.IBlocksApiSync.ListBlocks	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListBlocks: List Blocks

Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional)
page	The pagination token to use to continue listing blocks from a previous call to list blocks. 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 or properties 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)
propertyKeys	A list of property keys from the "Block" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfBlock

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ ListBlocksWithHttpInfo()

ApiResponse<PagedResourceListOfBlock> Lusid.Sdk.Api.IBlocksApiSync.ListBlocksWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListBlocks: List Blocks

Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional)
page	The pagination token to use to continue listing blocks from a previous call to list blocks. 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 or properties 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)
propertyKeys	A list of property keys from the "Block" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfBlock

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ UpsertBlocks()

ResourceListOfBlock Lusid.Sdk.Api.IBlocksApiSync.UpsertBlocks	(	BlockSetRequest?	blockSetRequest = `default(BlockSetRequest?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertBlocks: Upsert Block

Upsert; update existing blocks with given ids, or create new blocks otherwise.

Exceptions

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

Parameters

blockSetRequest	The collection of block requests. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfBlock

Implemented in Lusid.Sdk.Api.BlocksApi.

◆ UpsertBlocksWithHttpInfo()

ApiResponse<ResourceListOfBlock> Lusid.Sdk.Api.IBlocksApiSync.UpsertBlocksWithHttpInfo	(	BlockSetRequest?	blockSetRequest = `default(BlockSetRequest?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertBlocks: Upsert Block

Upsert; update existing blocks with given ids, or create new blocks otherwise.

Exceptions

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

Parameters

blockSetRequest	The collection of block requests. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfBlock

Implemented in Lusid.Sdk.Api.BlocksApi.

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/BlocksApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteBlock()

◆ DeleteBlockWithHttpInfo()

◆ GetBlock()

◆ GetBlockWithHttpInfo()

◆ ListBlocks()

◆ ListBlocksWithHttpInfo()

◆ UpsertBlocks()

◆ UpsertBlocksWithHttpInfo()