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

Inheritance diagram for Lusid.Sdk.Api.ITimelinesApiSync:

[legend]

Public Member Functions
ClosedPeriod	ConfirmClosedPeriod (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity More...

Lusid.Sdk.Client.ApiResponse< ClosedPeriod >	ConfirmClosedPeriodWithHttpInfo (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity More...

ClosedPeriod	CreateClosedPeriod (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity More...

Lusid.Sdk.Client.ApiResponse< ClosedPeriod >	CreateClosedPeriodWithHttpInfo (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity More...

ClosedPeriod	CreateClosedPeriodCandidate (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity More...

Lusid.Sdk.Client.ApiResponse< ClosedPeriod >	CreateClosedPeriodCandidateWithHttpInfo (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity More...

Timeline	CreateTimeline (CreateTimelineRequest? createTimelineRequest=default(CreateTimelineRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTimeline: Create a Timeline More...

Lusid.Sdk.Client.ApiResponse< Timeline >	CreateTimelineWithHttpInfo (CreateTimelineRequest? createTimelineRequest=default(CreateTimelineRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTimeline: Create a Timeline More...

DeletedEntityResponse	DeleteTimeline (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteTimelineWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline More...

ClosedPeriod	GetClosedPeriod (string scope, string code, string closedPeriodId, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. More...

Lusid.Sdk.Client.ApiResponse< ClosedPeriod >	GetClosedPeriodWithHttpInfo (string scope, string code, string closedPeriodId, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. More...

Timeline	GetTimeline (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. More...

Lusid.Sdk.Client.ApiResponse< Timeline >	GetTimelineWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. More...

PagedResourceListOfClosedPeriod	ListClosedPeriods (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfClosedPeriod >	ListClosedPeriodsWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. More...

PagedResourceListOfTimeline	ListTimelines (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTimelines: List Timelines More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfTimeline >	ListTimelinesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTimelines: List Timelines More...

ClosedPeriod	SetPostCloseActivity (string scope, string code, string closedPeriodId, PostCloseActivitiesRequest? postCloseActivitiesRequest=default(PostCloseActivitiesRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period. More...

Lusid.Sdk.Client.ApiResponse< ClosedPeriod >	SetPostCloseActivityWithHttpInfo (string scope, string code, string closedPeriodId, PostCloseActivitiesRequest? postCloseActivitiesRequest=default(PostCloseActivitiesRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period. More...

ClosedPeriod	UnconfirmClosedPeriod (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity More...

Lusid.Sdk.Client.ApiResponse< ClosedPeriod >	UnconfirmClosedPeriodWithHttpInfo (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity More...

Timeline	UpdateTimeline (string scope, string code, UpdateTimelineRequest? updateTimelineRequest=default(UpdateTimelineRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code More...

Lusid.Sdk.Client.ApiResponse< Timeline >	UpdateTimelineWithHttpInfo (string scope, string code, UpdateTimelineRequest? updateTimelineRequest=default(UpdateTimelineRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ ConfirmClosedPeriod()

ClosedPeriod Lusid.Sdk.Api.ITimelinesApiSync.ConfirmClosedPeriod	(	string	scope,
		string	code,
		string	closedPeriodId,
		Object?	body = `default(Object?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity

Confirms a Closed Period against a Timeline Entity. Deletes any other unconfirmed Closed Periods on the Timeline.

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodId	The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
body	Not in use at the moment (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ConfirmClosedPeriodWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiSync.ConfirmClosedPeriodWithHttpInfo	(	string	scope,
		string	code,
		string	closedPeriodId,
		Object?	body = `default(Object?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity

Confirms a Closed Period against a Timeline Entity. Deletes any other unconfirmed Closed Periods on the Timeline.

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodId	The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
body	Not in use at the moment (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriod()

ClosedPeriod Lusid.Sdk.Api.ITimelinesApiSync.CreateClosedPeriod	(	string	scope,
		string	code,
		CreateClosedPeriodRequest?	createClosedPeriodRequest = `default(CreateClosedPeriodRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity

Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
createClosedPeriodRequest	The request containing the details of the Closed Period (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodCandidate()

ClosedPeriod Lusid.Sdk.Api.ITimelinesApiSync.CreateClosedPeriodCandidate	(	string	scope,
		string	code,
		CreateClosedPeriodRequest?	createClosedPeriodRequest = `default(CreateClosedPeriodRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity

Creates a new closed period candidate against a timeline entity Returns the newly created closed period candidate entity with properties

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
createClosedPeriodRequest	The request containing the details of the Closed Period (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodCandidateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiSync.CreateClosedPeriodCandidateWithHttpInfo	(	string	scope,
		string	code,
		CreateClosedPeriodRequest?	createClosedPeriodRequest = `default(CreateClosedPeriodRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity

Creates a new closed period candidate against a timeline entity Returns the newly created closed period candidate entity with properties

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
createClosedPeriodRequest	The request containing the details of the Closed Period (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiSync.CreateClosedPeriodWithHttpInfo	(	string	scope,
		string	code,
		CreateClosedPeriodRequest?	createClosedPeriodRequest = `default(CreateClosedPeriodRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity

Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
createClosedPeriodRequest	The request containing the details of the Closed Period (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateTimeline()

Timeline Lusid.Sdk.Api.ITimelinesApiSync.CreateTimeline	(	CreateTimelineRequest?	createTimelineRequest = `default(CreateTimelineRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateTimeline: Create a Timeline

Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

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

Parameters

createTimelineRequest	The request containing the details of the Timeline (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateTimelineWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Timeline> Lusid.Sdk.Api.ITimelinesApiSync.CreateTimelineWithHttpInfo	(	CreateTimelineRequest?	createTimelineRequest = `default(CreateTimelineRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateTimeline: Create a Timeline

Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

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

Parameters

createTimelineRequest	The request containing the details of the Timeline (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ DeleteTimeline()

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

[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline

The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ DeleteTimelineWithHttpInfo()

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

[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline

The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetClosedPeriod()

ClosedPeriod Lusid.Sdk.Api.ITimelinesApiSync.GetClosedPeriod	(	string	scope,
		string	code,
		string	closedPeriodId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity.

Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId.

Exceptions

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

Parameters

scope	The scope of the Timeline.
code	The code of the Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodId	The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
asAt	The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified. (optional)
propertyKeys	A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetClosedPeriodWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiSync.GetClosedPeriodWithHttpInfo	(	string	scope,
		string	code,
		string	closedPeriodId,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity.

Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId.

Exceptions

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

Parameters

scope	The scope of the Timeline.
code	The code of the Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodId	The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
asAt	The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified. (optional)
propertyKeys	A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetTimeline()

Timeline Lusid.Sdk.Api.ITimelinesApiSync.GetTimeline	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.

Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties.

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
asAt	The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified. (optional)
propertyKeys	A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetTimelineWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Timeline> Lusid.Sdk.Api.ITimelinesApiSync.GetTimelineWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.

Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties.

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
asAt	The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified. (optional)
propertyKeys	A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListClosedPeriods()

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

[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline.

List all the ClosedPeriods matching a particular criteria.

Exceptions

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

Parameters

scope	The scope of the Timeline.
code	The code of the Timeline.
asAt	The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified. (optional)
page	The pagination token to use to continue listing ClosedPeriods; 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)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the effectiveEnd, specify "effectiveEnd gt 2019-01-15T10:00:00". 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)
propertyKeys	A list of property keys from the 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListClosedPeriodsWithHttpInfo()

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

[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline.

List all the ClosedPeriods matching a particular criteria.

Exceptions

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

Parameters

scope	The scope of the Timeline.
code	The code of the Timeline.
asAt	The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified. (optional)
page	The pagination token to use to continue listing ClosedPeriods; 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)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the effectiveEnd, specify "effectiveEnd gt 2019-01-15T10:00:00". 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)
propertyKeys	A list of property keys from the 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListTimelines()

PagedResourceListOfTimeline Lusid.Sdk.Api.ITimelinesApiSync.ListTimelines	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListTimelines: List Timelines

List all the Timelines matching a particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue listing Timelines; 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)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the displayName, specify "displayName eq 'AccountingTimeline'". 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)
propertyKeys	A list of property keys from the 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfTimeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListTimelinesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfTimeline> Lusid.Sdk.Api.ITimelinesApiSync.ListTimelinesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListTimelines: List Timelines

List all the Timelines matching a particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue listing Timelines; 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)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the displayName, specify "displayName eq 'AccountingTimeline'". 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)
propertyKeys	A list of property keys from the 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfTimeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ SetPostCloseActivity()

ClosedPeriod Lusid.Sdk.Api.ITimelinesApiSync.SetPostCloseActivity	(	string	scope,
		string	code,
		string	closedPeriodId,
		PostCloseActivitiesRequest?	postCloseActivitiesRequest = `default(PostCloseActivitiesRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period.

This sets the given post-close activities to the given Closed Period. This is an overwriting action! The possible types of entity are: * `PortfolioTransaction`, * `Instrument`, * `InstrumentEvent`, * `InstrumentEventInstruction`, * `PortfolioSettlementInstruction`, and, * `Quote`.

Exceptions

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

Parameters

scope	The scope of the Timeline.
code	The code of the Timeline.
closedPeriodId	The ID of the Closed Period. This ID together with the scope and code of the Timeline uniquely defines the Closed Period.
postCloseActivitiesRequest	This specifies a collection of post-close activities. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ SetPostCloseActivityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiSync.SetPostCloseActivityWithHttpInfo	(	string	scope,
		string	code,
		string	closedPeriodId,
		PostCloseActivitiesRequest?	postCloseActivitiesRequest = `default(PostCloseActivitiesRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period.

This sets the given post-close activities to the given Closed Period. This is an overwriting action! The possible types of entity are: * `PortfolioTransaction`, * `Instrument`, * `InstrumentEvent`, * `InstrumentEventInstruction`, * `PortfolioSettlementInstruction`, and, * `Quote`.

Exceptions

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

Parameters

scope	The scope of the Timeline.
code	The code of the Timeline.
closedPeriodId	The ID of the Closed Period. This ID together with the scope and code of the Timeline uniquely defines the Closed Period.
postCloseActivitiesRequest	This specifies a collection of post-close activities. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UnconfirmClosedPeriod()

ClosedPeriod Lusid.Sdk.Api.ITimelinesApiSync.UnconfirmClosedPeriod	(	string	scope,
		string	code,
		string	closedPeriodId,
		Object?	body = `default(Object?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity

Unconfirm the last confirmed Closed Period against a Timeline Entity

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodId	The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod. The closed period must be the last closed period on the Timeline.
body	Not in use at the moment (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UnconfirmClosedPeriodWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiSync.UnconfirmClosedPeriodWithHttpInfo	(	string	scope,
		string	code,
		string	closedPeriodId,
		Object?	body = `default(Object?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity

Unconfirm the last confirmed Closed Period against a Timeline Entity

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodId	The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod. The closed period must be the last closed period on the Timeline.
body	Not in use at the moment (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UpdateTimeline()

Timeline Lusid.Sdk.Api.ITimelinesApiSync.UpdateTimeline	(	string	scope,
		string	code,
		UpdateTimelineRequest?	updateTimelineRequest = `default(UpdateTimelineRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code

Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
updateTimelineRequest	The request containing the updated details of the Timeline (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UpdateTimelineWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Timeline> Lusid.Sdk.Api.ITimelinesApiSync.UpdateTimelineWithHttpInfo	(	string	scope,
		string	code,
		UpdateTimelineRequest?	updateTimelineRequest = `default(UpdateTimelineRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code

Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt

Exceptions

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

Parameters

scope	The scope of the specified Timeline.
code	The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
updateTimelineRequest	The request containing the updated details of the Timeline (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ ConfirmClosedPeriod()

◆ ConfirmClosedPeriodWithHttpInfo()

◆ CreateClosedPeriod()

◆ CreateClosedPeriodCandidate()

◆ CreateClosedPeriodCandidateWithHttpInfo()

◆ CreateClosedPeriodWithHttpInfo()

◆ CreateTimeline()

◆ CreateTimelineWithHttpInfo()

◆ DeleteTimeline()

◆ DeleteTimelineWithHttpInfo()

◆ GetClosedPeriod()

◆ GetClosedPeriodWithHttpInfo()

◆ GetTimeline()

◆ GetTimelineWithHttpInfo()

◆ ListClosedPeriods()

◆ ListClosedPeriodsWithHttpInfo()

◆ ListTimelines()

◆ ListTimelinesWithHttpInfo()

◆ SetPostCloseActivity()

◆ SetPostCloseActivityWithHttpInfo()

◆ UnconfirmClosedPeriod()

◆ UnconfirmClosedPeriodWithHttpInfo()

◆ UpdateTimeline()

◆ UpdateTimelineWithHttpInfo()