sdk.lusid.api.order_graph_api.OrderGraphApi

class OrderGraphApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

`list_order_graph_blocks`	ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities.
`list_order_graph_blocks_with_http_info`	ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities.
`list_order_graph_placement_children`	[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.
`list_order_graph_placement_children_with_http_info`	[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.
`list_order_graph_placements`	ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities.
`list_order_graph_placements_with_http_info`	ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities.

list_order_graph_blocks(as_at=None, pagination_token=None, sort_by=None, limit=None, filter=None, property_keys=None, use_compliance_v2=None, async_req=None, **kwargs)[source]

ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_order_graph_blocks(as_at, pagination_token, sort_by, limit, filter, property_keys, use_compliance_v2, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – See https://support.lusid.com/knowledgebase/article/KA-01832/
pagination_token (str) – See https://support.lusid.com/knowledgebase/article/KA-01915/
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – See https://support.lusid.com/knowledgebase/article/KA-01915/
filter (str) – See https://support.lusid.com/knowledgebase/article/KA-01914/
property_keys (List[str]) – Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
use_compliance_v2 (bool) – Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: false)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfOrderGraphBlock

list_order_graph_blocks_with_http_info(as_at=None, pagination_token=None, sort_by=None, limit=None, filter=None, property_keys=None, use_compliance_v2=None, **kwargs)[source]

ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_order_graph_blocks_with_http_info(as_at, pagination_token, sort_by, limit, filter, property_keys, use_compliance_v2, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – See https://support.lusid.com/knowledgebase/article/KA-01832/
pagination_token (str) – See https://support.lusid.com/knowledgebase/article/KA-01915/
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – See https://support.lusid.com/knowledgebase/article/KA-01915/
filter (str) – See https://support.lusid.com/knowledgebase/article/KA-01914/
property_keys (List[str]) – Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
use_compliance_v2 (bool) – Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: false)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfOrderGraphBlock, status_code(int), headers(HTTPHeaderDict))

list_order_graph_placement_children(scope, code, as_at=None, pagination_token=None, sort_by=None, limit=None, property_keys=None, async_req=None, **kwargs)[source]

[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. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_order_graph_placement_children(scope, code, as_at, pagination_token, sort_by, limit, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The parent placement’s scope (required)
code (str) – The parent placement’s code (required)
as_at (datetime) – See https://support.lusid.com/knowledgebase/article/KA-01832/
pagination_token (str) – See https://support.lusid.com/knowledgebase/article/KA-01915/
sort_by (List[str]) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName.
limit (int) – See https://support.lusid.com/knowledgebase/article/KA-01915/
property_keys (List[str]) – Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfOrderGraphPlacement

list_order_graph_placement_children_with_http_info(scope, code, as_at=None, pagination_token=None, sort_by=None, limit=None, property_keys=None, **kwargs)[source]

[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. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_order_graph_placement_children_with_http_info(scope, code, as_at, pagination_token, sort_by, limit, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The parent placement’s scope (required)
code (str) – The parent placement’s code (required)
as_at (datetime) – See https://support.lusid.com/knowledgebase/article/KA-01832/
pagination_token (str) – See https://support.lusid.com/knowledgebase/article/KA-01915/
sort_by (List[str]) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName.
limit (int) – See https://support.lusid.com/knowledgebase/article/KA-01915/
property_keys (List[str]) – Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfOrderGraphPlacement, status_code(int), headers(HTTPHeaderDict))

list_order_graph_placements(as_at=None, pagination_token=None, sort_by=None, limit=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]

ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_order_graph_placements(as_at, pagination_token, sort_by, limit, filter, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – See https://support.lusid.com/knowledgebase/article/KA-01832/
pagination_token (str) – See https://support.lusid.com/knowledgebase/article/KA-01915/
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – See https://support.lusid.com/knowledgebase/article/KA-01915/
filter (str) – See https://support.lusid.com/knowledgebase/article/KA-01914/
property_keys (List[str]) – Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfOrderGraphPlacement

list_order_graph_placements_with_http_info(as_at=None, pagination_token=None, sort_by=None, limit=None, filter=None, property_keys=None, **kwargs)[source]

ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_order_graph_placements_with_http_info(as_at, pagination_token, sort_by, limit, filter, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – See https://support.lusid.com/knowledgebase/article/KA-01832/
pagination_token (str) – See https://support.lusid.com/knowledgebase/article/KA-01915/
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – See https://support.lusid.com/knowledgebase/article/KA-01915/
filter (str) – See https://support.lusid.com/knowledgebase/article/KA-01914/
property_keys (List[str]) – Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfOrderGraphPlacement, status_code(int), headers(HTTPHeaderDict))