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

Inheritance diagram for Lusid.Sdk.Api.IResourceRecordApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteResourceRecord (string scope, string code, string resourceId, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteResourceRecord: 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 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 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 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 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 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 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 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 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 More...

ResourceRecord	UpsertResourceRecord (UpsertResourceRecordRequest upsertResourceRecordRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertResourceRecord: Upsert 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 More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteResourceRecord()

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

[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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ DeleteResourceRecordWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ GetResourceRecord()

ResourceRecord Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ GetResourceRecordWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceRecord> Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ ListResourceRecordCodes()

ResourceListOfString Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ ListResourceRecordCodesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfString> Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ ListResourceRecords()

PagedResourceListOfResourceRecord Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ ListResourceRecordScopes()

ResourceListOfScopeDefinition Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ ListResourceRecordScopesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ ListResourceRecordsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfResourceRecord> Lusid.Sdk.Api.IResourceRecordApiSync.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.

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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ UpsertResourceRecord()

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

[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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

◆ UpsertResourceRecordWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.ResourceRecordApi.

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/ResourceRecordApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ DeleteResourceRecord()

◆ DeleteResourceRecordWithHttpInfo()

◆ GetResourceRecord()

◆ GetResourceRecordWithHttpInfo()

◆ ListResourceRecordCodes()

◆ ListResourceRecordCodesWithHttpInfo()

◆ ListResourceRecords()

◆ ListResourceRecordScopes()

◆ ListResourceRecordScopesWithHttpInfo()

◆ ListResourceRecordsWithHttpInfo()

◆ UpsertResourceRecord()

◆ UpsertResourceRecordWithHttpInfo()