EntityApi.md

Swagger\Client\EntityApi

All URIs are relative to https://localhost/api/v5

Method	HTTP request	Description
createEntity	POST /entity	Spawn an entity
executeMethod	POST /entity/{entity}/method	Execute a method
getEntity	GET /entity/{entity}	Get entity
listEntities	GET /entity	List entities
modifyEntity	PUT /entity/{entity}	Modify an entity
removeEntity	DELETE /entity/{entity}	Destroy an entity

createEntity

\Swagger\Client\Model\Entity createEntity($body, $details, $accept, $pretty)

Spawn an entity

Creates & Spawns a new entity with the specified properties. Required permissions: - entity.create

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\EntityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\CreateEntityRequest(); // \Swagger\Client\Model\CreateEntityRequest | 
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->createEntity($body, $details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->createEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\CreateEntityRequest		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

executeMethod

\Swagger\Client\Model\ExecuteMethodResponse executeMethod($entity, $body, $details, $accept, $pretty)

Execute a method

Provides direct access to the underlaying entity object and can execute any method on it. Required permissions: - entity.method

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\EntityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$entity = "entity_example"; // string | The uuid of the entity
$body = new \Swagger\Client\Model\ExecuteMethodRequest(); // \Swagger\Client\Model\ExecuteMethodRequest | 
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->executeMethod($entity, $body, $details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->executeMethod: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
entity	string	The uuid of the entity
body	\Swagger\Client\Model\ExecuteMethodRequest		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\ExecuteMethodResponse

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntity

\Swagger\Client\Model\Entity getEntity($entity, $details, $accept, $pretty)

Get entity

Get detailed information about an entity. Required permissions: - entity.one

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\EntityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$entity = "entity_example"; // string | The uuid of the entity
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->getEntity($entity, $details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
entity	string	The uuid of the entity
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listEntities

\Swagger\Client\Model\Entity[] listEntities($world, $type, $min, $max, $limit, $details, $accept, $pretty)

List entities

Get a list of all entities on the server (in all worlds). Required permissions: - entity.list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\EntityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$world = "world_example"; // string | The world to filter the entities by
$type = "type_example"; // string | The type id of the entities to filter by
$min = "min_example"; // string | The minimum coordinates at which the entity must be, min=x|y|z
$max = "max_example"; // string | The maximum coordinates at which the entity must be, max=x|y|z
$limit = 56; // int | The maximum amount of entities returned
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->listEntities($world, $type, $min, $max, $limit, $details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->listEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
world	string	The world to filter the entities by	[optional]
type	string	The type id of the entities to filter by	[optional]
min	string	The minimum coordinates at which the entity must be, min=x	y
max	string	The maximum coordinates at which the entity must be, max=x	y
limit	int	The maximum amount of entities returned	[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\Entity[]

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

modifyEntity

\Swagger\Client\Model\Entity modifyEntity($entity, $body, $details, $accept, $pretty)

Modify an entity

Modify the properties of an existing entity. Required permissions: - entity.modify

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\EntityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$entity = "entity_example"; // string | The uuid of the entity
$body = new \Swagger\Client\Model\UpdateEntityRequest(); // \Swagger\Client\Model\UpdateEntityRequest | 
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->modifyEntity($entity, $body, $details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->modifyEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
entity	string	The uuid of the entity
body	\Swagger\Client\Model\UpdateEntityRequest		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeEntity

\Swagger\Client\Model\Entity removeEntity($entity, $details, $accept, $pretty)

Destroy an entity

Destroys an entity. Required permissions: - entity.delete

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\EntityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$entity = "entity_example"; // string | The uuid of the entity
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->removeEntity($entity, $details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->removeEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
entity	string	The uuid of the entity
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

EntityApi.md

Latest commit

History

EntityApi.md

File metadata and controls

Swagger\Client\EntityApi

createEntity

Example

Parameters

Return type

Authorization

HTTP request headers

executeMethod

Example

Parameters

Return type

Authorization

HTTP request headers

getEntity

Example

Parameters

Return type

Authorization

HTTP request headers

listEntities

Example

Parameters

Return type

Authorization

HTTP request headers

modifyEntity

Example

Parameters

Return type

Authorization

HTTP request headers

removeEntity

Example

Parameters

Return type

Authorization

HTTP request headers