Entity Operations (GET/POST)

Many entities offer specialized operations in order to assist users in more complicated, or performance intensive operations. These operations can act on one or more resources and may affect entities beyond the one(s) targeted in the request. The URLs may follow a “list” or “retrieve” styles:

Format for an entity operation URL evocable for a specific resource by “id”:

…/wms/lgfapi/v10/entity/{entity_name}/{id}/{operation_name}/

Format for a “bulk” entity operation URL evocable for potentially multiple resources:

…/wms/lgfapi/v10/entity/{entity_name}/{operation_name}/

Entity operations are invoked in the same manner as previously discussed for GET and POST requests. Each operation has its own URL tied to the entity. Entity operations that use a GET request are still for obtaining a representation in the response body and do not modify data. Entity operations that use POST requests trigger an action or series of actions on the entity that can change resource state.