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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-analysis-xxxx-addtags

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-analysis-xxxx-describe

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-analysis-xxxx-removetags

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-analysis-xxxx-setproperties

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-analysis-xxxx-terminate

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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-run

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

Invokes the /app-xxxx/validateBatch API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-validatebatch

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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-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://documentation.dnanexus.com/developer/api/running-analyses/apps#api-method-app-xxxx-yyyy-update

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

Invokes the /app/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-addtags

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-applet-xxxx-describe

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-applet-xxxx-get

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-getdetails

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://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-listprojects

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-removetags

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/name#api-method-class-xxxx-rename

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

Invokes the /applet-xxxx/validateBatch API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-applet-xxxx-validatebatch

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-applet-xxxx-run

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/properties#api-method-class-xxxx-setproperties

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

Invokes the /applet/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-applet-new

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://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-clone

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://documentation.dnanexus.com/developer/api/running-analyses/containers-for-execution#api-method-container-xxxx-describe

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-listfolder

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-move

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-newfolder

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-removefolder

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-removeobjects

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-renamefolder

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

Invokes the /database-xxxx/addTags API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-addtags

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

Invokes the /database-xxxx/addTypes API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-addtypes

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

Invokes the /database-xxxx/close API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-object-lifecycle#api-method-class-xxxx-close

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

Invokes the /database-xxxx/describe API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/databases#api-method-database-xxxx-describe

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

Invokes the /database-xxxx/getDetails API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-getdetails

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

Invokes the /database-xxxx/listProjects API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-listprojects

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

Invokes the /database-xxxx/relocate API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/databases#api-method-database-xxxx-relocate

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

Invokes the /database-xxxx/removeTags API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-removetags

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

Invokes the /database-xxxx/removeTypes API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-removetypes

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

Invokes the /database-xxxx/rename API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/name#api-method-class-xxxx-rename

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

Invokes the /database-xxxx/setDetails API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-setdetails

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

Invokes the /database-xxxx/setProperties API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/properties#api-method-class-xxxx-setproperties

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

Invokes the /database-xxxx/setVisibility API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-object-lifecycle/visibility#api-method-class-xxxx-setvisibility

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

Invokes the /database-xxxx/downloadFile API method.

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

Invokes the /database-xxxx/listFolder API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-listfolder

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-addtags

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-addtypes

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/files#api-method-file-xxxx-close

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/files#api-method-file-xxxx-describe

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/files#api-method-file-xxxx-download

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-getdetails

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://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-listprojects

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-removetags

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-removetypes

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/name#api-method-class-xxxx-rename

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-setdetails

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/properties#api-method-class-xxxx-setproperties

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/visibility#api-method-class-xxxx-setvisibility

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/files#api-method-file-xxxx-upload

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

Invokes the /file/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/files#api-method-file-new

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

Invokes the /globalworkflow-xxxx/addAuthorizedUsers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-addauthorizedusers

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

Invokes the /globalworkflow-xxxx/addCategories API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-addcategories

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

Invokes the /globalworkflow-xxxx/addDevelopers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-adddevelopers

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

Invokes the /globalworkflow-xxxx/addTags API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-addtags

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

Invokes the /globalworkflow-xxxx/delete API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-delete

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

Invokes the /globalworkflow-xxxx/describe API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-describe

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

Invokes the /globalworkflow-xxxx/listAuthorizedUsers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-listauthorizedusers

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

Invokes the /globalworkflow-xxxx/listCategories API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-listcategories

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

Invokes the /globalworkflow-xxxx/listDevelopers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-listdevelopers

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

Invokes the /globalworkflow-xxxx/publish API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-publish

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

Invokes the /globalworkflow-xxxx/removeAuthorizedUsers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-removeauthorizedusers

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

Invokes the /globalworkflow-xxxx/removeCategories API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-removecategories

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

Invokes the /globalworkflow-xxxx/removeDevelopers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-removedevelopers

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

Invokes the /globalworkflow-xxxx/removeTags API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-removetags

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

Invokes the /globalworkflow-xxxx/run API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-run

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

Invokes the /globalworkflow-xxxx/update API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-xxxx-yyyy-update

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

Invokes the /globalworkflow/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/global-workflows#api-method-globalworkflow-new

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-xxxx-addtags

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-xxxx-describe

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-xxxx-getlog

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-xxxx-removetags

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-xxxx-setproperties

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://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-xxxx-terminate

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

Invokes the /job/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/applets-and-entry-points#api-method-job-new

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-describe

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-findmembers

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-findprojects

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-findapps

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-invite

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-removemember

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-setmemberaccess

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://documentation.dnanexus.com/developer/api/organizations#api-method-org-xxxx-update

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

