Skip to content

Latest commit

 

History

History
397 lines (292 loc) · 15.6 KB

ReferenceListsApi.md

File metadata and controls

397 lines (292 loc) · 15.6 KB

lusid.ReferenceListsApi

All URIs are relative to https://www.lusid.com/api

Method HTTP request Description
delete_reference_list DELETE /api/referencelists/{scope}/{code} [EARLY ACCESS] DeleteReferenceList: Delete Reference List
get_reference_list GET /api/referencelists/{scope}/{code} GetReferenceList: Get Reference List
list_reference_lists GET /api/referencelists [EARLY ACCESS] ListReferenceLists: List Reference Lists
upsert_reference_list POST /api/referencelists [EARLY ACCESS] UpsertReferenceList: Upsert Reference List

delete_reference_list

DeletedEntityResponse delete_reference_list(scope, code)

[EARLY ACCESS] DeleteReferenceList: Delete Reference List

Delete a Reference List instance.

Example

from lusid.exceptions import ApiException
from lusid.extensions.configuration_options import ConfigurationOptions
from lusid.models import *
from pprint import pprint
from lusid import (
    SyncApiClientFactory,
    ReferenceListsApi
)

def main():

    with open("secrets.json", "w") as file:
        file.write('''
    {
        "api":
        {
            "tokenUrl":"<your-token-url>",
            "lusidUrl":"https://<your-domain>.lusid.com/api",
            "username":"<your-username>",
            "password":"<your-password>",
            "clientId":"<your-client-id>",
            "clientSecret":"<your-client-secret>"
        }
    }''')

    # Use the lusid SyncApiClientFactory to build Api instances with a configured api client
    # By default this will read config from environment variables
    # Then from a secrets.json file found in the current working directory

    # uncomment the below to use configuration overrides
    # opts = ConfigurationOptions();
    # opts.total_timeout_ms = 30_000

    # uncomment the below to use an api client factory with overrides
    # api_client_factory = SyncApiClientFactory(opts=opts)

    api_client_factory = SyncApiClientFactory()

    # Enter a context with an instance of the SyncApiClientFactory to ensure the connection pool is closed after use
    
    # Create an instance of the API class
    api_instance = api_client_factory.build(ReferenceListsApi)
    scope = 'scope_example' # str | The scope to which the Reference List belongs.
    code = 'code_example' # str | The Reference List's unique identifier.

    try:
        # uncomment the below to set overrides at the request level
        # api_response =  api_instance.delete_reference_list(scope, code, opts=opts)

        # [EARLY ACCESS] DeleteReferenceList: Delete Reference List
        api_response = api_instance.delete_reference_list(scope, code)
        pprint(api_response)

    except ApiException as e:
        print("Exception when calling ReferenceListsApi->delete_reference_list: %s\n" % e)

main()

Parameters

Name Type Description Notes
scope str The scope to which the Reference List belongs.
code str The Reference List's unique identifier.

Return type

DeletedEntityResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The deleted reference list response. -
400 The details of the input related failure -
0 Error response -

Back to top • Back to API list • Back to Model list • Back to README

get_reference_list

ReferenceListResponse get_reference_list(scope, code, as_at=as_at)

GetReferenceList: Get Reference List

Retrieve a Reference List instance at a point in AsAt time.

Example

from lusid.exceptions import ApiException
from lusid.extensions.configuration_options import ConfigurationOptions
from lusid.models import *
from pprint import pprint
from lusid import (
    SyncApiClientFactory,
    ReferenceListsApi
)

def main():

    with open("secrets.json", "w") as file:
        file.write('''
    {
        "api":
        {
            "tokenUrl":"<your-token-url>",
            "lusidUrl":"https://<your-domain>.lusid.com/api",
            "username":"<your-username>",
            "password":"<your-password>",
            "clientId":"<your-client-id>",
            "clientSecret":"<your-client-secret>"
        }
    }''')

    # Use the lusid SyncApiClientFactory to build Api instances with a configured api client
    # By default this will read config from environment variables
    # Then from a secrets.json file found in the current working directory

    # uncomment the below to use configuration overrides
    # opts = ConfigurationOptions();
    # opts.total_timeout_ms = 30_000

    # uncomment the below to use an api client factory with overrides
    # api_client_factory = SyncApiClientFactory(opts=opts)

    api_client_factory = SyncApiClientFactory()

    # Enter a context with an instance of the SyncApiClientFactory to ensure the connection pool is closed after use
    
    # Create an instance of the API class
    api_instance = api_client_factory.build(ReferenceListsApi)
    scope = 'scope_example' # str | The scope to which the Reference List belongs.
    code = 'code_example' # str | The Reference List's unique identifier.
    as_at = '2013-10-20T19:20:30+01:00' # datetime | The asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified. (optional)

    try:
        # uncomment the below to set overrides at the request level
        # api_response =  api_instance.get_reference_list(scope, code, as_at=as_at, opts=opts)

        # GetReferenceList: Get Reference List
        api_response = api_instance.get_reference_list(scope, code, as_at=as_at)
        pprint(api_response)

    except ApiException as e:
        print("Exception when calling ReferenceListsApi->get_reference_list: %s\n" % e)

main()

Parameters

Name Type Description Notes
scope str The scope to which the Reference List belongs.
code str The Reference List's unique identifier.
as_at datetime The asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified. [optional]

Return type

ReferenceListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The Reference List matching the requested identifier. -
400 The details of the input related failure -
0 Error response -

