LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
PlacementsApi () | |
Initializes a new instance of the PlacementsApi class. More... | |
PlacementsApi (string basePath) | |
Initializes a new instance of the PlacementsApi class. More... | |
PlacementsApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the PlacementsApi class using Configuration object More... | |
PlacementsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the PlacementsApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
DeletedEntityResponse | DeletePlacement (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeletePlacementWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
async System.Threading.Tasks.Task< DeletedEntityResponse > | DeletePlacementAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeletePlacementWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
Placement | GetPlacement (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier More... | |
Lusid.Sdk.Client.ApiResponse< Placement > | GetPlacementWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier More... | |
async System.Threading.Tasks.Task< Placement > | GetPlacementAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Placement > > | GetPlacementWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier More... | |
PagedResourceListOfPlacement | ListPlacements (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history). More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPlacement > | ListPlacementsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< PagedResourceListOfPlacement > | ListPlacementsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPlacement > > | ListPlacementsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history). More... | |
ResourceListOfPlacement | UpsertPlacements (PlacementSetRequest? placementSetRequest=default(PlacementSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfPlacement > | UpsertPlacementsWithHttpInfo (PlacementSetRequest? placementSetRequest=default(PlacementSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise. More... | |
async System.Threading.Tasks.Task< ResourceListOfPlacement > | UpsertPlacementsAsync (PlacementSetRequest? placementSetRequest=default(PlacementSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPlacement > > | UpsertPlacementsWithHttpInfoAsync (PlacementSetRequest? placementSetRequest=default(PlacementSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise. 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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the PlacementsApi class.
|
inline |
Initializes a new instance of the PlacementsApi class.
|
inline |
Initializes a new instance of the PlacementsApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the PlacementsApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The placement scope. |
code | The placement's code. This, together with the scope uniquely identifies the placement to delete. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The placement scope. |
code | The placement's code. This, together with the scope uniquely identifies the placement to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The placement scope. |
code | The placement's code. This, together with the scope uniquely identifies the placement to delete. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] DeletePlacement: Delete placement Delete an placement. Deletion will be valid from the placement's creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The placement scope. |
code | The placement's code. This, together with the scope uniquely identifies the placement to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
Gets the base path of the API client.
The base path
|
inline |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the placement belongs. |
code | The placement's unique identifier. |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". Property keys from the instrument domain can also be decorated onto the placement, e.g. "Instrument/default/Isin". These are only decorated if requested. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the placement belongs. |
code | The placement's unique identifier. |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". Property keys from the instrument domain can also be decorated onto the placement, e.g. "Instrument/default/Isin". These are only decorated if requested. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the placement belongs. |
code | The placement's unique identifier. |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". Property keys from the instrument domain can also be decorated onto the placement, e.g. "Instrument/default/Isin". These are only decorated if requested. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the placement belongs. |
code | The placement's unique identifier. |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". Property keys from the instrument domain can also be decorated onto the placement, e.g. "Instrument/default/Isin". These are only decorated if requested. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
page | The pagination token to use to continue listing placements from a previous call to list placements. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". All properties, except derived properties, are returned by default, without specifying here. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
page | The pagination token to use to continue listing placements from a previous call to list placements. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". All properties, except derived properties, are returned by default, without specifying here. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
page | The pagination token to use to continue listing placements from a previous call to list placements. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". All properties, except derived properties, are returned by default, without specifying here. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified. (optional) |
page | The pagination token to use to continue listing placements from a previous call to list placements. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
propertyKeys | A list of property keys from the "Placement" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. "Placement/system/Name". All properties, except derived properties, are returned by default, without specifying here. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
placementSetRequest | The collection of placement requests. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
placementSetRequest | The collection of placement requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
inline |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
placementSetRequest | The collection of placement requests. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiSync.
|
inline |
[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
placementSetRequest | The collection of placement requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IPlacementsApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.