Invokes the /org/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/organizations#api-method-org-new

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-addtags

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://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-clone

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://documentation.dnanexus.com/developer/api/data-containers/project-permissions-and-sharing#api-method-project-xxxx-decreasepermissions

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-describe

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-destroy

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://documentation.dnanexus.com/developer/api/data-containers/project-permissions-and-sharing#api-method-project-xxxx-invite

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://documentation.dnanexus.com/developer/api/data-containers/project-permissions-and-sharing#api-method-project-xxxx-leave

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-listfolder

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-move

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-newfolder

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-removefolder

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-removeobjects

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-removetags

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://documentation.dnanexus.com/developer/api/data-containers/folders-and-deletion#api-method-class-xxxx-renamefolder

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-setproperties

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://documentation.dnanexus.com/developer/api/data-containers/project-permissions-and-sharing#api-method-project-xxxx-transfer

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-update

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://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-xxxx-updatesponsorship

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

Invokes the /project/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/data-containers/projects#api-method-project-new

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-addtags

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-addtypes

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://documentation.dnanexus.com/developer/api/data-object-lifecycle#api-method-class-xxxx-close

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/records#api-method-record-xxxx-describe

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-getdetails

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://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-listprojects

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-removetags

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-removetypes

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/name#api-method-class-xxxx-rename

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-setdetails

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/properties#api-method-class-xxxx-setproperties

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/visibility#api-method-class-xxxx-setvisibility

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

Invokes the /record/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/introduction-to-data-object-classes/records#api-method-record-new

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

Invokes the /system/describeDataObjects API method.

For more info, see: https://documentation.dnanexus.com/developer/api/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://documentation.dnanexus.com/developer/api/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://documentation.dnanexus.com/developer/api/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://documentation.dnanexus.com/developer/api/search#api-method-system-findapps

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

Invokes the /system/findDataObjects API method.

For more info, see: https://documentation.dnanexus.com/developer/api/search#api-method-system-finddataobjects

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

Invokes the /system/findGlobalWorkflows API method.

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

Invokes the /system/resolveDataObjects API method.

For more info, see: https://documentation.dnanexus.com/developer/api/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://documentation.dnanexus.com/developer/api/search#api-method-system-findexecutions

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

Invokes the /system/findAnalyses API method.

For more info, see: https://documentation.dnanexus.com/developer/api/search#api-method-system-findanalyses

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

Invokes the /system/findDatabases API method.

For more info, see: https://documentation.dnanexus.com/developer/api/search#api-method-system-finddatabases

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

Invokes the /system/findJobs API method.

For more info, see: https://documentation.dnanexus.com/developer/api/search#api-method-system-findjobs

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

Invokes the /system/findProjects API method.

For more info, see: https://documentation.dnanexus.com/developer/api/search#api-method-system-findprojects

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

Invokes the /system/findUsers API method.

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

Invokes the /system/findProjectMembers API method.

For more info, see: https://documentation.dnanexus.com/developer/api/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://documentation.dnanexus.com/developer/api/search#api-method-system-findorgs

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

Invokes the /system/generateBatchInputs API method.

For more info, see: https://documentation.dnanexus.com/developer/api/system-methods#api-method-system-generatebatchinputs

Invokes the /system/globalSearch API method.

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.

For more info, see: https://documentation.dnanexus.com/developer/api/system-methods#api-method-system-whoamiwiki.

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://documentation.dnanexus.com/developer/api/users#api-method-user-xxxx-describe

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://documentation.dnanexus.com/developer/api/users#api-method-user-xxxx-update

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-addstage

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-addtags

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-addtypes

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://documentation.dnanexus.com/developer/api/data-object-lifecycle#api-method-class-xxxx-close

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-describe

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-dryrun

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-getdetails

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-isstagecompatible

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://documentation.dnanexus.com/developer/api/data-containers/cloning#api-method-class-xxxx-listprojects

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-movestage

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-overwrite

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-removestage

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/tags#api-method-class-xxxx-removetags

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/types#api-method-class-xxxx-removetypes

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/name#api-method-class-xxxx-rename

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-run

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

Invokes the /workflow-xxxx/validateBatch API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-validatebatch

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/details-and-links#api-method-class-xxxx-setdetails

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://documentation.dnanexus.com/developer/api/introduction-to-data-object-metadata/properties#api-method-class-xxxx-setproperties

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://documentation.dnanexus.com/developer/api/data-object-lifecycle/visibility#api-method-class-xxxx-setvisibility

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-update

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://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-xxxx-updatestageexecutable

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

Invokes the /workflow/new API method.

For more info, see: https://documentation.dnanexus.com/developer/api/running-analyses/workflows-and-analyses#api-method-workflow-new

Previous topic

4. dxpy.utils Module

Next topic

6. dxpy.exceptions Module

This Page