Back to top • Back to API list • Back to Model list • Back to README

list_reference_lists

PagedResourceListOfReferenceListResponse list_reference_lists(as_at=as_at, page=page, limit=limit, filter=filter)

[EARLY ACCESS] ListReferenceLists: List Reference Lists

List all the Reference Lists matching particular criteria.

Example

from lusid.exceptions import ApiException
from lusid.extensions.configuration_options import ConfigurationOptions
from lusid.models import *
from pprint import pprint
from lusid import (
    SyncApiClientFactory,
    ReferenceListsApi
)

def main():

    with open("secrets.json", "w") as file:
        file.write('''
    {
        "api":
        {
            "tokenUrl":"<your-token-url>",
            "lusidUrl":"https://<your-domain>.lusid.com/api",
            "username":"<your-username>",
            "password":"<your-password>",
            "clientId":"<your-client-id>",
            "clientSecret":"<your-client-secret>"
        }
    }''')

    # Use the lusid SyncApiClientFactory to build Api instances with a configured api client
    # By default this will read config from environment variables
    # Then from a secrets.json file found in the current working directory

    # uncomment the below to use configuration overrides
    # opts = ConfigurationOptions();
    # opts.total_timeout_ms = 30_000

    # uncomment the below to use an api client factory with overrides
    # api_client_factory = SyncApiClientFactory(opts=opts)

    api_client_factory = SyncApiClientFactory()

    # Enter a context with an instance of the SyncApiClientFactory to ensure the connection pool is closed after use
    
    # Create an instance of the API class
    api_instance = api_client_factory.build(ReferenceListsApi)
    as_at = '2013-10-20T19:20:30+01:00' # datetime | The asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified. (optional)
    page = 'page_example' # str | The pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists.              This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields              must not have changed since the original request. (optional)
    limit = 56 # int | When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional)
    filter = 'filter_example' # str | Expression to filter the result set. Read more about filtering results from LUSID here:              https://support.lusid.com/filtering-results-from-lusid. (optional)

    try:
        # uncomment the below to set overrides at the request level
        # api_response =  api_instance.list_reference_lists(as_at=as_at, page=page, limit=limit, filter=filter, opts=opts)

        # [EARLY ACCESS] ListReferenceLists: List Reference Lists
        api_response = api_instance.list_reference_lists(as_at=as_at, page=page, limit=limit, filter=filter)
        pprint(api_response)

    except ApiException as e:
        print("Exception when calling ReferenceListsApi->list_reference_lists: %s\n" % e)

main()

Parameters

Name Type Description Notes
as_at datetime The asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified. [optional]
page str The pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists. This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request. [optional]
limit int When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. [optional]
filter str Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. [optional]

Return type

PagedResourceListOfReferenceListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 A collection of Reference Lists. -
400 The details of the input related failure -
0 Error response -

Back to top • Back to API list • Back to Model list • Back to README

upsert_reference_list

ReferenceListResponse upsert_reference_list(reference_list_request=reference_list_request)

[EARLY ACCESS] UpsertReferenceList: Upsert Reference List

Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist.

Example

from lusid.exceptions import ApiException
from lusid.extensions.configuration_options import ConfigurationOptions
from lusid.models import *
from pprint import pprint
from lusid import (
    SyncApiClientFactory,
    ReferenceListsApi
)

def main():

    with open("secrets.json", "w") as file:
        file.write('''
    {
        "api":
        {
            "tokenUrl":"<your-token-url>",
            "lusidUrl":"https://<your-domain>.lusid.com/api",
            "username":"<your-username>",
            "password":"<your-password>",
            "clientId":"<your-client-id>",
            "clientSecret":"<your-client-secret>"
        }
    }''')

    # Use the lusid SyncApiClientFactory to build Api instances with a configured api client
    # By default this will read config from environment variables
    # Then from a secrets.json file found in the current working directory

    # uncomment the below to use configuration overrides
    # opts = ConfigurationOptions();
    # opts.total_timeout_ms = 30_000

    # uncomment the below to use an api client factory with overrides
    # api_client_factory = SyncApiClientFactory(opts=opts)

    api_client_factory = SyncApiClientFactory()

    # Enter a context with an instance of the SyncApiClientFactory to ensure the connection pool is closed after use
    
    # Create an instance of the API class
    api_instance = api_client_factory.build(ReferenceListsApi)

    # Objects can be created either via the class constructor, or using the 'from_dict' or 'from_json' methods
    # Change the lines below to switch approach
    # reference_list_request = ReferenceListRequest.from_json("")
    # reference_list_request = ReferenceListRequest.from_dict({})
    reference_list_request = ReferenceListRequest()

    try:
        # uncomment the below to set overrides at the request level
        # api_response =  api_instance.upsert_reference_list(reference_list_request=reference_list_request, opts=opts)

        # [EARLY ACCESS] UpsertReferenceList: Upsert Reference List
        api_response = api_instance.upsert_reference_list(reference_list_request=reference_list_request)
        pprint(api_response)

    except ApiException as e:
        print("Exception when calling ReferenceListsApi->upsert_reference_list: %s\n" % e)

main()

Parameters

Name Type Description Notes
reference_list_request ReferenceListRequest The payload describing the Reference List instance. [optional]

Return type

ReferenceListResponse

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The upserted Reference List instance. -
400 The details of the input related failure -
0 Error response -

Back to top • Back to API list • Back to Model list • Back to README