Mes.WebApi.Models.Entity JSON Schema

Description

The Entity model represents an entity object.

Properties

Name	Description	Data Type
entID	The entity ID.	integer
entName	The entity name.	string
entDescription	The entity description.	string
parentID	The parent ID from which this entity will inherit entity associations that can only be inherited from one parent entity, such as a shift schedule. For a top-level entity, the value will be null.	integer
preferredParent	The indication whether the parent entity that the ParentID value identified is the preferred parent. For entities with multiple parents, the default parent entity—or preferred parent—determines at which parent entity the system will look when determining the entity's inherited associations. If the preferred parent has the entity associations that can only be inherited from one parent entity, such as a shift schedule, this property will be true. If the preferred parent does not have any of the entity associations that can only be inherited from one parent entity, such as a shift schedule, the system looks up through the preferred parent's ancestors for a parent that does. That parent will be the one identified by the ParentID value and this property will be false.	boolean
canSchedJobs	The indication whether the jobs can be scheduled to this entity.	boolean
canRunJobs	The indication whether the jobs can be run on this entity. For an entity on a line, this value will always be True.	boolean
canCaptureUtil	The indication whether the utilization data can be captured on this entity. For an entity on a line, this value will always be true.	boolean
canCaptureLabor	The indication whether the labor data can be captured on this entity.	boolean
canTrackOEE	The indication whether the OEE statistics can be captured on this entity. For an entity on a line, this value will always be true.	boolean
canSchedShifts	The indication whether shifts can be scheduled for this entity.	boolean
canStore	The indication whether this entity can be a "warehouse" or storage location.	boolean
canLogData	The indication whether this entity can log data.	boolean
canShip	The indication whether shipments can be made from this entity.	boolean
canReceive	The indication whether a material can be received at this entity.	boolean
canCopyFolders	The indication whether the files in the folders for this entity can be copied to its download directories.	boolean
canCaptureQMData	The indication whether this entity can capture QM data and have sample requests generated for it.	boolean
spare1	The contents of the spare1 field.	string
spare2	The contents of the spare2 field.	string
spare3	The contents of the spare3 field.	string
spare4	The contents of the spare4 field.	string
identicalJobExecs	The maximum number of jobs that can be run at the same time on this entity. For an entity on a line, this value will be either 0 or 1. If 0 is returned, it has the same meaning as 1; that is, only one job can be run at a time on the entity.	integer
last_edit_at	The date and time when the entity record was added or last modified.	string
exact_match	The indication whether the entities that can run jobs, can capture utilization, can track OEE, have only one job position, are not linked to any line (as parents or children), have a non-null default production rate, and match the filter criteria. Entities for which this property is true are eligible to be added to a line. So for this endpoint, this value will always be true.	boolean

See Also

MES Web API V1 Web Service