Skip to content
UnsupportedApi.md 5.61 KiB
Newer Older
Kevin Di Lallo's avatar
Kevin Di Lallo committed
# UnsupportedApi

All URIs are relative to *https://localhost/sandboxname/wai/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**MeasurementLinkListMeasurementsGET**](UnsupportedApi.md#MeasurementLinkListMeasurementsGET) | **Get** /measurements | Retrieve information on measurements configuration
[**MeasurementsDELETE**](UnsupportedApi.md#MeasurementsDELETE) | **Delete** /measurements/{measurementConfigId} | Cancel a measurement configuration
[**MeasurementsGET**](UnsupportedApi.md#MeasurementsGET) | **Get** /measurements/{measurementConfigId} | Retrieve information on an existing measurement configuration
[**MeasurementsPOST**](UnsupportedApi.md#MeasurementsPOST) | **Post** /measurements | Create a new measurement configuration
[**MeasurementsPUT**](UnsupportedApi.md#MeasurementsPUT) | **Put** /measurements/{measurementConfigId} | Modify an existing measurement configuration

# **MeasurementLinkListMeasurementsGET**
> MeasurementConfigLinkList MeasurementLinkListMeasurementsGET(ctx, )
Kevin Di Lallo's avatar
Kevin Di Lallo committed
Retrieve information on measurements configuration

Queries information on measurements configuration
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Required Parameters
Kevin Di Lallo's avatar
Kevin Di Lallo committed
This endpoint does not need any parameter.

### Return type

[**MeasurementConfigLinkList**](../Models/MeasurementConfigLinkList.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json
Kevin Di Lallo's avatar
Kevin Di Lallo committed

[[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)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

# **MeasurementsDELETE**
> MeasurementsDELETE(ctx, measurementConfigId)
Kevin Di Lallo's avatar
Kevin Di Lallo committed
Cancel a measurement configuration

Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Required Parameters
Kevin Di Lallo's avatar
Kevin Di Lallo committed

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **measurementConfigId** | **string**| Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request | 
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Return type

 (empty response body)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/problem+json
Kevin Di Lallo's avatar
Kevin Di Lallo committed

[[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)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

# **MeasurementsGET**
> MeasurementConfig MeasurementsGET(ctx, measurementConfigId)
Kevin Di Lallo's avatar
Kevin Di Lallo committed
Retrieve information on an existing measurement configuration

Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Required Parameters
Kevin Di Lallo's avatar
Kevin Di Lallo committed

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **measurementConfigId** | **string**| Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request | 
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Return type

[**MeasurementConfig**](../Models/MeasurementConfig.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json
Kevin Di Lallo's avatar
Kevin Di Lallo committed

[[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)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

# **MeasurementsPOST**
> MeasurementConfig MeasurementsPOST(ctx, body)
Kevin Di Lallo's avatar
Kevin Di Lallo committed
Create a new measurement configuration

Creates a new measurement configuration
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Required Parameters
Kevin Di Lallo's avatar
Kevin Di Lallo committed

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **MeasurementConfig** | [**MeasurementConfig**](../Models/MeasurementConfig.md)| Measurement configuration information |

### Return type

[**MeasurementConfig**](../Models/MeasurementConfig.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json

[[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)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

# **MeasurementsPUT**
> MeasurementConfig MeasurementsPUT(ctx, body, measurementConfigId)
Kevin Di Lallo's avatar
Kevin Di Lallo committed
Modify an existing measurement configuration

Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Required Parameters
Kevin Di Lallo's avatar
Kevin Di Lallo committed

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**MeasurementConfig**](../Models/MeasurementConfig.md)| Measurement configuration to be modified | 
  **measurementConfigId** | **string**| Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request | 
Kevin Di Lallo's avatar
Kevin Di Lallo committed

### Return type

[**MeasurementConfig**](../Models/MeasurementConfig.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/problem+json

[[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)
Kevin Di Lallo's avatar
Kevin Di Lallo committed