LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IDataTypesApiSync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IDataTypesApiSync:
Inheritance graph
[legend]

Public Member Functions

DataType CreateDataType (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateDataType: Create data type definition More...
 
Lusid.Sdk.Client.ApiResponse< DataTypeCreateDataTypeWithHttpInfo (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateDataType: Create data type definition More...
 
DeletedEntityResponse DeleteDataType (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 DeleteDataType: Delete a data type definition. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteDataTypeWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 DeleteDataType: Delete a data type definition. More...
 
DataType GetDataType (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 GetDataType: Get data type definition More...
 
Lusid.Sdk.Client.ApiResponse< DataTypeGetDataTypeWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 GetDataType: Get data type definition More...
 
ResourceListOfIUnitDefinitionDto GetUnitsFromDataType (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetUnitsFromDataType: Get units from data type More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfIUnitDefinitionDtoGetUnitsFromDataTypeWithHttpInfo (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetUnitsFromDataType: Get units from data type More...
 
PagedResourceListOfDataTypeSummary ListDataTypeSummaries (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfDataTypeSummaryListDataTypeSummariesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data More...
 
ResourceListOfDataType ListDataTypes (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeSystem=default(bool?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 ListDataTypes: List data types More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfDataTypeListDataTypesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeSystem=default(bool?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 ListDataTypes: List data types More...
 
DataType UpdateDataType (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateDataType: Update data type definition More...
 
Lusid.Sdk.Client.ApiResponse< DataTypeUpdateDataTypeWithHttpInfo (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateDataType: Update data type definition More...
 
DataType UpdateReferenceData (string scope, string code, UpdateReferenceDataRequest updateReferenceDataRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values More...
 
Lusid.Sdk.Client.ApiResponse< DataTypeUpdateReferenceDataWithHttpInfo (string scope, string code, UpdateReferenceDataRequest updateReferenceDataRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values More...
 
DataType UpdateReferenceValues (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type More...
 
Lusid.Sdk.Client.ApiResponse< DataTypeUpdateReferenceValuesWithHttpInfo (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateDataType()

DataType Lusid.Sdk.Api.IDataTypesApiSync.CreateDataType ( CreateDataTypeRequest createDataTypeRequest = default(CreateDataTypeRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] CreateDataType: Create data type definition

Create a new data type definition Data types cannot be created in either the &quot;default&quot; or &quot;system&quot; scopes.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createDataTypeRequestThe definition of the new data type (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ CreateDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.CreateDataTypeWithHttpInfo ( CreateDataTypeRequest createDataTypeRequest = default(CreateDataTypeRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] CreateDataType: Create data type definition

Create a new data type definition Data types cannot be created in either the &quot;default&quot; or &quot;system&quot; scopes.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createDataTypeRequestThe definition of the new data type (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ DeleteDataType()

DeletedEntityResponse Lusid.Sdk.Api.IDataTypesApiSync.DeleteDataType ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

DeleteDataType: Delete a data type definition.

Delete an existing data type definition. Data types cannot be deleted in either the &quot;default&quot; or &quot;system&quot; scopes, scopes beginning with &quot;LUSID-&quot;, or data types that are in use on a property definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ DeleteDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IDataTypesApiSync.DeleteDataTypeWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

DeleteDataType: Delete a data type definition.

Delete an existing data type definition. Data types cannot be deleted in either the &quot;default&quot; or &quot;system&quot; scopes, scopes beginning with &quot;LUSID-&quot;, or data types that are in use on a property definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ GetDataType()

DataType Lusid.Sdk.Api.IDataTypesApiSync.GetDataType ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

GetDataType: Get data type definition

Get the definition of a specified data type

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
asAtThe asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ GetDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.GetDataTypeWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

GetDataType: Get data type definition

Get the definition of a specified data type

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
asAtThe asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ GetUnitsFromDataType()

ResourceListOfIUnitDefinitionDto Lusid.Sdk.Api.IDataTypesApiSync.GetUnitsFromDataType ( string  scope,
string  code,
List< string >?  units = default(List< string >?),
string?  filter = default(string?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] GetUnitsFromDataType: Get units from data type

Get the definitions of the specified units associated bound to a specific data type

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
unitsOne or more unit identifiers for which the definition is being requested (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Schema, use &quot;schema eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
asAtOptional. The as at of the requested data type (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfIUnitDefinitionDto

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ GetUnitsFromDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfIUnitDefinitionDto> Lusid.Sdk.Api.IDataTypesApiSync.GetUnitsFromDataTypeWithHttpInfo ( string  scope,
string  code,
List< string >?  units = default(List< string >?),
string?  filter = default(string?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] GetUnitsFromDataType: Get units from data type

Get the definitions of the specified units associated bound to a specific data type

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
unitsOne or more unit identifiers for which the definition is being requested (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Schema, use &quot;schema eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
asAtOptional. The as at of the requested data type (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfIUnitDefinitionDto

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ ListDataTypes()

ResourceListOfDataType Lusid.Sdk.Api.IDataTypesApiSync.ListDataTypes ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
bool?  includeSystem = default(bool?),
List< string >?  sortBy = default(List< string >?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

ListDataTypes: List data types

List all data types in a specified scope

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe requested scope of the data types
asAtThe as at of the requested data types (optional)
includeSystemWhether to additionally include those data types in the &quot;system&quot; scope (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfDataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ ListDataTypeSummaries()

PagedResourceListOfDataTypeSummary Lusid.Sdk.Api.IDataTypesApiSync.ListDataTypeSummaries ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data

List all data type summaries

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. (optional)
pageThe pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Scope, use &quot;id.scope eq &#39;myscope&#39;&quot;, to filter on Schema, use &quot;schema eq &#39;string&#39;&quot;, to filter on AcceptableValues use &quot;acceptableValues any (~ eq &#39;value&#39;)&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfDataTypeSummary

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ ListDataTypeSummariesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfDataTypeSummary> Lusid.Sdk.Api.IDataTypesApiSync.ListDataTypeSummariesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data

List all data type summaries

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. (optional)
pageThe pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Scope, use &quot;id.scope eq &#39;myscope&#39;&quot;, to filter on Schema, use &quot;schema eq &#39;string&#39;&quot;, to filter on AcceptableValues use &quot;acceptableValues any (~ eq &#39;value&#39;)&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfDataTypeSummary

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ ListDataTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfDataType> Lusid.Sdk.Api.IDataTypesApiSync.ListDataTypesWithHttpInfo ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
bool?  includeSystem = default(bool?),
List< string >?  sortBy = default(List< string >?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

ListDataTypes: List data types

List all data types in a specified scope

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe requested scope of the data types
asAtThe as at of the requested data types (optional)
includeSystemWhether to additionally include those data types in the &quot;system&quot; scope (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfDataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ UpdateDataType()

DataType Lusid.Sdk.Api.IDataTypesApiSync.UpdateDataType ( string  scope,
string  code,
UpdateDataTypeRequest  updateDataTypeRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateDataType: Update data type definition

Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
updateDataTypeRequestThe updated definition of the data type
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ UpdateDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.UpdateDataTypeWithHttpInfo ( string  scope,
string  code,
UpdateDataTypeRequest  updateDataTypeRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateDataType: Update data type definition

Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
updateDataTypeRequestThe updated definition of the data type
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ UpdateReferenceData()

DataType Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceData ( string  scope,
string  code,
UpdateReferenceDataRequest  updateReferenceDataRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values

Replaces the whole set of reference data

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
updateReferenceDataRequestThe updated reference data
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ UpdateReferenceDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceDataWithHttpInfo ( string  scope,
string  code,
UpdateReferenceDataRequest  updateReferenceDataRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values

Replaces the whole set of reference data

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
updateReferenceDataRequestThe updated reference data
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ UpdateReferenceValues()

DataType Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceValues ( string  scope,
string  code,
List< FieldValue fieldValue,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type

Replaces the whole set of reference values

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
fieldValueThe updated reference values
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.

◆ UpdateReferenceValuesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceValuesWithHttpInfo ( string  scope,
string  code,
List< FieldValue fieldValue,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type

Replaces the whole set of reference values

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the data type
codeThe code of the data type
fieldValueThe updated reference values
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DataType

Implemented in Lusid.Sdk.Api.DataTypesApi.


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