ApplicationMetadataApi.md

lusid_workflow.ApplicationMetadataApi

All URIs are relative to https://fbn-prd.lusid.com/workflow

Method	HTTP request	Description
list_access_controlled_resources	GET /api/metadata/access/resources	ListAccessControlledResources: Get resources available for access control
list_api_endpoints	GET /api/metadata/endpoints	ListApiEndpoints: Get the API endpoints available

list_access_controlled_resources

ResourceListOfAccessControlledResource list_access_controlled_resources()

ListAccessControlledResources: Get resources available for access control

Get the comprehensive set of resources that are available for access control

Example

from lusid_workflow.exceptions import ApiException
from lusid_workflow.extensions.configuration_options import ConfigurationOptions
from lusid_workflow.models import *
from pprint import pprint
from lusid_workflow import (
    SyncApiClientFactory,
    ApplicationMetadataApi
)

def main():

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

    # Use the lusid_workflow 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(ApplicationMetadataApi)

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

        # ListAccessControlledResources: Get resources available for access control
        api_response = api_instance.list_access_controlled_resources()
        pprint(api_response)

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

main()

Parameters

This endpoint does not need any parameter.

Return type

ResourceListOfAccessControlledResource

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error response	-

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

list_api_endpoints

ServiceApiEndpoints list_api_endpoints()

ListApiEndpoints: Get the API endpoints available

Get the name of the application and the operation, HTTP method, path, status, summary and description of each of its API endpoints

Example

from lusid_workflow.exceptions import ApiException
from lusid_workflow.extensions.configuration_options import ConfigurationOptions
from lusid_workflow.models import *
from pprint import pprint
from lusid_workflow import (
    SyncApiClientFactory,
    ApplicationMetadataApi
)

def main():

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

    # Use the lusid_workflow 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(ApplicationMetadataApi)

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

        # ListApiEndpoints: Get the API endpoints available
        api_response = api_instance.list_api_endpoints()
        pprint(api_response)

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

main()

Parameters

This endpoint does not need any parameter.

Return type

ServiceApiEndpoints

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error response	-

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