5. dxpy.api Module

This module is automatically generated from a list of available routes on the API server. Functions in this module take a remote object ID (when appropriate) and an optional argument input_params to set the request body. The request must be a list or a dict, as it will be converted to JSON. If input_params is not provided, the JSON of an empty dict will be sent. Each function returns the Pythonized JSON (a list or dict) that is returned from the API server.

An example API call
dxpy.api.classname_methodname(object_id, input_params={}, always_retry=False, **kwargs)
Parameters:
  • object_id (string) – Object ID of remote object to be manipulated
  • input_params (list or dict) – Request body (will be converted to JSON)
  • always_retry (bool) – True if the request is idempotent and is safe to retry. Note that this parameter is misleadingly named; setting it to True (False, respectively) does not guarantee that the request will always (never) be retried. Rather, it is advisory and whether the request is retried depends on the specific error condition: see the retry logic specification for more information.
  • kwargs – Additional arguments to be passed to the dxpy.DXHTTPRequest object (such as headers)
Returns:

Contents of response from API server (Pythonized JSON object)

Return type:

list or dict

Raises:

DXAPIError if an HTTP response code other than 200 is received from the API server.

For apps, the signature is slightly different, because apps can also be named by their name and version (or tag), in addition to their app ID.

An example API call on an app instance
dxpy.api.app_methodname(app_name_or_id, alias=None, input_params={}, always_retry=False, **kwargs)
Parameters:
  • app_name_or_id (string) – Either “app-NAME” or the hash ID “app-xxxx”
  • alias (string) – If app_name_or_id is given using its name, then a version or tag string (if none is given, then the tag “default” will be used). If app_name_or_id is a hash ID, this value should be None.
  • input_params (list or dict) – Request body (will be converted to JSON)
  • always_retry (bool) –

    True if the request is idempotent and is safe to retry. Note that this parameter is misleadingly named; setting it to True (False, respectively) does not guarantee that the request will always (never) be retried. Rather, it is advisory and whether the request is retried depends on the specific error condition: see the retry logic specification for more information.

  • kwargs – Additional arguments to be passed to the dxpy.DXHTTPRequest object (such as headers)
Returns:

Contents of response from API server (Pythonized JSON object)

Return type:

list or dict

Raises:

DXAPIError if an HTTP response code other than 200 is received from the API server.

The specific functions provided in this module are enumerated below.

dxpy.api.analysis_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /analysis-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fanalysis-xxxx%2FaddTags

dxpy.api.analysis_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /analysis-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fanalysis-xxxx%2Fdescribe

dxpy.api.analysis_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /analysis-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fanalysis-xxxx%2FremoveTags

dxpy.api.analysis_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /analysis-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fanalysis-xxxx%2FsetProperties

