odm_api.MetadataVersioningAsCuratorApi

All URIs are relative to http://localhost

Method	HTTP request	Description
publish_study_by_accession_as_curator	POST /api/v1/as-curator/integration/studies/{id}/tasks/publish-versions	Asynchronous task that publishes all pending versions for a single study.

publish_study_by_accession_as_curator

TaskInfo publish_study_by_accession_as_curator(id, version_message=version_message)

Asynchronous task that publishes all pending versions for a single study.

This endpoint publishes information from drafts and creates new metadata versions for the specified study and all associated objects. The version name is set to “Auto-published by API call”. Only curators with access to the specified studies can use this method.

Example

• Api Key Authentication (Access-token):
• Api Key Authentication (Genestack-API-Token):

import odm_api
from odm_api.models.task_info import TaskInfo
from odm_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = odm_api.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Access-token
configuration.api_key['Access-token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Access-token'] = 'Bearer'

# Configure API key authorization: Genestack-API-Token
configuration.api_key['Genestack-API-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Genestack-API-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with odm_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = odm_api.MetadataVersioningAsCuratorApi(api_client)
    id = 'id_example' # str | Supply the accession of the study to be published
    version_message = 'version_message_example' # str | Supply text to name this version. If not supplied the version name is set to “Auto-published by API call” (optional)

    try:
        # Asynchronous task that publishes all pending versions for a single study.
        api_response = api_instance.publish_study_by_accession_as_curator(id, version_message=version_message)
        print("The response of MetadataVersioningAsCuratorApi->publish_study_by_accession_as_curator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetadataVersioningAsCuratorApi->publish_study_by_accession_as_curator: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Supply the accession of the study to be published
version_message	str	Supply text to name this version. If not supplied the version name is set to “Auto-published by API call”	[optional]

Return type

TaskInfo

Authorization

Access-token, Genestack-API-Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Task information.	-
401	User is not authenticated. Please supply a valid Access Token in the `Authorization` HTTP header (e.g. Authorization: bearer [token]) or Genestack API token in the `Genestack-API-Token` header (this token may be obtained from the Genestack UI Profile page).	-
403	Forbidden	-
500	An internal server error occurred. This indicates an unexpected failure in the Genestack system, please file a bug report to support@genestack.com, including the error details.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]