File size: 4,908 Bytes
9d54b72 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# vcell_client.ExportResourceApi
All URIs are relative to *https://vcell.cam.uchc.edu*
Method | HTTP request | Description
------------- | ------------- | -------------
[**export_n5**](ExportResourceApi.md#export_n5) | **POST** /api/v1/export/N5 |
[**export_status**](ExportResourceApi.md#export_status) | **GET** /api/v1/export/status |
# **export_n5**
> int export_n5(n5_export_request=n5_export_request)
Create an N5 (ImageJ compatible) export. The request must contain the standard export information, exportable data type, dataset name, and sub-volume specifications.
### Example
```python
import time
import os
import vcell_client
from vcell_client.models.n5_export_request import N5ExportRequest
from vcell_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
host = "https://vcell.cam.uchc.edu"
)
# 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.
# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = vcell_client.ExportResourceApi(api_client)
n5_export_request = vcell_client.N5ExportRequest() # N5ExportRequest | (optional)
try:
api_response = api_instance.export_n5(n5_export_request=n5_export_request)
print("The response of ExportResourceApi->export_n5:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ExportResourceApi->export_n5: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**n5_export_request** | [**N5ExportRequest**](N5ExportRequest.md)| | [optional]
### Return type
**int**
### Authorization
[openId](../README.md#openId)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**400** | Bad Request. | - |
**401** | Not Authenticated | - |
**403** | Not Allowed | - |
**422** | Unprocessable content submitted | - |
**500** | Data Access Exception | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **export_status**
> List[ExportEvent] export_status(timestamp=timestamp)
Get the status of your export jobs past the timestamp (Unix epoch in seconds).
### Example
```python
import time
import os
import vcell_client
from vcell_client.models.export_event import ExportEvent
from vcell_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
host = "https://vcell.cam.uchc.edu"
)
# 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.
# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = vcell_client.ExportResourceApi(api_client)
timestamp = 56 # int | (optional)
try:
api_response = api_instance.export_status(timestamp=timestamp)
print("The response of ExportResourceApi->export_status:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ExportResourceApi->export_status: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**timestamp** | **int**| | [optional]
### Return type
[**List[ExportEvent]**](ExportEvent.md)
### Authorization
[openId](../README.md#openId)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authenticated | - |
**403** | Not Allowed | - |
**500** | Data Access Exception | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|