dxpy.api.analysis_terminate(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /analysis-xxxx/terminate API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fanalysis-xxxx%2Fterminate

dxpy.api.app_add_authorized_users(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/addAuthorizedUsers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/addAuthorizedUsers

dxpy.api.app_add_categories(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/addCategories API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/addCategories

dxpy.api.app_add_developers(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/addDevelopers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/addDevelopers

dxpy.api.app_add_tags(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/addTags

dxpy.api.app_delete(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/delete API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/delete

dxpy.api.app_describe(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/describe

dxpy.api.app_get(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/get API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/get

dxpy.api.app_install(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/install API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/install

dxpy.api.app_list_authorized_users(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/listAuthorizedUsers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/listAuthorizedUsers

dxpy.api.app_list_categories(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/listCategories API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/listCategories

dxpy.api.app_list_developers(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/listDevelopers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/listDevelopers

dxpy.api.app_publish(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/publish API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/publish

dxpy.api.app_remove_authorized_users(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/removeAuthorizedUsers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/removeAuthorizedUsers

dxpy.api.app_remove_categories(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/removeCategories API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/removeCategories

dxpy.api.app_remove_developers(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/removeDevelopers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/removeDevelopers

dxpy.api.app_remove_tags(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/removeTags

dxpy.api.app_run(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/run API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/run

dxpy.api.app_uninstall(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/uninstall API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/uninstall

dxpy.api.app_update(app_name_or_id, alias=None, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app-xxxx/update API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/update

dxpy.api.app_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /app/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app/new

dxpy.api.applet_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FaddTags

dxpy.api.applet_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fapplet-xxxx%2Fdescribe

dxpy.api.applet_get(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/get API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fapplet-xxxx%2Fget

dxpy.api.applet_get_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/getDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FgetDetails

dxpy.api.applet_list_projects(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/listProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2FlistProjects

dxpy.api.applet_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FremoveTags

dxpy.api.applet_rename(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/rename API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Name#API-method%3A-%2Fclass-xxxx%2Frename

dxpy.api.applet_run(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/run API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fapplet-xxxx%2Frun

dxpy.api.applet_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Properties#API-method%3A-%2Fclass-xxxx%2FsetProperties

dxpy.api.applet_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /applet/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fapplet%2Fnew

dxpy.api.container_clone(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /container-xxxx/clone API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2Fclone

dxpy.api.container_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /container-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Containers-for-Execution#API-method%3A-%2Fcontainer-xxxx%2Fdescribe

dxpy.api.container_destroy(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /container-xxxx/destroy API method.

dxpy.api.container_list_folder(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /container-xxxx/listFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FlistFolder

dxpy.api.container_move(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /container-xxxx/move API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2Fmove

dxpy.api.container_new_folder(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /container-xxxx/newFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FnewFolder

dxpy.api.container_remove_folder(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /container-xxxx/removeFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FremoveFolder

dxpy.api.container_remove_objects(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /container-xxxx/removeObjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FremoveObjects

dxpy.api.container_rename_folder(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /container-xxxx/renameFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FrenameFolder

dxpy.api.file_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FaddTags

dxpy.api.file_add_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/addTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FaddTypes

dxpy.api.file_close(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/close API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Files#API-method%3A-%2Ffile-xxxx%2Fclose

dxpy.api.file_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Files#API-method%3A-%2Ffile-xxxx%2Fdescribe

dxpy.api.file_download(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/download API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Files#API-method%3A-%2Ffile-xxxx%2Fdownload

dxpy.api.file_get_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/getDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FgetDetails

dxpy.api.file_list_projects(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/listProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2FlistProjects

dxpy.api.file_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FremoveTags

dxpy.api.file_remove_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/removeTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FremoveTypes

dxpy.api.file_rename(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/rename API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Name#API-method%3A-%2Fclass-xxxx%2Frename

dxpy.api.file_set_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/setDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FsetDetails

dxpy.api.file_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Properties#API-method%3A-%2Fclass-xxxx%2FsetProperties

dxpy.api.file_set_visibility(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/setVisibility API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Visibility#API-method%3A-%2Fclass-xxxx%2FsetVisibility

dxpy.api.file_upload(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file-xxxx/upload API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Files#API-method%3A-%2Ffile-xxxx%2Fupload

dxpy.api.file_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /file/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Files#API-method%3A-%2Ffile%2Fnew

dxpy.api.gtable_add_rows(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/addRows API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/GenomicTables#API-method%3A-%2Fgtable-xxxx%2FaddRows

dxpy.api.gtable_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FaddTags

dxpy.api.gtable_add_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/addTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FaddTypes

dxpy.api.gtable_close(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/close API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/GenomicTables#API-method%3A-%2Fgtable-xxxx%2Fclose

dxpy.api.gtable_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/GenomicTables#API-method%3A-%2Fgtable-xxxx%2Fdescribe

dxpy.api.gtable_get(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/get API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/GenomicTables#API-method%3A-%2Fgtable-xxxx%2Fget

dxpy.api.gtable_get_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/getDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FgetDetails

dxpy.api.gtable_list_projects(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/listProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2FlistProjects

dxpy.api.gtable_next_part(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/nextPart API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/GenomicTables#API-method%3A-%2Fgtable-xxxx%2FnextPart

dxpy.api.gtable_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FremoveTags

dxpy.api.gtable_remove_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/removeTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FremoveTypes

dxpy.api.gtable_rename(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/rename API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Name#API-method%3A-%2Fclass-xxxx%2Frename

dxpy.api.gtable_set_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/setDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FsetDetails

dxpy.api.gtable_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Properties#API-method%3A-%2Fclass-xxxx%2FsetProperties

dxpy.api.gtable_set_visibility(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /gtable-xxxx/setVisibility API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Visibility#API-method%3A-%2Fclass-xxxx%2FsetVisibility

dxpy.api.gtable_new(input_params={}, always_retry=False, **kwargs)[source]

Invokes the /gtable/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/GenomicTables#API-method%3A-%2Fgtable%2Fnew

dxpy.api.job_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /job-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob-xxxx%2FaddTags

dxpy.api.job_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /job-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob-xxxx%2Fdescribe

dxpy.api.job_get_log(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /job-xxxx/getLog API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob-xxxx%2FgetLog

dxpy.api.job_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /job-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob-xxxx%2FremoveTags

dxpy.api.job_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /job-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob-xxxx%2FsetProperties

dxpy.api.job_terminate(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /job-xxxx/terminate API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob-xxxx%2Fterminate

dxpy.api.job_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /job/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Applets-and-Entry-Points#API-method%3A-%2Fjob%2Fnew

dxpy.api.notifications_get(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /notifications/get API method.

dxpy.api.notifications_mark_read(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /notifications/markRead API method.

dxpy.api.org_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2Fdescribe

dxpy.api.org_find_members(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/findMembers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2FfindMembers

dxpy.api.org_find_projects(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/findProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2FfindProjects

dxpy.api.org_find_apps(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/findApps API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2FfindApps

dxpy.api.org_invite(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/invite API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2Finvite

dxpy.api.org_remove_member(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/removeMember API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2FremoveMember

dxpy.api.org_set_member_access(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/setMemberAccess API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2FsetMemberAccess

dxpy.api.org_update(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org-xxxx/update API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg-xxxx%2Fupdate

dxpy.api.org_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /org/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Organizations#API-method%3A-%2Forg%2Fnew

dxpy.api.project_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2FaddTags

dxpy.api.project_clone(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project-xxxx/clone API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2Fclone

dxpy.api.project_decrease_permissions(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/decreasePermissions API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Project-Permissions-and-Sharing#API-method%3A-%2Fproject-xxxx%2FdecreasePermissions

dxpy.api.project_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2Fdescribe

dxpy.api.project_destroy(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/destroy API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2Fdestroy

dxpy.api.project_invite(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project-xxxx/invite API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Project-Permissions-and-Sharing#API-method%3A-%2Fproject-xxxx%2Finvite

dxpy.api.project_leave(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/leave API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Project-Permissions-and-Sharing#API-method%3A-%2Fproject-xxxx%2Fleave

dxpy.api.project_list_folder(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/listFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FlistFolder

dxpy.api.project_move(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project-xxxx/move API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2Fmove

dxpy.api.project_new_folder(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/newFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FnewFolder

dxpy.api.project_remove_folder(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project-xxxx/removeFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FremoveFolder

dxpy.api.project_remove_objects(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project-xxxx/removeObjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FremoveObjects

dxpy.api.project_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2FremoveTags

dxpy.api.project_rename_folder(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project-xxxx/renameFolder API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Folders-and-Deletion#API-method%3A-%2Fclass-xxxx%2FrenameFolder

dxpy.api.project_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2FsetProperties

dxpy.api.project_transfer(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/transfer API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Project-Permissions-and-Sharing#API-method%3A-%2Fproject-xxxx%2Ftransfer

dxpy.api.project_update(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/update API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2Fupdate

dxpy.api.project_update_sponsorship(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /project-xxxx/updateSponsorship API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject-xxxx%2FupdateSponsorship

dxpy.api.project_new(input_params={}, always_retry=False, **kwargs)[source]

Invokes the /project/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Projects#API-method%3A-%2Fproject%2Fnew

dxpy.api.record_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FaddTags

dxpy.api.record_add_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/addTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FaddTypes

dxpy.api.record_close(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/close API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Data-Object-Lifecycle#API-method%3A-%2Fclass-xxxx%2Fclose

dxpy.api.record_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Records#API-method%3A-%2Frecord-xxxx%2Fdescribe

dxpy.api.record_get_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/getDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FgetDetails

dxpy.api.record_list_projects(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/listProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2FlistProjects

dxpy.api.record_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FremoveTags

dxpy.api.record_remove_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/removeTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FremoveTypes

dxpy.api.record_rename(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/rename API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Name#API-method%3A-%2Fclass-xxxx%2Frename

dxpy.api.record_set_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/setDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FsetDetails

dxpy.api.record_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Properties#API-method%3A-%2Fclass-xxxx%2FsetProperties

dxpy.api.record_set_visibility(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record-xxxx/setVisibility API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Visibility#API-method%3A-%2Fclass-xxxx%2FsetVisibility

dxpy.api.record_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /record/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Records#API-method%3A-%2Frecord%2Fnew

dxpy.api.system_describe_data_objects(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/describeDataObjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/System-Methods#API-method:-/system/describeDataObjects

dxpy.api.system_describe_executions(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/describeExecutions API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/System-Methods#API-method:-/system/describeExecutions

dxpy.api.system_describe_projects(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/describeProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/System-Methods#API-method:-/system/describeProjects

dxpy.api.system_find_affiliates(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findAffiliates API method.

dxpy.api.system_find_apps(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findApps API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindApps

dxpy.api.system_find_data_objects(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findDataObjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindDataObjects

dxpy.api.system_resolve_data_objects(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/resolveDataObjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/System-Methods#API-method:-/system/resolveDataObjects

dxpy.api.system_find_executions(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findExecutions API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindExecutions

dxpy.api.system_find_analyses(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findAnalyses API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindAnalyses

dxpy.api.system_find_jobs(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findJobs API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindJobs

dxpy.api.system_find_projects(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindProjects

dxpy.api.system_find_users(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findUsers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method%3A-%2Fsystem%2FfindUsers

dxpy.api.system_find_project_members(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findProjectMembers API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method:-/system/findProjectMembers

dxpy.api.system_find_orgs(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/findOrgs API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method:-/system/findOrgs

Invokes the /system/globalSearch API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Search#API-method:-/system/globalSearch

dxpy.api.system_greet(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/greet API method.

dxpy.api.system_headers(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/headers API method.

dxpy.api.system_shorten_url(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/shortenURL API method.

dxpy.api.system_whoami(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /system/whoami API method.

dxpy.api.user_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /user-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Users#API-method%3A-%2Fuser-xxxx%2Fdescribe

dxpy.api.user_update(object_id, input_params={}, always_retry=False, **kwargs)[source]

Invokes the /user-xxxx/update API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Users#API-method%3A-%2Fuser-xxxx%2Fupdate

dxpy.api.workflow_add_stage(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/addStage API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FaddStage

dxpy.api.workflow_add_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/addTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FaddTags

dxpy.api.workflow_add_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/addTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FaddTypes

dxpy.api.workflow_close(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/close API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Data-Object-Lifecycle#API-method%3A-%2Fclass-xxxx%2Fclose

dxpy.api.workflow_describe(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/describe API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2Fdescribe

dxpy.api.workflow_dry_run(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/dryRun API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FdryRun

dxpy.api.workflow_get_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/getDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FgetDetails

dxpy.api.workflow_is_stage_compatible(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/isStageCompatible API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FisStageCompatible

dxpy.api.workflow_list_projects(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/listProjects API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Cloning#API-method%3A-%2Fclass-xxxx%2FlistProjects

dxpy.api.workflow_move_stage(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/moveStage API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FmoveStage

dxpy.api.workflow_overwrite(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/overwrite API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2Foverwrite

dxpy.api.workflow_remove_stage(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/removeStage API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FremoveStage

dxpy.api.workflow_remove_tags(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/removeTags API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Tags#API-method%3A-%2Fclass-xxxx%2FremoveTags

dxpy.api.workflow_remove_types(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/removeTypes API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Types#API-method%3A-%2Fclass-xxxx%2FremoveTypes

dxpy.api.workflow_rename(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/rename API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Name#API-method%3A-%2Fclass-xxxx%2Frename

dxpy.api.workflow_run(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/run API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2Frun

dxpy.api.workflow_set_details(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/setDetails API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Details-and-Links#API-method%3A-%2Fclass-xxxx%2FsetDetails

dxpy.api.workflow_set_properties(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/setProperties API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Properties#API-method%3A-%2Fclass-xxxx%2FsetProperties

dxpy.api.workflow_set_stage_inputs(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/setStageInputs API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FsetStageInputs

dxpy.api.workflow_set_visibility(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/setVisibility API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Visibility#API-method%3A-%2Fclass-xxxx%2FsetVisibility

dxpy.api.workflow_update(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/update API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2Fupdate

dxpy.api.workflow_update_stage_executable(object_id, input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow-xxxx/updateStageExecutable API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow-xxxx%2FupdateStageExecutable

dxpy.api.workflow_new(input_params={}, always_retry=True, **kwargs)[source]

Invokes the /workflow/new API method.

For more info, see: https://wiki.dnanexus.com/API-Specification-v1.0.0/Workflows-and-Analyses#API-method%3A-%2Fworkflow%2Fnew

Previous topic

4. dxpy.utils Module

Next topic

6. dxpy.exceptions Module

This Page