libica.openapi.libgds.FoldersApi

All URIs are relative to https://aps2.platform.illumina.com

Method	HTTP request	Description
archive_folder	POST /v1/folders/{folderId}:archive	Archive a folder
bulk_folder_update	PATCH /v1/folders	Updates list of folders with metadata
bulk_metadata_folder_update	PATCH /v1/folders/bulkMetadataFolderUpdate	Updates list of folders with metadata
complete_folder_session	POST /v1/folders/{folderId}/sessions/{sessionId}:complete	Complete a folder upload in GDS
copy_folder	POST /v1/folders/{folderId}:copy	Copy a folder
create_folder	POST /v1/folders	Create a folder in GDS and receive credentials for upload
create_folder_session	POST /v1/folders/{folderId}/sessions	Create a session
delete_folder	DELETE /v1/folders/{folderId}	Deletes a folder by id
get_folder	GET /v1/folders/{folderId}	Get information about a folder in GDS.
get_folder_job	GET /v1/folders/{folderId}/jobs/{jobId}	Get status of a folder job in GDS
get_folder_session	GET /v1/folders/{folderId}/sessions/{sessionId}	Get status of a folder upload in GDS
list_folders	GET /v1/folders	Get a list of folders
move_folder	POST /v1/folders/{folderId}:move	Move a folder
unarchive_folder	POST /v1/folders/{folderId}:unarchive	Unarchive a folder
update_folder	PATCH /v1/folders/{folderId}	Update a folder content or acl

archive_folder

FolderResponse archive_folder(folder_id, body)

Archive a folder

