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

GetFolders Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The GetFolders method retrieves the folders for the specified item ID and operation ID.

Syntax

'Declaration
 
Public Shared Function GetFolders( _
   ByVal itemId As String, _
   ByVal operId As String _
) As DataSet
'Usage
 
Dim itemId As String
Dim operId As String
Dim value As DataSet
 
value = Job.GetFolders(itemId, operId)
public static DataSet GetFolders( 
   string itemId,
   string operId
)

Parameters

itemId
Required. The ID of the item.
operId
Required. The ID of the operation.

Return Value

Returns a DataSet that contains records for each folder that is related to the specified item ID and operation ID. The records contain columns from the Folder, Item, and Ent tables.

The columns of the returned DataSet are described below.

Column Name Description
item_id A string that is the item ID.
item_display

A string that is the display string for the item. The display string format is based on the value of the Item Display system attribute (attr_id = 210):

0 = item_id

1 = item_desc

2 = item_id(item_desc)

3 = item_desc(item_id)
oper_id A string that is the operation ID.
ent_id An integer that is the ID of the entity for which the folder is built.
ver_id A string that is the folder version.
ent_name A string that is the name of the entity for which the folder is built. From the Ent table.
item_desc A string that is the description of item. From the Item table.
oper_desc A string that is the description of the operation.
notes A string that is the notes about the folder.
udf1 A string that is the contents of the folder's user-defined field 1.
udf2 A string that is the contents of the folder's user-defined field 2.
preferred_ver A Boolean that is a flag that indicates whether the folder version in ver_id is the preferred version.
design_hold

A Boolean that is a flag that indicates whether this folder is on a design hold.

Note: This property is currently not used by the system.
last_edit_comment A string that contains comments about why the folder record was added or updated.
last_edit_by A string that is the ID of the user who added or last updated the folder record.
last_edit_at A datetime that indicates when the folder record was added or last updated.

mod_id

 The current modification ID of the record in the Folder table. This ID is binary number that increments each time the record’s table row is modified. Optionally used for optimistic concurrency control when performing updates or deletes.

See Also

Reference

Job Class
Job Members

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