oc-catalog/selfapi/docs/WorkspaceApi.md

119 lines
3.5 KiB
Markdown

# \WorkspaceApi
All URIs are relative to *https://localhost:49618/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**WorkspaceControllerAddModelToWorkspace**](WorkspaceApi.md#WorkspaceControllerAddModelToWorkspace) | **Post** /workspace/ |
[**WorkspaceControllerDeleteElementFromUserWorkspace**](WorkspaceApi.md#WorkspaceControllerDeleteElementFromUserWorkspace) | **Delete** /workspace/ |
[**WorkspaceControllerGetFullWorkspace**](WorkspaceApi.md#WorkspaceControllerGetFullWorkspace) | **Get** /workspace/list_model |
[**WorkspaceControllerGetWorkspace**](WorkspaceApi.md#WorkspaceControllerGetWorkspace) | **Get** /workspace/list |
# **WorkspaceControllerAddModelToWorkspace**
> WorkspaceControllerAddModelToWorkspace(ctx, id, rtype)
Insert a resource in the workspace
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string**| ID of a resource |
**rtype** | **string**| Type of resource |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)
# **WorkspaceControllerDeleteElementFromUserWorkspace**
> WorkspaceControllerDeleteElementFromUserWorkspace(ctx, id, rtype)
Remove a resource from the workspace
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string**| ID of a resource |
**rtype** | **string**| Type of resource |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)
# **WorkspaceControllerGetFullWorkspace**
> ModelsWorkspaceModel WorkspaceControllerGetFullWorkspace(ctx, )
Get full workspace elements based on user_id token
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**ModelsWorkspaceModel**](models.WorkspaceModel.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)
# **WorkspaceControllerGetWorkspace**
> ModelsWorkspace WorkspaceControllerGetWorkspace(ctx, )
Get workspace elements based on user_id token
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**ModelsWorkspace**](models.Workspace.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)