oc-catalog/selfapi/docs/DataApi.md

96 lines
2.8 KiB
Markdown

# \DataApi
All URIs are relative to *https://localhost:49618/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**DataControllerCreateData**](DataApi.md#DataControllerCreateData) | **Post** /data/ |
[**DataControllerGetDataByID**](DataApi.md#DataControllerGetDataByID) | **Get** /data/{ID} |
[**DataControllerGetMultipleDataByIDs**](DataApi.md#DataControllerGetMultipleDataByIDs) | **Get** /data/multi/{IDs} |
# **DataControllerCreateData**
> DataControllerCreateData(ctx, body)
Submit data object
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**body** | [**ModelsDataNewModel**](ModelsDataNewModel.md)| The object content |
### 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)
# **DataControllerGetDataByID**
> ModelsDataModel DataControllerGetDataByID(ctx, iD)
Find rType data based on ID
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**iD** | **string**| The ID of the data resource |
### Return type
[**ModelsDataModel**](models.DataModel.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)
# **DataControllerGetMultipleDataByIDs**
> []ModelsDataModel DataControllerGetMultipleDataByIDs(ctx, iDs)
Return Data object if found in the DB. Not found IDs will be ignored
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**iDs** | [**[]string**](string.md)| List of data IDs |
### Return type
[**[]ModelsDataModel**](models.DataModel.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)