Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 4.62 KB

api_wrapper.md

File metadata and controls

75 lines (51 loc) · 4.62 KB
Raw

APIWrapper support

Create an API session that facilitates usage of the API methods supported by our Python API.

The APIWrapper class is a wrapper for all of the supported API methods in the Python Client API. This makes it easier to use the supported API methods without having to manually pass a ServerContext object to each API method.

Using the APIWrapper class

The APIWrapper class is imported from api_wrapper.py:

from labkey.api_wrapper import APIWrapper

It includes the following arguments:

domain

  • This is the base URL for a LabKey Server instance.
  • Example: 'www.labkey.org'

container_path

  • This is the path to the targeted project, folder, or subfolder in a LabKey Server instance. This path will be used as the default container path for all API requests, you can override this default by passing a container_path to any API method you are using. This parameter does not need to be supplied to any of the APIWrapper class's methods once it is defined in the class, unless the container_path intended for a method differs from the one used when instantiating the class.
  • Example: 'Project/Folder/Subfolder'

context_path

  • Defaults to None. Depending on how the LabKey Server instance is implemented, it may be necessary to include a value for the context_path argument. If your LabKey Server instance has text after the base URL, that is the context path.
  • Example: If your home project has a URL such as https://labkey.org/contextpath/home/project-begin.view, then the context path is 'contextpath'.

use_ssl

  • Defaults to True. This should be set to True if your server is configured to use SSL. If you are not sure if your server uses SSL, refer to any URL for accessing your server. Servers using SSL will have a URL that begins with https:// instead of http://. LabKey Sample Manager-only clients must have this argument set to True.

verify_ssl

  • Defaults to True. This argument toggles whether or not the SSL certificate is validated when attempting to connect to a server. This flag is useful when you are connecting to a development server with a self-signed SSL certificate, which would otherwise cause a failure. You should never disable this flag if you are connecting to a production server with a proper SSL certificate.

api_key

disable_csrf

allow_redirects

  • Defaults to False. When the server issues a redirect during an API call the ServerContext will throw an error.

Using LabKey Python APIs

The labkey-api-python library can be used to select rows, insert rows, edit containers, edit storage, modify security settings and permissions, as well as many other functions. To learn more about these different functions, see the other documentation pages in this docs folder.

See below for an example of how to properly use the APIWrapper class to create a session and run the select_rows method.

from labkey.api_wrapper import APIWrapper

print("Create an APIWrapper")
labkey_server = 'www.example.com'
container_path = 'Tutorials/HIV Study' # Full project/folder container path
contextPath = 'labkey'
schema = 'core'
table = 'Users'

# Note: If developing against localhost with https disabled, set use_ssl=False below
api = APIWrapper(labkey_server, container_path, contextPath)

# Makes an API request to https://www.example.com/labkey/ModuleAssayTest/query-getQuery.api
result = api.query.select_rows(schema, table)

if result is not None:
    print(result['rows'][0])
    print("select_rows: Number of rows returned: " + str(result['rowCount']))
else:
    print('select_rows: Failed to load results from ' + schema + '.' + table)

Automatic script generation

In LabKey Server, data grids by default provide the ability to generate the Python code to export the displayed grid view using the APIWrapper class and the select_rows method. This is often an easy and convenient way to create a starting point for further Python development. For more information on this topic: https://www.labkey.org/Documentation/wiki-page.view?name=exportScripts