Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.OrderGraphApi:
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) |
| [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. 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) |
| [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. 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)) |
| [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. 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)) |
| [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. 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. 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) |
| [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)) |
| [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)) |
| [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) |
| [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. 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) |
| [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. 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)) |
| [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. 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)) |
| [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. 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]
|
inline |
Initializes a new instance of the OrderGraphApi class.
- Returns
◆ OrderGraphApi() [2/4]
|
inline |
Initializes a new instance of the OrderGraphApi class.
- Returns
◆ OrderGraphApi() [3/4]
|
inline |
Initializes a new instance of the OrderGraphApi class using Configuration object
- Parameters
-
configuration An instance of Configuration
- Returns
◆ OrderGraphApi() [4/4]
|
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()
|
inline |
◆ ListOrderGraphBlocks()
|
inline |
[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
Implements Lusid.Sdk.Api.IOrderGraphApiSync.
◆ ListOrderGraphBlocksAsync()
|
inline |
[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. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PagedResourceListOfOrderGraphBlock
Implements Lusid.Sdk.Api.IOrderGraphApiAsync.
◆ ListOrderGraphBlocksWithHttpInfo()
|
inline |
[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
Implements Lusid.Sdk.Api.IOrderGraphApiSync.
◆ ListOrderGraphBlocksWithHttpInfoAsync()
|
inline |
[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. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PagedResourceListOfOrderGraphBlock)
Implements Lusid.Sdk.Api.IOrderGraphApiAsync.
◆ ListOrderGraphPlacementChildren()
|
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.
- Returns
- PagedResourceListOfOrderGraphPlacement
Implements Lusid.Sdk.Api.IOrderGraphApiSync.
◆ ListOrderGraphPlacementChildrenAsync()
|
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.
- Returns
- Task of PagedResourceListOfOrderGraphPlacement
Implements Lusid.Sdk.Api.IOrderGraphApiAsync.
◆ ListOrderGraphPlacementChildrenWithHttpInfo()
|
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.
- Returns
- ApiResponse of PagedResourceListOfOrderGraphPlacement
Implements Lusid.Sdk.Api.IOrderGraphApiSync.
◆ ListOrderGraphPlacementChildrenWithHttpInfoAsync()
|
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.
- Returns
- Task of ApiResponse (PagedResourceListOfOrderGraphPlacement)
Implements Lusid.Sdk.Api.IOrderGraphApiAsync.
◆ ListOrderGraphPlacements()
|
inline |
[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
Implements Lusid.Sdk.Api.IOrderGraphApiSync.
◆ ListOrderGraphPlacementsAsync()
|
inline |
[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. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PagedResourceListOfOrderGraphPlacement
Implements Lusid.Sdk.Api.IOrderGraphApiAsync.
◆ ListOrderGraphPlacementsWithHttpInfo()
|
inline |
[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
Implements Lusid.Sdk.Api.IOrderGraphApiSync.
◆ ListOrderGraphPlacementsWithHttpInfoAsync()
|
inline |
[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. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PagedResourceListOfOrderGraphPlacement)
Implements Lusid.Sdk.Api.IOrderGraphApiAsync.
Property Documentation
◆ AsynchronousClient
|
getset |
The client for accessing this underlying API asynchronously.
◆ Client
|
getset |
The client for accessing this underlying API synchronously.
◆ Configuration
|
getset |
Gets or sets the configuration object
An instance of the Configuration
◆ 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
