V3_Entity_Get (Get)
- Last UpdatedNov 06, 2025
- 3 minute read
| Get | V3_Entity_Get |
Resource Path:/api/v3/Entity
| Name | Description | Data Type |
|---|---|---|
| entId | The entity ID. | integer |
| entName | The entity name. | string |
| description | The entity description. | string |
| parentEntId | integer | |
| site | The ID of the site entity to which an entity belongs. | integer |
| hourlyCost | The hourly cost of running jobs. | number |
| 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 serve as a 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 |
| entityFromGalaxy | Indicates whether the entity was configured in an ArchestrA Galaxy and exported to the MES database using the Entity Model Builder. | boolean |
| canSchedJobsFromGalaxy | Indicates whether the canSchedJobs parameter was set by an ArchestrA Galaxy export using Entity Model Builder. | boolean |
| canRunJobsFromGalaxy | Indicates whether the canRunJobs parameter was set by an ArchestrA Galaxy export using Entity Model Builder. | boolean |
| canCaptureUtilFromGalaxy | Indicates whether the canCaptureUtil parameter was set by an ArchestrA Galaxy export using Entity Model Builder. | boolean |
| canTrackOeeFromGalaxy | Indicates whether the canTrackOee parameter was set by an ArchestrA Galaxy export using Entity Model Builder. | boolean |
| canStoreFromGalaxy | Indicates whether the canStore parameter was set by an ArchestrA Galaxy export using Entity Model Builder. | boolean |
| identicalJobExecs | The maximum number of jobs that can be run at the same time on an entity. | integer |
| showInDSPTree | Indicates whether an entity appears in the data source plug-in tree. | integer |
| entClass | Indicates whether the object is an entity class. | boolean |
| defStdOperId | The ID of the standard operation to be used when creating a work order with no reference to a process. | string |
| equipmentType | An enumeration that indicates the source of utilization and production information. 1 = manual entry 2 = automatic (information from an OCO or UCO) 3 = semiautomatic (information from either manual entry or from an OCO or UCO). The default value. | integer |
| spare1 | The user-defined content for the spare1 field. | string |
| spare2 | The user-defined content for the spare2 field. | string |
| spare3 | The user-defined content for the spare3 field. | string |
| spare4 | The user-defined content for the spare4 field. | string |
| lastEditBy | The ID of the user who added or last updated the entity record. | string |
| lastEditAt | The date and time, in UTC, of when the entity record was added or last updated. | 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_Get].
OK