V3_Entity_GetByFilter (Get)
- Last UpdatedNov 06, 2025
- 2 minute read
| Get | V3_Entity_GetByFilter |
Resource Path:/api/v3/Entity/filter
| Name | Description | Data Type |
|---|---|---|
| entName | The entity name. | string |
| description | The entity description. | string |
| canSchedJobs | Indicates whether jobs can be scheduled to an entity. | boolean |
| canRunJobs | Indicates whether jobs can be run on an entity. | boolean |
| canCaptureUtil | Indicates whether utilization data can be captured on an entity. | boolean |
| canCaptureLabor | Indicates whether labor data be captured on an entity. | boolean |
| canDoDNC | Not used. Will always be set to False. | boolean |
| canTrackOEE | Indicates whether OEE statistics can be captured on an entity. | boolean |
| canSchedShifts | Indicates whether shifts can be scheduled for an entity. | boolean |
| canStore | Indicates whether an entity can be a “warehouse” or storage location. | boolean |
| canLogData | Indicates whether an entity can log data. | boolean |
| canShip | Indicates whether shipments can be made from an entity. | boolean |
| canReceive | Indicates whether material can be received at an entity. | boolean |
| canCopyFolders | Indicates whether files in folders for an entity can be copied to its download directories. | boolean |
| canCaptureQmData | Indicates whether Quality Management data can be captured on an entity. | boolean |
| canEntClass | Indicates whether to include entity classes in the returned entity objects. | boolean |
| parentEntList | An array of strings, each containing a parent entity name by which to filter the entities. | Array[string] |
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
| max_rows | Used to supply the maximum number of rows that will be returned by the get. |
The response body is of type Array[Generated.Models.V3_Entity_GetByFilter].
OK