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

Inheritance diagram for Lusid.Sdk.Api.OrderGraphApi:

[legend]

Public Member Functions
	OrderGraphApi ()
	Initializes a new instance of the OrderGraphApi class. More...

	OrderGraphApi (string basePath)
	Initializes a new instance of the OrderGraphApi class. More...

	OrderGraphApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the OrderGraphApi class using Configuration object More...

	OrderGraphApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the OrderGraphApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

PagedResourceListOfOrderGraphBlock	ListOrderGraphBlocks (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? useComplianceV2=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrderGraphBlock >	ListOrderGraphBlocksWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? useComplianceV2=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state. More...

async System.Threading.Tasks.Task< PagedResourceListOfOrderGraphBlock >	ListOrderGraphBlocksAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? useComplianceV2=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrderGraphBlock > >	ListOrderGraphBlocksWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? useComplianceV2=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state. More...

PagedResourceListOfOrderGraphPlacement	ListOrderGraphPlacementChildren (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrderGraphPlacement >	ListOrderGraphPlacementChildrenWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

async System.Threading.Tasks.Task< PagedResourceListOfOrderGraphPlacement >	ListOrderGraphPlacementChildrenAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrderGraphPlacement > >	ListOrderGraphPlacementChildrenWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

PagedResourceListOfOrderGraphPlacement	ListOrderGraphPlacements (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=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, ConfigurationOptions? opts=null)
	ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrderGraphPlacement >	ListOrderGraphPlacementsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=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, ConfigurationOptions? opts=null)
	ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

async System.Threading.Tasks.Task< PagedResourceListOfOrderGraphPlacement >	ListOrderGraphPlacementsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrderGraphPlacement > >	ListOrderGraphPlacementsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? paginationToken=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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

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

Constructor & Destructor Documentation

◆ OrderGraphApi() [1/4]

Lusid.Sdk.Api.OrderGraphApi.OrderGraphApi ( )

inline

Initializes a new instance of the OrderGraphApi class.

Returns

◆ OrderGraphApi() [2/4]

Lusid.Sdk.Api.OrderGraphApi.OrderGraphApi ( string basePath )

inline

Initializes a new instance of the OrderGraphApi class.

Returns

◆ OrderGraphApi() [3/4]

Lusid.Sdk.Api.OrderGraphApi.OrderGraphApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the OrderGraphApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ OrderGraphApi() [4/4]

Lusid.Sdk.Api.OrderGraphApi.OrderGraphApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the OrderGraphApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ GetBasePath()

string Lusid.Sdk.Api.OrderGraphApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ ListOrderGraphBlocks()

PagedResourceListOfOrderGraphBlock Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphBlocks	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		bool?	useComplianceV2 = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
useComplianceV2	Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: false) (optional, default to false)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfOrderGraphBlock

Implements Lusid.Sdk.Api.IOrderGraphApiSync.

◆ ListOrderGraphBlocksAsync()

async System.Threading.Tasks.Task<PagedResourceListOfOrderGraphBlock> Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphBlocksAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		bool?	useComplianceV2 = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
useComplianceV2	Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: 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 PagedResourceListOfOrderGraphBlock

Implements Lusid.Sdk.Api.IOrderGraphApiAsync.

◆ ListOrderGraphBlocksWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderGraphBlock> Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphBlocksWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		bool?	useComplianceV2 = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
useComplianceV2	Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: false) (optional, default to false)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfOrderGraphBlock

Implements Lusid.Sdk.Api.IOrderGraphApiSync.

◆ ListOrderGraphBlocksWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderGraphBlock> > Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphBlocksWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		bool?	useComplianceV2 = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
useComplianceV2	Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: 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 (PagedResourceListOfOrderGraphBlock)

Implements Lusid.Sdk.Api.IOrderGraphApiAsync.

◆ ListOrderGraphPlacementChildren()

PagedResourceListOfOrderGraphPlacement Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementChildren	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

scope	The parent placement's scope
code	The parent placement's code
asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfOrderGraphPlacement

Implements Lusid.Sdk.Api.IOrderGraphApiSync.

◆ ListOrderGraphPlacementChildrenAsync()

async System.Threading.Tasks.Task<PagedResourceListOfOrderGraphPlacement> Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementChildrenAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

scope	The parent placement's scope
code	The parent placement's code
asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfOrderGraphPlacement

Implements Lusid.Sdk.Api.IOrderGraphApiAsync.

◆ ListOrderGraphPlacementChildrenWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderGraphPlacement> Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementChildrenWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

scope	The parent placement's scope
code	The parent placement's code
asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfOrderGraphPlacement

Implements Lusid.Sdk.Api.IOrderGraphApiSync.

◆ ListOrderGraphPlacementChildrenWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderGraphPlacement> > Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementChildrenWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities. Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

scope	The parent placement's scope
code	The parent placement's code
asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfOrderGraphPlacement)

Implements Lusid.Sdk.Api.IOrderGraphApiAsync.

◆ ListOrderGraphPlacements()

PagedResourceListOfOrderGraphPlacement Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacements	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `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`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfOrderGraphPlacement

Implements Lusid.Sdk.Api.IOrderGraphApiSync.

◆ ListOrderGraphPlacementsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfOrderGraphPlacement> Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `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`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfOrderGraphPlacement

Implements Lusid.Sdk.Api.IOrderGraphApiAsync.

◆ ListOrderGraphPlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderGraphPlacement> Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `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`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfOrderGraphPlacement

Implements Lusid.Sdk.Api.IOrderGraphApiSync.

◆ ListOrderGraphPlacementsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderGraphPlacement> > Lusid.Sdk.Api.OrderGraphApi.ListOrderGraphPlacementsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	paginationToken = `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`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement's quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.

Exceptions

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

Parameters

asAt	See https://support.lusid.com/knowledgebase/article/KA-01832/ (optional)
paginationToken	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	See https://support.lusid.com/knowledgebase/article/KA-01915/ (optional)
filter	See https://support.lusid.com/knowledgebase/article/KA-01914/ (optional, default to "")
propertyKeys	Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfOrderGraphPlacement)

Implements Lusid.Sdk.Api.IOrderGraphApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.OrderGraphApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.OrderGraphApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.OrderGraphApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.OrderGraphApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ OrderGraphApi() [1/4]

◆ OrderGraphApi() [2/4]

◆ OrderGraphApi() [3/4]

◆ OrderGraphApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ ListOrderGraphBlocks()

◆ ListOrderGraphBlocksAsync()

◆ ListOrderGraphBlocksWithHttpInfo()

◆ ListOrderGraphBlocksWithHttpInfoAsync()

◆ ListOrderGraphPlacementChildren()

◆ ListOrderGraphPlacementChildrenAsync()

◆ ListOrderGraphPlacementChildrenWithHttpInfo()

◆ ListOrderGraphPlacementChildrenWithHttpInfoAsync()

◆ ListOrderGraphPlacements()

◆ ListOrderGraphPlacementsAsync()

◆ ListOrderGraphPlacementsWithHttpInfo()

◆ ListOrderGraphPlacementsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory