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
ListEntityScopes: List Entity Scopes # noqa: E501
ListEntityScopes: List Entity Scopes # noqa: E501
ListScopes: List Scopes # noqa: E501
ListScopes: List Scopes # noqa: E501
- list_entity_scopes(entity_type, as_at=None, page=None, limit=None, 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, as_at, page, limit, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type to list scopes for. (required)
as_at (datetime) – The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
page (str) – The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_entity_scopes_with_http_info(entity_type, as_at=None, page=None, limit=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_with_http_info(entity_type, as_at, page, limit, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type to list scopes for. (required)
as_at (datetime) – The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
page (str) – The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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))