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

Inheritance diagram for Lusid.Sdk.Api.PlacementsApi:

[legend]

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

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

◆ PlacementsApi() [1/4]

Lusid.Sdk.Api.PlacementsApi.PlacementsApi ( )

inline

Initializes a new instance of the PlacementsApi class.

Returns

◆ PlacementsApi() [2/4]

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

inline

Initializes a new instance of the PlacementsApi class.

Returns

◆ PlacementsApi() [3/4]

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

inline

Initializes a new instance of the PlacementsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ PlacementsApi() [4/4]

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

inline

Initializes a new instance of the PlacementsApi 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

◆ DeletePlacement()

DeletedEntityResponse Lusid.Sdk.Api.PlacementsApi.DeletePlacement	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

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.

Exceptions

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

Parameters

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.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ DeletePlacementAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PlacementsApi.DeletePlacementAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.

Exceptions

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

Parameters

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.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ DeletePlacementWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PlacementsApi.DeletePlacementWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

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.

Exceptions

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

Parameters

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.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ DeletePlacementWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PlacementsApi.DeletePlacementWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.

Exceptions

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

Parameters

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.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetPlacement()

Placement Lusid.Sdk.Api.PlacementsApi.GetPlacement	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier

Exceptions

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

Parameters

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.

Returns: Placement

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ GetPlacementAsync()

async System.Threading.Tasks.Task<Placement> Lusid.Sdk.Api.PlacementsApi.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)`
	)

inline

[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier

Exceptions

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

Parameters

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.

Returns: Task of Placement

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ GetPlacementWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Placement> Lusid.Sdk.Api.PlacementsApi.GetPlacementWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier

Exceptions

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

Parameters

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.

Returns: ApiResponse of Placement

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ GetPlacementWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Placement> > Lusid.Sdk.Api.PlacementsApi.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)`
	)

inline

[EARLY ACCESS] GetPlacement: Get Placement Fetch a Placement that matches the specified identifier

Exceptions

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

Parameters

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.

Returns: Task of ApiResponse (Placement)

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ ListPlacements()

PagedResourceListOfPlacement Lusid.Sdk.Api.PlacementsApi.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`
	)

inline

[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).

Exceptions

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

Parameters

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". (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfPlacement

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ ListPlacementsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPlacement> Lusid.Sdk.Api.PlacementsApi.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)`
	)

inline

[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).

Exceptions

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

Parameters

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". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPlacement

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ ListPlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPlacement> Lusid.Sdk.Api.PlacementsApi.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`
	)

inline

[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).

Exceptions

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

Parameters

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". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfPlacement

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ ListPlacementsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPlacement> > Lusid.Sdk.Api.PlacementsApi.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)`
	)

inline

[EARLY ACCESS] ListPlacements: List Placements Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).

Exceptions

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

Parameters

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". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPlacement)

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ UpsertPlacements()

ResourceListOfPlacement Lusid.Sdk.Api.PlacementsApi.UpsertPlacements	(	PlacementSetRequest?	placementSetRequest = `default(PlacementSetRequest?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.

Exceptions

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

Parameters

placementSetRequest	The collection of placement requests. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfPlacement

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ UpsertPlacementsAsync()

async System.Threading.Tasks.Task<ResourceListOfPlacement> Lusid.Sdk.Api.PlacementsApi.UpsertPlacementsAsync	(	PlacementSetRequest?	placementSetRequest = `default(PlacementSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.

Exceptions

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

Parameters

placementSetRequest	The collection of placement requests. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPlacement

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

◆ UpsertPlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPlacement> Lusid.Sdk.Api.PlacementsApi.UpsertPlacementsWithHttpInfo	(	PlacementSetRequest?	placementSetRequest = `default(PlacementSetRequest?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.

Exceptions

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

Parameters

placementSetRequest	The collection of placement requests. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfPlacement

Implements Lusid.Sdk.Api.IPlacementsApiSync.

◆ UpsertPlacementsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPlacement> > Lusid.Sdk.Api.PlacementsApi.UpsertPlacementsWithHttpInfoAsync	(	PlacementSetRequest?	placementSetRequest = `default(PlacementSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpsertPlacements: Upsert Placement Upsert; update existing placements with given ids, or create new placements otherwise.

Exceptions

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

Parameters

placementSetRequest	The collection of placement requests. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPlacement)

Implements Lusid.Sdk.Api.IPlacementsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.PlacementsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.PlacementsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.PlacementsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.PlacementsApi.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/PlacementsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PlacementsApi() [1/4]

◆ PlacementsApi() [2/4]

◆ PlacementsApi() [3/4]

◆ PlacementsApi() [4/4]

Member Function Documentation

◆ DeletePlacement()

◆ DeletePlacementAsync()

◆ DeletePlacementWithHttpInfo()

◆ DeletePlacementWithHttpInfoAsync()

◆ GetBasePath()

◆ GetPlacement()

◆ GetPlacementAsync()

◆ GetPlacementWithHttpInfo()

◆ GetPlacementWithHttpInfoAsync()

◆ ListPlacements()

◆ ListPlacementsAsync()

◆ ListPlacementsWithHttpInfo()

◆ ListPlacementsWithHttpInfoAsync()

◆ UpsertPlacements()

◆ UpsertPlacementsAsync()

◆ UpsertPlacementsWithHttpInfo()

◆ UpsertPlacementsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory