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

Inheritance diagram for Lusid.Sdk.Api.IPlacementsApiAsync:

[legend]

Public Member Functions
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 More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePlacementWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeletePlacement: Delete placement More...

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

System.Threading.Tasks.Task< 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 More...

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

System.Threading.Tasks.Task< 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 More...

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

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPlacement > >	UpsertPlacementsWithHttpInfoAsync (PlacementSetRequest? placementSetRequest=default(PlacementSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertPlacements: Upsert Placement More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeletePlacementAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPlacementsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ DeletePlacementWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPlacementsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ GetPlacementAsync()

System.Threading.Tasks.Task<Placement> Lusid.Sdk.Api.IPlacementsApiAsync.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

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

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ GetPlacementWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Placement> > Lusid.Sdk.Api.IPlacementsApiAsync.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

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)

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ ListPlacementsAsync()

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

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

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ ListPlacementsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfPlacement> > Lusid.Sdk.Api.IPlacementsApiAsync.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).

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)

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ UpsertPlacementsAsync()

System.Threading.Tasks.Task<ResourceListOfPlacement> Lusid.Sdk.Api.IPlacementsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.PlacementsApi.

◆ UpsertPlacementsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPlacement> > Lusid.Sdk.Api.IPlacementsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.PlacementsApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/PlacementsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeletePlacementAsync()

◆ DeletePlacementWithHttpInfoAsync()

◆ GetPlacementAsync()

◆ GetPlacementWithHttpInfoAsync()

◆ ListPlacementsAsync()

◆ ListPlacementsWithHttpInfoAsync()

◆ UpsertPlacementsAsync()

◆ UpsertPlacementsWithHttpInfoAsync()