Entity_Get (Get)
- Last UpdatedNov 06, 2025
- 1 minute read
| Get | Entity_Get |
Resource Path:/api/Entity
| Name | Description | Data Type |
|---|---|---|
| name | The entity name. This can be a partial name, in which case all entities whose name includes this string will be considered a match. | string |
| description | The entity description. This can be a partial description, in which case all entities whose description includes this string will be considered a match. | string |
| canStore | An indication whether the entities can serve as a storage location. | boolean |
| canSchedJobs | An indication whether the entities can schedule jobs. | boolean |
The response body is of type Array[Mes.WebApi.Models.Entity].
Get all entities:
api/entity
Get all entities whose name includes Roaster:
api/entity?name=Roaster
Examples: Work Tasks Lookup
Get all entities:
api/entity
Get all entities, filtered by an entity name:
api/entity?name={name}
The entities to be retrieved are determined by the filter parameters. Passing no filter parameters will retrieve all entities.