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

Inheritance diagram for Lusid.Sdk.Api.ResourceRecordApi:

[legend]

Public Member Functions
	ResourceRecordApi ()
	Initializes a new instance of the ResourceRecordApi class. More...

	ResourceRecordApi (string basePath)
	Initializes a new instance of the ResourceRecordApi class. More...

	ResourceRecordApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the ResourceRecordApi class using Configuration object More...

	ResourceRecordApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the ResourceRecordApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

DeletedEntityResponse	DeleteResourceRecord (string scope, string code, string resourceId, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteResourceRecordWithHttpInfo (string scope, string code, string resourceId, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteResourceRecordAsync (string scope, string code, string resourceId, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteResourceRecordWithHttpInfoAsync (string scope, string code, string resourceId, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record. More...

ResourceRecord	GetResourceRecord (string scope, string code, string resourceId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier. More...

Lusid.Sdk.Client.ApiResponse< ResourceRecord >	GetResourceRecordWithHttpInfo (string scope, string code, string resourceId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier. More...

async System.Threading.Tasks.Task< ResourceRecord >	GetResourceRecordAsync (string scope, string code, string resourceId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceRecord > >	GetResourceRecordWithHttpInfoAsync (string scope, string code, string resourceId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier. More...

ResourceListOfString	ListResourceRecordCodes (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? sortOrder=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfString >	ListResourceRecordCodesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? sortOrder=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria. More...

async System.Threading.Tasks.Task< ResourceListOfString >	ListResourceRecordCodesAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? sortOrder=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfString > >	ListResourceRecordCodesWithHttpInfoAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? sortOrder=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria. More...

ResourceListOfScopeDefinition	ListResourceRecordScopes (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition >	ListResourceRecordScopesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria. More...

async System.Threading.Tasks.Task< ResourceListOfScopeDefinition >	ListResourceRecordScopesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > >	ListResourceRecordScopesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria. More...

PagedResourceListOfResourceRecord	ListResourceRecords (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfResourceRecord >	ListResourceRecordsWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria. More...

async System.Threading.Tasks.Task< PagedResourceListOfResourceRecord >	ListResourceRecordsAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfResourceRecord > >	ListResourceRecordsWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria. More...

ResourceRecord	UpsertResourceRecord (UpsertResourceRecordRequest upsertResourceRecordRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record. More...

Lusid.Sdk.Client.ApiResponse< ResourceRecord >	UpsertResourceRecordWithHttpInfo (UpsertResourceRecordRequest upsertResourceRecordRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record. More...

async System.Threading.Tasks.Task< ResourceRecord >	UpsertResourceRecordAsync (UpsertResourceRecordRequest upsertResourceRecordRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceRecord > >	UpsertResourceRecordWithHttpInfoAsync (UpsertResourceRecordRequest upsertResourceRecordRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record. 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...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ ResourceRecordApi() [1/4]

Lusid.Sdk.Api.ResourceRecordApi.ResourceRecordApi ( )

inline

Initializes a new instance of the ResourceRecordApi class.

Returns

◆ ResourceRecordApi() [2/4]

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

inline

Initializes a new instance of the ResourceRecordApi class.

Returns

◆ ResourceRecordApi() [3/4]

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

inline

Initializes a new instance of the ResourceRecordApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ ResourceRecordApi() [4/4]

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

inline

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

◆ DeleteResourceRecord()

DeletedEntityResponse Lusid.Sdk.Api.ResourceRecordApi.DeleteResourceRecord	(	string	scope,
		string	code,
		string	resourceId,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ DeleteResourceRecordAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ResourceRecordApi.DeleteResourceRecordAsync	(	string	scope,
		string	code,
		string	resourceId,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ DeleteResourceRecordWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ResourceRecordApi.DeleteResourceRecordWithHttpInfo	(	string	scope,
		string	code,
		string	resourceId,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ DeleteResourceRecordWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ResourceRecordApi.DeleteResourceRecordWithHttpInfoAsync	(	string	scope,
		string	code,
		string	resourceId,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record Delete a resource record.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ GetResourceRecord()

ResourceRecord Lusid.Sdk.Api.ResourceRecordApi.GetResourceRecord	(	string	scope,
		string	code,
		string	resourceId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ GetResourceRecordAsync()

async System.Threading.Tasks.Task<ResourceRecord> Lusid.Sdk.Api.ResourceRecordApi.GetResourceRecordAsync	(	string	scope,
		string	code,
		string	resourceId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ GetResourceRecordWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceRecord> Lusid.Sdk.Api.ResourceRecordApi.GetResourceRecordWithHttpInfo	(	string	scope,
		string	code,
		string	resourceId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ GetResourceRecordWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceRecord> > Lusid.Sdk.Api.ResourceRecordApi.GetResourceRecordWithHttpInfoAsync	(	string	scope,
		string	code,
		string	resourceId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetResourceRecord: Get a Resource Record Retrieve a resource record by its identifier.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
resourceId	The resource identifier of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceRecord)

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ ListResourceRecordCodes()

ResourceListOfString Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordCodes	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	sortOrder = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
sortOrder	Order of the sort - either "ASC" or "DESC" (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfString

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ ListResourceRecordCodesAsync()

async System.Threading.Tasks.Task<ResourceListOfString> Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordCodesAsync	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	sortOrder = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
sortOrder	Order of the sort - either "ASC" or "DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfString

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ ListResourceRecordCodesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfString> Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordCodesWithHttpInfo	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	sortOrder = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
sortOrder	Order of the sort - either "ASC" or "DESC" (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfString

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ ListResourceRecordCodesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfString> > Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordCodesWithHttpInfoAsync	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	sortOrder = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
sortOrder	Order of the sort - either "ASC" or "DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfString)

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ ListResourceRecords()

PagedResourceListOfResourceRecord Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecords	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
sortBy	A list of field names 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. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ ListResourceRecordsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfResourceRecord> Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordsAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
sortBy	A list of field names 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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ ListResourceRecordScopes()

ResourceListOfScopeDefinition Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordScopes	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ ListResourceRecordScopesAsync()

async System.Threading.Tasks.Task<ResourceListOfScopeDefinition> Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordScopesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ ListResourceRecordScopesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordScopesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ ListResourceRecordScopesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordScopesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes List all resource records matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfScopeDefinition)

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ ListResourceRecordsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfResourceRecord> Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordsWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
sortBy	A list of field names 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. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ ListResourceRecordsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfResourceRecord> > Lusid.Sdk.Api.ResourceRecordApi.ListResourceRecordsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListResourceRecords: List Resource Records List all resource records matching particular criteria.

Exceptions

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

Parameters

scope	The scope of the resource record.
code	The code of the resource record.
asAt	The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing resource records from a previous call. (optional)
sortBy	A list of field names 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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfResourceRecord)

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ UpsertResourceRecord()

ResourceRecord Lusid.Sdk.Api.ResourceRecordApi.UpsertResourceRecord	(	UpsertResourceRecordRequest	upsertResourceRecordRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record.

Exceptions

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

Parameters

upsertResourceRecordRequest	The resource record to upsert.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ UpsertResourceRecordAsync()

async System.Threading.Tasks.Task<ResourceRecord> Lusid.Sdk.Api.ResourceRecordApi.UpsertResourceRecordAsync	(	UpsertResourceRecordRequest	upsertResourceRecordRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record.

Exceptions

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

Parameters

upsertResourceRecordRequest	The resource record to upsert.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

◆ UpsertResourceRecordWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceRecord> Lusid.Sdk.Api.ResourceRecordApi.UpsertResourceRecordWithHttpInfo	(	UpsertResourceRecordRequest	upsertResourceRecordRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record.

Exceptions

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

Parameters

upsertResourceRecordRequest	The resource record to upsert.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceRecord

Implements Lusid.Sdk.Api.IResourceRecordApiSync.

◆ UpsertResourceRecordWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceRecord> > Lusid.Sdk.Api.ResourceRecordApi.UpsertResourceRecordWithHttpInfoAsync	(	UpsertResourceRecordRequest	upsertResourceRecordRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record Create or update a resource record.

Exceptions

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

Parameters

upsertResourceRecordRequest	The resource record to upsert.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceRecord)

Implements Lusid.Sdk.Api.IResourceRecordApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ResourceRecordApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ResourceRecordApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ResourceRecordApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ResourceRecordApi() [1/4]

◆ ResourceRecordApi() [2/4]

◆ ResourceRecordApi() [3/4]

◆ ResourceRecordApi() [4/4]

Member Function Documentation

◆ DeleteResourceRecord()

◆ DeleteResourceRecordAsync()

◆ DeleteResourceRecordWithHttpInfo()

◆ DeleteResourceRecordWithHttpInfoAsync()

◆ GetBasePath()

◆ GetResourceRecord()

◆ GetResourceRecordAsync()

◆ GetResourceRecordWithHttpInfo()

◆ GetResourceRecordWithHttpInfoAsync()

◆ ListResourceRecordCodes()

◆ ListResourceRecordCodesAsync()

◆ ListResourceRecordCodesWithHttpInfo()

◆ ListResourceRecordCodesWithHttpInfoAsync()

◆ ListResourceRecords()

◆ ListResourceRecordsAsync()

◆ ListResourceRecordScopes()

◆ ListResourceRecordScopesAsync()

◆ ListResourceRecordScopesWithHttpInfo()

◆ ListResourceRecordScopesWithHttpInfoAsync()

◆ ListResourceRecordsWithHttpInfo()

◆ ListResourceRecordsWithHttpInfoAsync()

◆ UpsertResourceRecord()

◆ UpsertResourceRecordAsync()

◆ UpsertResourceRecordWithHttpInfo()

◆ UpsertResourceRecordWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory