# WeaviateApi.CommandsApi
All URIs are relative to *https://localhost/weaviate/v1-alpha*
Method | HTTP request | Description
------------- | ------------- | -------------
[**weaveCommandsCancel**](CommandsApi.md#weaveCommandsCancel) | **POST** /commands/{commandId}/cancel |
[**weaveCommandsDelete**](CommandsApi.md#weaveCommandsDelete) | **DELETE** /commands/{commandId} |
[**weaveCommandsGet**](CommandsApi.md#weaveCommandsGet) | **GET** /commands/{commandId} |
[**weaveCommandsGetQueue**](CommandsApi.md#weaveCommandsGetQueue) | **GET** /commands/queue |
[**weaveCommandsInsert**](CommandsApi.md#weaveCommandsInsert) | **POST** /commands |
[**weaveCommandsList**](CommandsApi.md#weaveCommandsList) | **GET** /commands |
[**weaveCommandsPatch**](CommandsApi.md#weaveCommandsPatch) | **PATCH** /commands/{commandId} |
[**weaveCommandsUpdate**](CommandsApi.md#weaveCommandsUpdate) | **PUT** /commands/{commandId} |
# **weaveCommandsCancel**
> Command weaveCommandsCancel(commandId, opts)
Cancels a command.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var commandId = "commandId_example"; // String | Command ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'hl': "hl_example" // String | Specifies the language code that should be used for text values in the API response.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsCancel(commandId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commandId** | **String**| Command ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
### Return type
[**Command**](Command.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsDelete**
> weaveCommandsDelete(commandId, opts)
Deletes a command.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var commandId = "commandId_example"; // String | Unique command ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'hl': "hl_example" // String | Specifies the language code that should be used for text values in the API response.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.weaveCommandsDelete(commandId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commandId** | **String**| Unique command ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
### Return type
null (empty response body)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsGet**
> Command weaveCommandsGet(commandId, opts)
Returns a particular command.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var commandId = "commandId_example"; // String | Unique command ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'attachmentPath': "attachmentPath_example", // String | Path to the blob inside the command, for now only two values are supported: \"parameters\" and \"results\".
'hl': "hl_example" // String | Specifies the language code that should be used for text values in the API response.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsGet(commandId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commandId** | **String**| Unique command ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**attachmentPath** | **String**| Path to the blob inside the command, for now only two values are supported: \"parameters\" and \"results\". | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
### Return type
[**Command**](Command.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsGetQueue**
> CommandsQueueResponse weaveCommandsGetQueue(deviceId, opts)
Returns queued commands that device is supposed to execute. This method may be used only by devices.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var deviceId = "deviceId_example"; // String | Device ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
'maxResults': 56, // Number |
'startIndex': 56, // Number |
'token': "token_example" // String |
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsGetQueue(deviceId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deviceId** | **String**| Device ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
**maxResults** | **Number**| | [optional]
**startIndex** | **Number**| | [optional]
**token** | **String**| | [optional]
### Return type
[**CommandsQueueResponse**](CommandsQueueResponse.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsInsert**
> Command weaveCommandsInsert(opts)
Creates and sends a new command.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'executeAfter': "executeAfter_example", // String | ID of the command that was sent before this command. Use this to ensure the order of commands.
'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
'responseAwaitMs': "responseAwaitMs_example", // String | Number of milliseconds to wait for device response before returning.
'body': new WeaviateApi.Command() // Command |
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsInsert(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**executeAfter** | **String**| ID of the command that was sent before this command. Use this to ensure the order of commands. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
**responseAwaitMs** | **String**| Number of milliseconds to wait for device response before returning. | [optional]
**body** | [**Command**](Command.md)| | [optional]
### Return type
[**Command**](Command.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsList**
> CommandsListResponse weaveCommandsList(deviceId, opts)
Lists all commands in reverse order of creation.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var deviceId = "deviceId_example"; // String | Device ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'byUser': "byUser_example", // String | List all the commands issued by the user. Special value 'me' can be used to list by the current user.
'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
'maxResults': 56, // Number |
'startIndex': 56, // Number |
'state': "state_example", // String | Command state.
'token': "token_example" // String |
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsList(deviceId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deviceId** | **String**| Device ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**byUser** | **String**| List all the commands issued by the user. Special value 'me' can be used to list by the current user. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
**maxResults** | **Number**| | [optional]
**startIndex** | **Number**| | [optional]
**state** | **String**| Command state. | [optional]
**token** | **String**| | [optional]
### Return type
[**CommandsListResponse**](CommandsListResponse.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsPatch**
> Command weaveCommandsPatch(commandId, opts)
Updates a command. This method may be used only by devices. This method supports patch semantics.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var commandId = "commandId_example"; // String | Unique command ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
'body': new WeaviateApi.Command() // Command |
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsPatch(commandId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commandId** | **String**| Unique command ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
**body** | [**Command**](Command.md)| | [optional]
### Return type
[**Command**](Command.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml
# **weaveCommandsUpdate**
> Command weaveCommandsUpdate(commandId, opts)
Updates a command. This method may be used only by devices.
### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
var apiInstance = new WeaviateApi.CommandsApi();
var commandId = "commandId_example"; // String | Unique command ID.
var opts = {
'alt': "json", // String | Data format for the response.
'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
'body': new WeaviateApi.Command() // Command |
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.weaveCommandsUpdate(commandId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commandId** | **String**| Unique command ID. |
**alt** | **String**| Data format for the response. | [optional] [default to json]
**fields** | **String**| Selector specifying which fields to include in a partial response. | [optional]
**key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional]
**oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional]
**prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
**quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional]
**userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional]
**hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional]
**body** | [**Command**](Command.md)| | [optional]
### Return type
[**Command**](Command.md)
### Authorization
[apiKey](../README.md#apiKey)
### HTTP request headers
- **Content-Type**: application/json, application/protobuf, application/xml
- **Accept**: application/json, application/protobuf, application/xml