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

Inheritance diagram for Lusid.Sdk.Api.IOrderGraphApiSync:

[legend]

Public Member Functions
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)
	[EARLY ACCESS] ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. More...

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)
	[EARLY ACCESS] ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. 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)
	[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. More...

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)
	[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. 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)
	[EARLY ACCESS] ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. More...

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)
	[EARLY ACCESS] ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. 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

◆ ListOrderGraphBlocks()

PagedResourceListOfOrderGraphBlock Lusid.Sdk.Api.IOrderGraphApiSync.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`
	)

[EARLY ACCESS] 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.

Returns: PagedResourceListOfOrderGraphBlock

Implemented in Lusid.Sdk.Api.OrderGraphApi.

◆ ListOrderGraphBlocksWithHttpInfo()

ApiResponse<PagedResourceListOfOrderGraphBlock> Lusid.Sdk.Api.IOrderGraphApiSync.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`
	)

[EARLY ACCESS] 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.

Returns: ApiResponse of PagedResourceListOfOrderGraphBlock

Implemented in Lusid.Sdk.Api.OrderGraphApi.

◆ ListOrderGraphPlacementChildren()

PagedResourceListOfOrderGraphPlacement Lusid.Sdk.Api.IOrderGraphApiSync.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`
	)

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

Returns: PagedResourceListOfOrderGraphPlacement

Implemented in Lusid.Sdk.Api.OrderGraphApi.

◆ ListOrderGraphPlacementChildrenWithHttpInfo()

ApiResponse<PagedResourceListOfOrderGraphPlacement> Lusid.Sdk.Api.IOrderGraphApiSync.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`
	)

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

Returns: ApiResponse of PagedResourceListOfOrderGraphPlacement

Implemented in Lusid.Sdk.Api.OrderGraphApi.

◆ ListOrderGraphPlacements()

PagedResourceListOfOrderGraphPlacement Lusid.Sdk.Api.IOrderGraphApiSync.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`
	)

[EARLY ACCESS] 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.

Returns: PagedResourceListOfOrderGraphPlacement

Implemented in Lusid.Sdk.Api.OrderGraphApi.

◆ ListOrderGraphPlacementsWithHttpInfo()

ApiResponse<PagedResourceListOfOrderGraphPlacement> Lusid.Sdk.Api.IOrderGraphApiSync.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`
	)

[EARLY ACCESS] 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.

Returns: ApiResponse of PagedResourceListOfOrderGraphPlacement

Implemented in Lusid.Sdk.Api.OrderGraphApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ListOrderGraphBlocks()

◆ ListOrderGraphBlocksWithHttpInfo()

◆ ListOrderGraphPlacementChildren()

◆ ListOrderGraphPlacementChildrenWithHttpInfo()

◆ ListOrderGraphPlacements()

◆ ListOrderGraphPlacementsWithHttpInfo()