sdk.lusid.api.scopes_api.ScopesApi

class ScopesApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

list_entity_scopes

ListEntityScopes: List Entity Scopes # noqa: E501

list_entity_scopes_with_http_info

ListEntityScopes: List Entity Scopes # noqa: E501

list_scopes

ListScopes: List Scopes # noqa: E501

list_scopes_with_http_info

ListScopes: List Scopes # noqa: E501
list_entity_scopes(entity_type, async_req=None, **kwargs)[source]

ListEntityScopes: List Entity Scopes # noqa: E501

List all the scopes for a given entity type that contain data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_entity_scopes(entity_type, async_req=True)
>>> result = thread.get()
Parameters:

  • entity_type (str) – The entity type to list scopes for. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfScopeDefinition

list_entity_scopes_with_http_info(entity_type, **kwargs)[source]

ListEntityScopes: List Entity Scopes # noqa: E501

List all the scopes for a given entity type that contain data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_entity_scopes_with_http_info(entity_type, async_req=True)
>>> result = thread.get()
Parameters:

  • entity_type (str) – The entity type to list scopes for. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfScopeDefinition, status_code(int), headers(HTTPHeaderDict))

list_scopes(filter=None, async_req=None, **kwargs)[source]

ListScopes: List Scopes # noqa: E501

List all the scopes that contain data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_scopes(filter, async_req=True)
>>> result = thread.get()
Parameters:

  • filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “scope eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfScopeDefinition

list_scopes_with_http_info(filter=None, **kwargs)[source]

ListScopes: List Scopes # noqa: E501

List all the scopes that contain data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_scopes_with_http_info(filter, async_req=True)
>>> result = thread.get()
Parameters:

  • filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “scope eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfScopeDefinition, status_code(int), headers(HTTPHeaderDict))