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

Inheritance diagram for Lusid.Sdk.Api.ICustomEntitiesApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteCustomEntityAsync (string entityType, string identifierType, string identifierValue, string identifierScope, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	DeleteCustomEntity: Delete a Custom Entity instance. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteCustomEntityWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	DeleteCustomEntity: Delete a Custom Entity instance. More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry More...

System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > >	GetAllCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > >	GetAllCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity More...

System.Threading.Tasks.Task< CustomEntityResponse >	GetCustomEntityAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetCustomEntity: Get a Custom Entity instance. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityResponse > >	GetCustomEntityWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetCustomEntity: Get a Custom Entity instance. More...

System.Threading.Tasks.Task< List< AccessMetadataValue > >	GetCustomEntityAccessMetadataByKeyAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > >	GetCustomEntityAccessMetadataByKeyWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity More...

System.Threading.Tasks.Task< ResourceListOfRelationship >	GetCustomEntityRelationshipsAsync (string entityType, string identifierScope, string identifierType, string identifierValue, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > >	GetCustomEntityRelationshipsWithHttpInfoAsync (string entityType, string identifierScope, string identifierType, string identifierValue, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity More...

System.Threading.Tasks.Task< PagedResourceListOfCustomEntityResponse >	ListCustomEntitiesAsync (string entityType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListCustomEntities: List Custom Entities of the specified entityType. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCustomEntityResponse > >	ListCustomEntitiesWithHttpInfoAsync (string entityType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListCustomEntities: List Custom Entities of the specified entityType. More...

System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > >	PatchCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > >	PatchCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. More...

System.Threading.Tasks.Task< UpsertCustomEntitiesResponse >	UpsertCustomEntitiesAsync (string entityType, string successMode, Dictionary< string, CustomEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertCustomEntitiesResponse > >	UpsertCustomEntitiesWithHttpInfoAsync (string entityType, string successMode, Dictionary< string, CustomEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities More...

System.Threading.Tasks.Task< CustomEntityResponse >	UpsertCustomEntityAsync (string entityType, CustomEntityRequest customEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpsertCustomEntity: Upsert a Custom Entity instance More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomEntityResponse > >	UpsertCustomEntityWithHttpInfoAsync (string entityType, CustomEntityRequest customEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpsertCustomEntity: Upsert a Custom Entity instance More...

System.Threading.Tasks.Task< List< AccessMetadataValue > >	UpsertCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, UpsertCustomEntityAccessMetadataRequest upsertCustomEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > >	UpsertCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, UpsertCustomEntityAccessMetadataRequest upsertCustomEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteCustomEntityAccessMetadataAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ICustomEntitiesApiAsync.DeleteCustomEntityAccessMetadataAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry

Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
metadataKey	Key of the metadata entry to delete.
identifierScope	The identifier scope.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata. (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ DeleteCustomEntityAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.DeleteCustomEntityAccessMetadataWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry

Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
metadataKey	Key of the metadata entry to delete.
identifierScope	The identifier scope.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata. (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ DeleteCustomEntityAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ICustomEntitiesApiAsync.DeleteCustomEntityAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

DeleteCustomEntity: Delete a Custom Entity instance.

Delete a Custom Entity instance by a specific entity type.

Exceptions

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

Parameters

entityType	The type of Custom Entity to remove.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ DeleteCustomEntityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.DeleteCustomEntityWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

DeleteCustomEntity: Delete a Custom Entity instance.

Delete a Custom Entity instance by a specific entity type.

Exceptions

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

Parameters

entityType	The type of Custom Entity to remove.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetAllCustomEntityAccessMetadataAsync()

System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetAllCustomEntityAccessMetadataAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity

Get all the Custom Entity access metadata for the specified identifier scope, code and value

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
effectiveAt	The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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 Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetAllCustomEntityAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetAllCustomEntityAccessMetadataWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity

Get all the Custom Entity access metadata for the specified identifier scope, code and value

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
effectiveAt	The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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 (Dictionary<string, List<AccessMetadataValue>>)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetCustomEntityAccessMetadataByKeyAsync()

System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetCustomEntityAccessMetadataByKeyAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity

Get Custom Entity access metadata for the specified metadata key

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
metadataKey	Key of the metadata entry to retrieve
identifierScope	The identifier scope.
effectiveAt	The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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 List<AccessMetadataValue>

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetCustomEntityAccessMetadataByKeyWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetCustomEntityAccessMetadataByKeyWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity

Get Custom Entity access metadata for the specified metadata key

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
metadataKey	Key of the metadata entry to retrieve
identifierScope	The identifier scope.
effectiveAt	The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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 (List<AccessMetadataValue>)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetCustomEntityAsync()

System.Threading.Tasks.Task<CustomEntityResponse> Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetCustomEntityAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	relatedEntityPropertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

GetCustomEntity: Get a Custom Entity instance.

Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time.

Exceptions

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

Parameters

entityType	The type of Custom Entity to retrieve. An entityType can be created using the "CreateCustomEntityDefinition" endpoint for CustomEntityDefinitions.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
asAt	The AsAt datetime at which to retrieve the Custom Entity instance. (optional)
effectiveAt	The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified. (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CustomEntityResponse

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetCustomEntityRelationshipsAsync()

System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetCustomEntityRelationshipsAsync	(	string	entityType,
		string	identifierScope,
		string	identifierType,
		string	identifierValue,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity

Get relationships for the specified Custom Entity.

Exceptions

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

Parameters

entityType	The type of entity get relationships for.
identifierScope	The identifier scope.
identifierType	An identifier type attached to the Custom Entity.
identifierValue	The identifier value.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetCustomEntityRelationshipsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetCustomEntityRelationshipsWithHttpInfoAsync	(	string	entityType,
		string	identifierScope,
		string	identifierType,
		string	identifierValue,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity

Get relationships for the specified Custom Entity.

Exceptions

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

Parameters

entityType	The type of entity get relationships for.
identifierScope	The identifier scope.
identifierType	An identifier type attached to the Custom Entity.
identifierValue	The identifier value.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfRelationship)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ GetCustomEntityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityResponse> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.GetCustomEntityWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	relatedEntityPropertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

GetCustomEntity: Get a Custom Entity instance.

Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time.

Exceptions

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

Parameters

entityType	The type of Custom Entity to retrieve. An entityType can be created using the "CreateCustomEntityDefinition" endpoint for CustomEntityDefinitions.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
asAt	The AsAt datetime at which to retrieve the Custom Entity instance. (optional)
effectiveAt	The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified. (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CustomEntityResponse)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ ListCustomEntitiesAsync()

System.Threading.Tasks.Task<PagedResourceListOfCustomEntityResponse> Lusid.Sdk.Api.ICustomEntitiesApiAsync.ListCustomEntitiesAsync	(	string	entityType,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		string?	page = `default(string?)`,
		List< string >?	relatedEntityPropertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

ListCustomEntities: List Custom Entities of the specified entityType.

List all the Custom Entities matching particular criteria.

Exceptions

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

Parameters

entityType	The type of Custom Entity to list.
effectiveAt	The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfCustomEntityResponse

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ ListCustomEntitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCustomEntityResponse> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.ListCustomEntitiesWithHttpInfoAsync	(	string	entityType,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		string?	page = `default(string?)`,
		List< string >?	relatedEntityPropertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

ListCustomEntities: List Custom Entities of the specified entityType.

List all the Custom Entities matching particular criteria.

Exceptions

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

Parameters

entityType	The type of Custom Entity to list.
effectiveAt	The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfCustomEntityResponse)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ PatchCustomEntityAccessMetadataAsync()

System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.ICustomEntitiesApiAsync.PatchCustomEntityAccessMetadataAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity.

Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which the Access Metadata will be effective from (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ PatchCustomEntityAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.ICustomEntitiesApiAsync.PatchCustomEntityAccessMetadataWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	identifierScope,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity.

Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
identifierScope	The identifier scope.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which the Access Metadata will be effective from (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ UpsertCustomEntitiesAsync()

System.Threading.Tasks.Task<UpsertCustomEntitiesResponse> Lusid.Sdk.Api.ICustomEntitiesApiAsync.UpsertCustomEntitiesAsync	(	string	entityType,
		string	successMode,
		Dictionary< string, CustomEntityRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities

Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code

Exceptions

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

Parameters

entityType	The type of the Custom Entity to be created. An entityType can be created using the "CreateCustomEntityDefinition" endpoint for CustomEntityDefinitions.
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBody	The payload describing the Custom Entity instances
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of UpsertCustomEntitiesResponse

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ UpsertCustomEntitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertCustomEntitiesResponse> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.UpsertCustomEntitiesWithHttpInfoAsync	(	string	entityType,
		string	successMode,
		Dictionary< string, CustomEntityRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities

Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code

Exceptions

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

Parameters

entityType	The type of the Custom Entity to be created. An entityType can be created using the "CreateCustomEntityDefinition" endpoint for CustomEntityDefinitions.
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBody	The payload describing the Custom Entity instances
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (UpsertCustomEntitiesResponse)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ UpsertCustomEntityAccessMetadataAsync()

System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.UpsertCustomEntityAccessMetadataAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	identifierScope,
		UpsertCustomEntityAccessMetadataRequest	upsertCustomEntityAccessMetadataRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.

Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
metadataKey	Key of the metadata entry to retrieve
identifierScope	The identifier scope.
upsertCustomEntityAccessMetadataRequest	The Custom Entity Access Metadata entry to upsert
effectiveAt	The effectiveAt datetime at which the Access Metadata will be effective from (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of List<AccessMetadataValue>

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ UpsertCustomEntityAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.ICustomEntitiesApiAsync.UpsertCustomEntityAccessMetadataWithHttpInfoAsync	(	string	entityType,
		string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	identifierScope,
		UpsertCustomEntityAccessMetadataRequest	upsertCustomEntityAccessMetadataRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.

Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

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

Parameters

entityType	The type of the Custom Entity.
identifierType	An identifier type attached to the Custom Entity instance.
identifierValue	The identifier value.
metadataKey	Key of the metadata entry to retrieve
identifierScope	The identifier scope.
upsertCustomEntityAccessMetadataRequest	The Custom Entity Access Metadata entry to upsert
effectiveAt	The effectiveAt datetime at which the Access Metadata will be effective from (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (List<AccessMetadataValue>)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ UpsertCustomEntityAsync()

System.Threading.Tasks.Task<CustomEntityResponse> Lusid.Sdk.Api.ICustomEntitiesApiAsync.UpsertCustomEntityAsync	(	string	entityType,
		CustomEntityRequest	customEntityRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

UpsertCustomEntity: Upsert a Custom Entity instance

Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist.

Exceptions

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

Parameters

entityType	The type of the Custom Entity to be created. An entityType can be created using the "CreateCustomEntityDefinition" endpoint for CustomEntityDefinitions.
customEntityRequest	The payload describing the Custom Entity instance.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CustomEntityResponse

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

◆ UpsertCustomEntityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomEntityResponse> > Lusid.Sdk.Api.ICustomEntitiesApiAsync.UpsertCustomEntityWithHttpInfoAsync	(	string	entityType,
		CustomEntityRequest	customEntityRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

UpsertCustomEntity: Upsert a Custom Entity instance

Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist.

Exceptions

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

Parameters

entityType	The type of the Custom Entity to be created. An entityType can be created using the "CreateCustomEntityDefinition" endpoint for CustomEntityDefinitions.
customEntityRequest	The payload describing the Custom Entity instance.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CustomEntityResponse)

Implemented in Lusid.Sdk.Api.CustomEntitiesApi.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ DeleteCustomEntityAccessMetadataAsync()

◆ DeleteCustomEntityAccessMetadataWithHttpInfoAsync()

◆ DeleteCustomEntityAsync()

◆ DeleteCustomEntityWithHttpInfoAsync()

◆ GetAllCustomEntityAccessMetadataAsync()

◆ GetAllCustomEntityAccessMetadataWithHttpInfoAsync()

◆ GetCustomEntityAccessMetadataByKeyAsync()

◆ GetCustomEntityAccessMetadataByKeyWithHttpInfoAsync()

◆ GetCustomEntityAsync()

◆ GetCustomEntityRelationshipsAsync()

◆ GetCustomEntityRelationshipsWithHttpInfoAsync()

◆ GetCustomEntityWithHttpInfoAsync()

◆ ListCustomEntitiesAsync()

◆ ListCustomEntitiesWithHttpInfoAsync()

◆ PatchCustomEntityAccessMetadataAsync()

◆ PatchCustomEntityAccessMetadataWithHttpInfoAsync()

◆ UpsertCustomEntitiesAsync()

◆ UpsertCustomEntitiesWithHttpInfoAsync()

◆ UpsertCustomEntityAccessMetadataAsync()

◆ UpsertCustomEntityAccessMetadataWithHttpInfoAsync()

◆ UpsertCustomEntityAsync()

◆ UpsertCustomEntityWithHttpInfoAsync()