Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

MES Stateless API

TABLE OF CONTENTS

GetEditData Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The GetEditData() method retrieves utilization data for the specified event history entry, and for the entries immediately before and after the specified entry.

Syntax

'Declaration
 
Public Shared Function GetEditData( _
   ByVal logId As Integer _
) As DataSet
'Usage
 
Dim logId As Integer
Dim value As DataSet
 
value = UtilLog.GetEditData(logId)
public static DataSet GetEditData( 
   int logId
)

Parameters

logId
Required. Holds the log ID for a Util_History record, which is the key field for that table.

Return Value

Returns a DataSet that contains the record for the specified log ID in the Util_History table, as well as the records immediately before and after the specified record. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name

Description

log_ID

An integer that uniquely identifies a record in the Util_History table.

event_time_utc

A datetime that indicates the start of the event, in UTC.

event_time_local

A datetime that indicates the start of the event, in the local time of the entity.

ent_id

The ID of the entity for which the event was recorded.

shift_id

An integer that identifies the shift during which the event occurred. A value of 0 will be returned if there is no shift associated with this record.

shift_start_utc

A datetime that indicates the start of the shift during which the event was recorded, in UTC. Will have a value of 1/1/1900 if there is no shift associated with the record.

shift_start_local

A datetime that indicates the start of the shift during which the event was recorded, in the local time of the entity. Will have a value of 1/1/1900 if there is no shift associated with the record.

state_code

An integer that is the code for the entity's utilization state.

color

An integer that specifies the background color that corresponds to the entity state.

reas_cd

An integer that identifies the entity reason (e.g., the reason for downtime) associated with the event.

reas_desc

The description of the reason associated with the event.

reas_pending

A flag that indicates whether the user should be prompted for an override reason (default = No).

raw_reas_cd

A string that specifies the underlying raw reason code.

duration

An integer that is the duration of the event, in seconds.

comments

Text that describes the event.

last_edit_at

A datetime that indicates when the record was created or last modified.

Remarks

It is possible that one or two records are returned instead of the usual three:

  • Two records will be returned if the Util_History record whose ID is passed by the method is either the very first one or the current one (which means it is currently the last one) for the entity.
  • One record will be returned if the Util_History record is the only one for the entity.

See Also

Reference

UtilLog Class
UtilLog Members

In This Topic
TitleResults for “How to create a CRG?”Also Available in