Archives a folder to a lower storage cost tier.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to be archived.
body = libica.openapi.libgds.FolderArchiveRequest() # FolderArchiveRequest | 

    try:
        # Archive a folder
        api_response = api_instance.archive_folder(folder_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->archive_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to be archived.
body	FolderArchiveRequest

Return type

FolderResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json-patch+json, application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
409	Conflict.	-
500	Server Error	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

bulk_folder_update

BulkFolderUpdateResponse bulk_folder_update(body=body)

Updates list of folders with metadata

Updates list of folders with metadata

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    body = libica.openapi.libgds.BulkFolderUpdateRequest() # BulkFolderUpdateRequest |  (optional)

    try:
        # Updates list of folders with metadata
        api_response = api_instance.bulk_folder_update(body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->bulk_folder_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	BulkFolderUpdateRequest		[optional]

Return type

BulkFolderUpdateResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
202	Accepted.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

bulk_metadata_folder_update

JobResponse bulk_metadata_folder_update(body=body)

Updates list of folders with metadata

Updates list of folders with metadata

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    body = libica.openapi.libgds.BulkFolderMetadataUpdateRequest() # BulkFolderMetadataUpdateRequest |  (optional)

    try:
        # Updates list of folders with metadata
        api_response = api_instance.bulk_metadata_folder_update(body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->bulk_metadata_folder_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	BulkFolderMetadataUpdateRequest		[optional]

Return type

JobResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success.	-
202	Accepted	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

complete_folder_session

SessionResponse complete_folder_session(folder_id, session_id, body)

Complete a folder upload in GDS

Complete a folder upload in GDS.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder related to the upload session.
session_id = 'session_id_example' # str | The id of the upload session
body = libica.openapi.libgds.CompleteSessionRequest() # CompleteSessionRequest | The request body

    try:
        # Complete a folder upload in GDS
        api_response = api_instance.complete_folder_session(folder_id, session_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->complete_folder_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder related to the upload session.
session_id	str	The id of the upload session
body	CompleteSessionRequest	The request body

Return type

SessionResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Completed upload session.	-
202	Upload session in progress.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not found.	-
409	Conflict	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

copy_folder

JobResponse copy_folder(folder_id, body, tenant_id=tenant_id)

Copy a folder

Copy a folder into a target parent folder

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to be copied.
body = libica.openapi.libgds.FolderCopyRequest() # FolderCopyRequest | 
tenant_id = 'tenant_id_example' # str | Optional parameter to copy from a shared folder in another tenant (optional)

    try:
        # Copy a folder
        api_response = api_instance.copy_folder(folder_id, body, tenant_id=tenant_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->copy_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to be copied.
body	FolderCopyRequest
tenant_id	str	Optional parameter to copy from a shared folder in another tenant	[optional]

Return type

JobResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json-patch+json, application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
409	Conflict.	-
500	Server Error	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

create_folder

FolderWriteableResponse create_folder(body, include=include, folder_list_secret=folder_list_secret)

Create a folder in GDS and receive credentials for upload

Create a folder entry in GDS. Returns temporary credentials for folder upload directly to S3 when the include=objectStoreAccess parameter is used. Volume ID or volume name is required for folder creation. If a folder path is provided and does not exist, GDS automatically creates the folder path in the appropriate account.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    body = libica.openapi.libgds.CreateFolderRequest() # CreateFolderRequest | 
include = 'include_example' # str | Optionally include additional fields in the response.              Possible values: ObjectStoreAccess (optional)
folder_list_secret = 'folder_list_secret_example' # str |  (optional)

    try:
        # Create a folder in GDS and receive credentials for upload
        api_response = api_instance.create_folder(body, include=include, folder_list_secret=folder_list_secret)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->create_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	CreateFolderRequest
include	str	Optionally include additional fields in the response. Possible values: ObjectStoreAccess	[optional]
folder_list_secret	str		[optional]

Return type

FolderWriteableResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created new Folder.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
409	A conflict was found. Make sure the new Folder doesn't already exist.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

create_folder_session

CreateSessionResponse create_folder_session(folder_id, body)

Create a session

Create a session and credentials used for accessing the object store directly

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | 
body = libica.openapi.libgds.CreateSessionRequest() # CreateSessionRequest | 

    try:
        # Create a session
        api_response = api_instance.create_folder_session(folder_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->create_folder_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str
body	CreateSessionRequest

Return type

CreateSessionResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
0	Error	-

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

delete_folder

FolderResponse delete_folder(folder_id)

Deletes a folder by id

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to be deleted.

    try:
        # Deletes a folder by id
        api_response = api_instance.delete_folder(folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->delete_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to be deleted.

Return type

FolderResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Accepted.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

get_folder

FolderResponse get_folder(folder_id, tenant_id=tenant_id, include_volume_metadata=include_volume_metadata, include_active_jobs=include_active_jobs, metadata_include=metadata_include, metadata_exclude=metadata_exclude, include=include)

Get information about a folder in GDS.

Get information for the specified folder ID.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to retrieve.
tenant_id = 'tenant_id_example' # str | Optional parameter to see shared data in another tenant (optional)
include_volume_metadata = True # bool | Optional parameter to return volume's metadata (optional)
include_active_jobs = True # bool | Optional parameter to return active jobs associated to folder (optional)
metadata_include = 'metadata_include_example' # str | Optional parameter to specify comma separated patterns to include metadata by their field names. (optional)
metadata_exclude = 'metadata_exclude_example' # str | Optional parameter to specify comma separated patterns to exclude metadata by their field names. (optional)
include = 'include_example' # str | Optionally include additional fields in the response.              Possible values: ObjectStoreAccess (optional)

    try:
        # Get information about a folder in GDS.
        api_response = api_instance.get_folder(folder_id, tenant_id=tenant_id, include_volume_metadata=include_volume_metadata, include_active_jobs=include_active_jobs, metadata_include=metadata_include, metadata_exclude=metadata_exclude, include=include)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->get_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to retrieve.
tenant_id	str	Optional parameter to see shared data in another tenant	[optional]
include_volume_metadata	bool	Optional parameter to return volume's metadata	[optional]
include_active_jobs	bool	Optional parameter to return active jobs associated to folder	[optional]
metadata_include	str	Optional parameter to specify comma separated patterns to include metadata by their field names.	[optional]
metadata_exclude	str	Optional parameter to specify comma separated patterns to exclude metadata by their field names.	[optional]
include	str	Optionally include additional fields in the response. Possible values: ObjectStoreAccess	[optional]

Return type

FolderResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

get_folder_job

JobResponse get_folder_job(folder_id, job_id)

Get status of a folder job in GDS

Get status of a folder job in GDS.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder related to the job.
job_id = 'job_id_example' # str | The id of the job

    try:
        # Get status of a folder job in GDS
        api_response = api_instance.get_folder_job(folder_id, job_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->get_folder_job: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder related to the job.
job_id	str	The id of the job

Return type

JobResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returned job.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not found.	-
409	Conflict	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

get_folder_session

SessionResponse get_folder_session(folder_id, session_id)

Get status of a folder upload in GDS

Get status of a folder upload in GDS.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder related to the upload session.
session_id = 'session_id_example' # str | The id of the upload session

    try:
        # Get status of a folder upload in GDS
        api_response = api_instance.get_folder_session(folder_id, session_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->get_folder_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder related to the upload session.
session_id	str	The id of the upload session

Return type

SessionResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Completed upload session.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not found.	-
409	Conflict	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

list_folders

FolderListResponse list_folders(volume_id=volume_id, volume_name=volume_name, path=path, job_statuses=job_statuses, acls=acls, recursive=recursive, page_size=page_size, page_token=page_token, include=include, tenant_id=tenant_id, metadata_include=metadata_include, metadata_exclude=metadata_exclude)

Get a list of folders

Given a volumeId or volume name, get a list of folders accessible by the JWT. The default sort returned is alphabetical, ascending. The default page size is 10 items

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    volume_id = ['volume_id_example'] # list[str] | Optional field that specifies comma-separated volume IDs to include in the list (optional)
volume_name = ['volume_name_example'] # list[str] | Optional field that specifies comma-separated volume names to include in the list (optional)
path = ['path_example'] # list[str] | Optional field that specifies comma-separated paths to include in the list. Value can use wildcards (e.g. /a/b/c/*) or exact matches (e.g. /a/b/c/d/). (optional)
job_statuses = 'job_statuses_example' # str | Optional field that specifies comma-separated JobStatuses to include in the list (optional)
acls = ['acls_example'] # list[str] | Optional field that specifies comma-separated acls to include in the list (optional)
recursive = True # bool | Optional field to specify if folders should be returned recursively in and under the specified paths, or only directly in the specified paths (optional)
page_size = 56 # int | START_DESC END_DESC (optional)
page_token = 'page_token_example' # str | START_DESC END_DESC (optional)
include = 'include_example' # str | Optionally include additional fields in the response. Multiple fields can be included by comma-separation.  Possible values: TotalItemCount, InheritedAcl (optional)
tenant_id = 'tenant_id_example' # str | Optional parameter to see shared data in another tenant (optional)
metadata_include = 'metadata_include_example' # str | Optional parameter to specify comma separated patterns to include metadata by their field names. (optional)
metadata_exclude = 'metadata_exclude_example' # str | Optional parameter to specify comma separated patterns to exclude metadata by their field names. (optional)

    try:
        # Get a list of folders
        api_response = api_instance.list_folders(volume_id=volume_id, volume_name=volume_name, path=path, job_statuses=job_statuses, acls=acls, recursive=recursive, page_size=page_size, page_token=page_token, include=include, tenant_id=tenant_id, metadata_include=metadata_include, metadata_exclude=metadata_exclude)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->list_folders: %s\n" % e)

Parameters

Name	Type	Description	Notes
volume_id	list[str]	Optional field that specifies comma-separated volume IDs to include in the list	[optional]
volume_name	list[str]	Optional field that specifies comma-separated volume names to include in the list	[optional]
path	list[str]	Optional field that specifies comma-separated paths to include in the list. Value can use wildcards (e.g. /a/b/c/*) or exact matches (e.g. /a/b/c/d/).	[optional]
job_statuses	str	Optional field that specifies comma-separated JobStatuses to include in the list	[optional]
acls	list[str]	Optional field that specifies comma-separated acls to include in the list	[optional]
recursive	bool	Optional field to specify if folders should be returned recursively in and under the specified paths, or only directly in the specified paths	[optional]
page_size	int	START_DESC END_DESC	[optional]
page_token	str	START_DESC END_DESC	[optional]
include	str	Optionally include additional fields in the response. Multiple fields can be included by comma-separation. Possible values: TotalItemCount, InheritedAcl	[optional]
tenant_id	str	Optional parameter to see shared data in another tenant	[optional]
metadata_include	str	Optional parameter to specify comma separated patterns to include metadata by their field names.	[optional]
metadata_exclude	str	Optional parameter to specify comma separated patterns to exclude metadata by their field names.	[optional]

Return type

FolderListResponse

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

move_folder

JobResponse move_folder(folder_id, body)

Move a folder

Move a folder into a target parent folder

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to be moved.
body = libica.openapi.libgds.FolderMoveRequest() # FolderMoveRequest | 

    try:
        # Move a folder
        api_response = api_instance.move_folder(folder_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->move_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to be moved.
body	FolderMoveRequest

Return type

JobResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json-patch+json, application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
409	Conflict.	-
500	Server Error	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

unarchive_folder

FolderResponse unarchive_folder(folder_id, body)

Unarchive a folder

Unarchive a folder from a lower storage cost tier.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to be unarchived.
body = libica.openapi.libgds.FolderUnarchiveRequest() # FolderUnarchiveRequest | 

    try:
        # Unarchive a folder
        api_response = api_instance.unarchive_folder(folder_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->unarchive_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to be unarchived.
body	FolderUnarchiveRequest

Return type

FolderResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json-patch+json, application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
409	Conflict.	-
500	Server Error	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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

update_folder

FolderWriteableResponse update_folder(folder_id, include=include, folder_list_secret=folder_list_secret, body=body)

Update a folder content or acl

Update an existing folder in GDS and return upload credentials for that folder. Changes to the folder name and other metadata are not supported at this time. Optionally overwrite the acl for this folder if acl is provided in the request.

Example

• Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FoldersApi(api_client)
    folder_id = 'folder_id_example' # str | Unique identifier for the folder to be updated.
include = 'include_example' # str | Optionally include additional fields in the response.              Possible values: ObjectStoreAccess (optional)
folder_list_secret = 'folder_list_secret_example' # str |  (optional)
body = libica.openapi.libgds.FolderUpdateRequest() # FolderUpdateRequest |  (optional)

    try:
        # Update a folder content or acl
        api_response = api_instance.update_folder(folder_id, include=include, folder_list_secret=folder_list_secret, body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FoldersApi->update_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
folder_id	str	Unique identifier for the folder to be updated.
include	str	Optionally include additional fields in the response. Possible values: ObjectStoreAccess	[optional]
folder_list_secret	str		[optional]
body	FolderUpdateRequest		[optional]

Return type

FolderWriteableResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json-patch+json, application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success.	-
400	Bad request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Folder not found.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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