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

Entity createEntity(body, details, accept, pretty)

Spawn an entity

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EntityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

EntityApi apiInstance = new EntityApi();
CreateEntityRequest body = new CreateEntityRequest(); // CreateEntityRequest | 
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    Entity result = apiInstance.createEntity(body, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntityApi#createEntity");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	CreateEntityRequest		[optional]
details	Boolean	Add to include additional details, omit or false otherwise	[optional]
accept	String	Override the 'Accept' request header (useful for debugging your requests)	[optional] [enum: json, xml]
pretty	Boolean	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

executeMethod

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

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EntityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

EntityApi apiInstance = new EntityApi();
UUID entity = new UUID(); // UUID | The uuid of the entity
ExecuteMethodRequest body = new ExecuteMethodRequest(); // ExecuteMethodRequest | 
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    ExecuteMethodResponse result = apiInstance.executeMethod(entity, body, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntityApi#executeMethod");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
entity	UUID	The uuid of the entity
body	ExecuteMethodRequest		[optional]
details	Boolean	Add to include additional details, omit or false otherwise	[optional]
accept	String	Override the 'Accept' request header (useful for debugging your requests)	[optional] [enum: json, xml]
pretty	Boolean	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

ExecuteMethodResponse

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

getEntity

Entity getEntity(entity, details, accept, pretty)

Get entity

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EntityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

EntityApi apiInstance = new EntityApi();
UUID entity = new UUID(); // UUID | The uuid of the entity
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    Entity result = apiInstance.getEntity(entity, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntityApi#getEntity");
    e.printStackTrace();
}

Parameters

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

Return type

Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

listEntities

List<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

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EntityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

EntityApi apiInstance = new EntityApi();
String world = "world_example"; // String | The world to filter the entities by
String type = "type_example"; // String | The type id of the entities to filter by
String min = "min_example"; // String | The minimum coordinates at which the entity must be, min=x|y|z
String max = "max_example"; // String | The maximum coordinates at which the entity must be, max=x|y|z
Integer limit = 56; // Integer | The maximum amount of entities returned
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    List<Entity> result = apiInstance.listEntities(world, type, min, max, limit, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntityApi#listEntities");
    e.printStackTrace();
}

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	Integer	The maximum amount of entities returned	[optional]
details	Boolean	Add to include additional details, omit or false otherwise	[optional]
accept	String	Override the 'Accept' request header (useful for debugging your requests)	[optional] [enum: json, xml]
pretty	Boolean	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

List<Entity>

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

modifyEntity

Entity modifyEntity(entity, body, details, accept, pretty)

Modify an entity

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EntityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

EntityApi apiInstance = new EntityApi();
UUID entity = new UUID(); // UUID | The uuid of the entity
UpdateEntityRequest body = new UpdateEntityRequest(); // UpdateEntityRequest | 
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    Entity result = apiInstance.modifyEntity(entity, body, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntityApi#modifyEntity");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
entity	UUID	The uuid of the entity
body	UpdateEntityRequest		[optional]
details	Boolean	Add to include additional details, omit or false otherwise	[optional]
accept	String	Override the 'Accept' request header (useful for debugging your requests)	[optional] [enum: json, xml]
pretty	Boolean	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

removeEntity

Entity removeEntity(entity, details, accept, pretty)

Destroy an entity

Destroys an entity. Required permissions: - entity.delete

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EntityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

EntityApi apiInstance = new EntityApi();
UUID entity = new UUID(); // UUID | The uuid of the entity
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    Entity result = apiInstance.removeEntity(entity, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntityApi#removeEntity");
    e.printStackTrace();
}

Parameters

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

Return type

Entity

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

Files

EntityApi.md

Latest commit

History

EntityApi.md

File metadata and controls

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