API Reference

This is the reference documentation of Tekla EPM Open API. The API contains request and response namespaces.

resFabSuiteAPI Namespace

[Missing <summary> documentation for "N:resFabSuiteAPI"]

Classes
  Class Description
Public class fsCurrency
An element with a decimal value and a Currency attribute.
Public class fsCurrencyUnit
An element with a decimal value and Currency and PriceUnits attributes.
Public class fsDecimalWithUOM
An element with a decimal value and a fsUOM attribute, such as a length, width, etc.
Public class fsDimensionsWithMetric
An element with a text value and a fsMetric attribute, such as for dimensions.
Public class fsresAddressInfo
Public class fsresAvailableMaterial
A type of material available from a supplier
Public class fsresClose
Closes the connection to the database. Cannot be called through a remote connection.
Public class fsresCloseRemote
Closes a remote connection.
Public class fsresCNCData
Retrieves the CNC data for the specified parts. An XMLWarning element will be included in the response if no CNC file has been loaded for a requested piece mark.
Public class fsresCNCData_PieceMarkCNCData
The CNC data for a single part.
Public class fsresCommand
Public class fsresCompanyData
Public class fsresConnect
Establishes a connection to the Tekla EPM database. Cannot be called through a remote connection
Public class fsresConnectRemote
Establishes a remote connection.
Public class fsresContactInfo
Public class fsresCreateInventoryLocationSweep
Creates a location sweep for the given location.
Public class fsresCutListItemAvailable
Inventory stock available for a cutting detail.
Public class fsresCutPart
A Part in a cutting detail.
Public class fsresDeleteInspectionTestRecord
Deletes the given inspection test record.
Public class fsresExportJob
Exports a Production Control job to a KISS file.
Public class fsresExportJobStatus
Exports a Production Control job including status information.
Public class fsresExportProjectSchedule
Exports a project schedule.
Public class fsresFabSuiteXMLResponse
Public class fsresFileData
A file reference.
Public class fsresFilter
A filter type and value.
Public class fsresFilterFilterValue
The value that the field should be restricted to.
Public class fsresFilterFilterValueMax
If specified then this becomes a range filter with FilterValue being the bottom value of the range and FilterValueMax being the upper value.
Public class fsresFilters
A set of filters specifying the data that should be processed by the command. If more than one Filter element specify the same FilterType then an 'or' condition is applied. An 'and' condition is applied to different FilterType fields. Ex.
Public class fsresGetAssemblies
Retrieves the list of assemblies in a job.
Public class fsresGetAssemblies_Assembly
An assembly.
Public class fsresGetAssemblies_AssemblyInspectionTest
An assembly.
Public class fsresGetAssemblies_AssemblySequence
A sequence assignment for an assembly.
Public class fsresGetAssemblies_BillOfMaterials
A part in the bill of materials for an assembly.
Public class fsresGetAssemblies_BillOfMaterialsInspectionTest
A part in the bill of materials for an assembly.
Public class fsresGetAssembliesInspectionTest
The title of an inspection test referenced by one or more assemblies in the response.
Public class fsresGetBillOfMaterials
Retrieves the bill of materials.
Public class fsresGetBillOfMaterialsInspectionTest
The title of an inspection test referenced by one or more parts in the response.
Public class fsresGetCategories
Retrieves the list of categories in a job.
Public class fsresGetCategories_Category
An Category.
Public class fsresGetCategories_CategoryInspectionTest
An Category.
Public class fsresGetCategories_SubCategory
A Sub-Category.
Public class fsresGetCategories_SubCategoryInspectionTest
A Sub-Category.
Public class fsresGetCategoriesInspectionTest
The title of an inspection test referenced by one or more categories in the response.
Public class fsresGetCutList
Retrieves the details of a cut list.
Public class fsresGetCutList_CutListItem
A cutting detail on a cut list.
Public class fsresGetCutList_CutListItemPart
A Part in a cut list cutting detail.
Public class fsresGetCutList_PlannedInventoryItem
The details of the stock that is planned to be used on the cutting detail.
Public class fsresGetDocument
Retrieves a document from the document index.
Public class fsresGetDocument_Document
A document.
Public class fsresGetDrawings
Retrieves the list of drawings in a job.
Public class fsresGetDrawings_Drawing
A drawing.
Public class fsresGetDrawings_DrawingInspectionTest
A drawing.
Public class fsresGetDrawingsInspectionTest
The title of an inspection test referenced by one or more drawings in the response.
Public class fsresGetInspectionTestRecords
Retrieves the details of an inspection test record and it's test definition.
Public class fsresGetInspectionTestRecordsCondensed
Retrieves the condensed details of a set of inspection test records.
Public class fsresGetInspectionTestRecordsCondensed_IncludedField
A field in the condensed test record response.
Public class fsresGetInspectionTestRecordSummary
Retrieves the condensed details of a set of inspection test records.
Public class fsresGetInspectionTestRecordSummary_InspectionTest
Summary of an inspection test.
Public class fsresGetInspectionTests
Retrieves a list of inspection tests and their definitions.
Public class fsresGetInspectionTestSubjects
Retrieves the available subjects for the given inspection test.
Public class fsresGetInspectionTestSubjects_Employee
An available employee for the given inspection test.
Public class fsresGetInspectionTestSubjects_InspectionTestRecord
An inspection result for a subject.
Public class fsresGetInspectionTestSubjects_Load
An available load for the given inspection test.
Public class fsresGetInspectionTestSubjects_Part
An available part for the given inspection test.
Public class fsresGetInspectionTestTypes
Retrieves the available inspection test types and categories.
Public class fsresGetInventory
Retrieves all of the records from the current inventory and/or inventory history.
Public class fsresGetInventoryLocationSweeps
Retrieves the details of the given location sweep serial number.
Public class fsresGetInventorySummary
Retrieves summary information from inventory.
Public class fsresGetInventorySummary_Summary
An summary for a set of fields.
Public class fsresGetInventorySummary_SummaryField
A summary field.
Public class fsresGetInventoryTransactions
Retrieves the details of inventory transactions that have occured.
Public class fsresGetLoads
Retrieves the completed/remaining status and details by destination and load #.
Public class fsresGetLoads_Destination
A shipping destination.
Public class fsresGetLoads_Destination_Load
The material completed through a station.
Public class fsresGetLoads_Destination_Load_Additional
Additional material on a load.
Public class fsresGetLoads_Destination_Load_Material
Material on a load.
Public class fsresGetLoads_Destination_MaterialRemaining
Material remaining to be shipped to a destination.
Public class fsresGetLots
Retrieves the list of lots in a job.
Public class fsresGetLots_Lot
A lot.
Public class fsresGetNestData
Retrieves the data file for the given nest.
Public class fsresGetNestImage
Retrieves the image for the given nest.
Public class fsresGetNestImage_Remnant
An image of a remnant.
Public class fsresGetNestStatus
Retrieves information on inventory and requisition items in a nest.
Public class fsresGetPricingInformation
Retrieves the pricing information for either a job or the full system.
Public class fsresGetProductionControlJobInformation
Retrieves the full information of Production Control jobs.
Public class fsresGetProductionControlJobInformationTransactions
Retrieves the changes that have been made to Production Control job information.
Public class fsresGetProductionControlJobs
Retrieves the list of production control jobs.
Public class fsresGetProductionControlJobs_JobGroups
The job groups that currently exist in Tekla EPM.
Public class fsresGetProductionControlJobs_ProductionControlJob
A production control job.
Public class fsresGetProductionShippingStatus
Retrieves the production status for a job.
Public class fsresGetProductionShippingStatus_Item
A record in the production status.
Public class fsresGetProductionShippingStatus_Item_ShippingDestination
A shipping destination in the production status.
Public class fsresGetProductionShippingStatus_Item_ShippingDestinationReturnStatus
A shipping destination in the production status.
Public class fsresGetProductionShippingStatus_Item_ShippingDestinationShipStatus
A shipping destination in the production status.
Public class fsresGetProductionShippingStatus_ItemField
A record in the production status.
Public class fsresGetProductionShippingStatus_ItemProductionStatus
A record in the production status.
Public class fsresGetProductionShippingStatus_ItemTFSStatus
A record in the production status.
Public class fsresGetProductionShippingStatusProductionStation
The name of a production station referenced by one or more records in the production status.
Public class fsresGetProductionShippingStatusShippingDestination
The name of a shipping destination referenced by one or more records in the production status.
Public class fsresGetProductionShippingStatusSummaryField
The name of a summary field in the production status.
Public class fsresGetProjectSchedule
Retrieves the breakdown elements, tasks, and task links for a baseline plan - optionally at a snapshot.
Public class fsresGetProjectScheduleBaselinePlans
Retrieves the baseline plans for a project.
Public class fsresGetProjectScheduleSnapshots
Retrieves the snapshots for a baseline plan.
Public class fsresGetProjectStatus
Retrieves summary information about the job including: Assemblies Drawings Sequences Lots RFIs Change Orders Transmittals Cut Lists Material Status Production Status Shipping Status
Public class fsresGetProjectStatus_Assemblies
Public class fsresGetProjectStatus_Categories
Public class fsresGetProjectStatus_CutList
Public class fsresGetProjectStatus_CutLists
Public class fsresGetProjectStatus_Documents
Public class fsresGetProjectStatus_Drawings
Public class fsresGetProjectStatus_Lots
Public class fsresGetProjectStatus_MaterialStatus
Public class fsresGetProjectStatus_ProductionStatus_Station
Public class fsresGetProjectStatus_QuantityWeight
Public class fsresGetProjectStatus_Sequences
Public class fsresGetProjectStatus_ShipStatus_Destination
Public class fsresGetProjectStatus_SubCategories
Public class fsresGetPurchaseOrderInformation
Retrieves the full information of Purchase Orders.
Public class fsresGetPurchaseOrderInformationTransactions
Retrieves the changes that have been made to Purchase Order information.
Public class fsresGetReportTypes
Retrieves the list of report types and reports for the given report group.
Public class fsresGetReportTypes_DefaultOption
Public class fsresGetReportTypes_ReportType
Public class fsresGetReportTypes_ReportType_Report
Public class fsresGetRouteDetails
Retrieves the details of the given route.
Public class fsresGetRouteDetails_RouteStation
Public class fsresGetSequences
Retrieves the list of sequence in a job.
Public class fsresGetSequences_Sequence
A sequence.
Public class fsresGetSequences_SequenceInspectionTest
A sequence.
Public class fsresGetSequencesInspectionTest
The title of an inspection test referenced by one or more sequences in the response.
Public class fsresGetStations
Retrieves the completed/remaining status and details by station.
Public class fsresGetStations_Station
A tracking station.
Public class fsresGetStations_Station_MaterialCompleted
Material completed through a station.
Public class fsresGetStations_Station_MaterialRemaining
Material remaining to be completed through a station.
Public class fsresGetStations_Station_Remaining
The material remaining to be completed through a station.
Public class fsresGetSubCategories
Retrieves the list of sub-categories in a job.
Public class fsresGetSubCategoriesInspectionTest
The title of an inspection test referenced by one or more sub-categories in the response.
Public class fsresGetTFSDetails
Retrieves the details of the parts that have been taken from stock (cut).
Public class fsresGetTFSDetails_Material
A part that has been taken from stock (cut).
Public class fsresGetTimeTrackingSubjects
Retrieves the available time tracking selections for a job.
Public class fsresGetTimeTrackingSubjects_Employees_Employee
An employee available to be associated with the time tracking record.
Public class fsresGetTimeTrackingSubjects_Stations
The production workstations available to be associated with the time tracking record.
Public class fsresGetTimeTrackingSubjects_Stations_Station
A production workstations available to be associated with the time tracking record.
Public class fsresGetTimeTrackingSubjects_SubjectFields_SubjectField
An additional field that can be used to identify the subject of the work.
Public class fsresGetTimeTrackingSubjects_Tasks
The schedule tasks available to be associated with the time tracking record.
Public class fsresGetTimeTrackingSubjects_Tasks_Task
A schedule task available to be associated with the time tracking record.
Public class fsresInputDisplayUnits
Specify the unit-of-measure values to use for input and display purposes.
Public class fsresInspectionDocument
A document attached to an inspection test record.
Public class fsresInspectionDocumentAdd
Adds a document to the document index and associates it with the given inspection record.
Public class fsresInspectionTest
An inspection test definition.
Public class fsresInspectionTestField
A field in an inspection test.
Public class fsresInspectionTestFieldOption
An available drop-down option.
Public class fsresInspectionTestLocation
An inspection test location.
Public class fsresInspectionTestRecord
An inspection test record.
Public class fsresInspectionTestRecordCondensed
An inspection test record.
Public class fsresInspectionTestRecordCondensedField
An inspection test record.
Public class fsresInspectionTestRecordField
A field/value on an inspection test record.
Public class fsresInspectionTestSubject
The subject of an inspection test.
Public class fsresInspectionTestType
An inspection test type.
Public class fsresInspector
An inspector.
Public class fsresIntermediateCompanyCodes
Retrieves the valid company codes for intermediate shipping that the specified job contains.
Public class fsresInventoryAdd
Adds a new inventory record based off the information from another.
Public class fsresInventoryAuditSave
Associates a barcode serial # with an audit serial # and saves the barcode SN in Tekla EPM's inventory.
Public class fsresInventoryAuditScan
Retrieves the details of an audit serial #.
Public class fsresInventoryLocationSweep
An inventory location sweep.
Public class fsresInventoryLocationSweepComplete
Completes the given location sweep.
Public class fsresInventoryLocationSweepScan
Scans an inventory serial # as being in the given sweep location.
Public class fsresInventoryMove
Changes the location of a piece of inventory material.
Public class fsresInventoryOperation
A single change as part of the transaction.
Public class fsresInventoryRecord
Public class fsresInventoryTransaction
A single inventory transaction. May include multiple individual changes/operations.
Public class fsresLoad
Loads or Un-Loads a production assembly/part from a truck.
Public class fsresMakeReport
Renders, exports, and retrieves the given report.
Public class fsresMappingError
Report errors generated while saving a nest from a Cut List.
Public class fsresMaterialPrice
Pricing Data for material from a supplier
Public class fsresMaxTruck
Retrieves the largest truck/load # for a job.
Public class fsresMaxTruck_Field
The details of a field associated with a load entry (MaxTruck command).
Public class fsresMaxTruck_FieldValue
An available field value.
Public class fsresNestDataFile
A nest data file.
Public class fsresNestedInventory
Information on one inventory item from a nest included in GetNestStatus.
Public class fsresNestedRequisition
Information on one requisition item from a nest included in GetNestStatus.
Public class fsresNestError
Report errors generated while saving a nest from an external software.
Public class fsresNestStatus
Information on one nest included in GetNestStatus.
Public class fsresPing
Pings the connection.
Public class fsresPrepareReportData
Retrieves the largest truck/load # for a job.
Public class fsresProductionControlJobInformation
The full details of a production control job.
Public class fsresProductionControlJobInformationTransaction
A transaction affecting the production control job information.
Public class fsresProjectSchedule_ProjectScheduleBaselinePlan
A schedule baseline plan.
Public class fsresProjectSchedule_ProjectScheduleBreakdownElement
A schedule breakdown element.
Public class fsresProjectSchedule_ProjectScheduleSnapshot
A snapshot of a schedule baseline plan.
Public class fsresProjectSchedule_ProjectScheduleTask
A schedule task.
Public class fsresProjectSchedule_ProjectScheduleTaskLink
A dependency link between two schedule tasks.
Public class fsresPurchaseOrderInformation
The full details of a purchase order.
Public class fsresPurchaseOrderInformationTransaction
A transaction affecting the purchase order information.
Public class fsresReceive
Receives material based on the Barcode Checklist receiving report in Tekla EPM.
Public class fsresReceiveASN
Receives material based on a serial number from an ASN file that has been loaded into Tekla EPM.
Public class fsresReceiveChecklistScan
Retrieves the details of a checklist serial #.
Public class fsresReturn
Returns or Un-Returns material from an intermediate shipping location (galvanizer, subcontractor, etc).
Public class fsresSaveCNCFile
Saves a cnc file to the Tekla EPM database.
Public class fsresSavedRemnant
A remnant saved by this nest in the SaveNest command.
Public class fsresSaveInspectionTestRecord
Saves an inspection test record.
Public class fsresSaveNest
Saves the result of a nest performed in External Software to Tekla EPM.
Public class fsresSaveTimeTrackingRecord
Saves the result of a nest performed in External Software to Tekla EPM.
Public class fsresSetAssemblyAssociation
Sets the association between one or more instances of an accessory part with an instance of the assembly.
Public class fsresSetCutListItemNestID
Assigns an external Nest GUID to a Cut List that already exists in Tekla EPM
Public class fsresSetInstanceLocation
Sets the location of a part instance.
Public class fsresShip
Ships or Un-Ships a load.
Public class fsresShopFloorSave
Adds or Deletes the record of an assembly/part having completed a tracking station.
Public class fsresTFSCut
Processes a Take From Stock (Cut).
Public class fsresTFSCut_CutPart
A part that has been cut.
Public class fsresTFSCut_CutPartSerialNumber
A serial number of a part that has been cut.
Public class fsresTFSManual
Processes a Take From Stock (Cut).
Public class fsresUserPermission
A permissions that the user has (or has not) been granted.
Public class fsresUserPermissions
The permissions that the user has been granted.
Public class fsresUsers_User
A User/Employee that can be selected from for completing the material through the station.
Public class fsresValCutListItem
Validates that a cutting detail and inventory stock is valid.
Public class fsresValCutListItemDropJobReservePrompt
Expected drop for the parts on the cutting detail that match the cut list filter.
Public class fsresValInventory
Retrieves the details of an inventory serial #.
Public class fsresValJob
Validates that the specified production job exists.
Public class fsresValStation
Validates that the specified tracking station exists.
Public class fsresValTruck
Validates that a truck/load exists, optionally adds it if it does not exist.
Public class fsresValUser
Validates that a user exists.
Public class fsresVersion
Retrieves the version number of the API.
Enumerations
  Enumeration Description
Public enumeration fsDropJobReserveOption
Public enumeration fsGetProductionShippingStatus_SummaryField
Public enumeration fsPriceUnits
Indicates the price units. /LB - per pound /CWT - per 100 pounds /FT - per foot /CFT - per 100 feet /SQFT - per square foot /SQFT-SA - per square foot of surface area /KG - per kilogram /M - per meter /SQM - per square meter /SQM-SA - per square meter of surface area /ITEM - per item /100 - per 100 items /1000 - per 1000 items Example (50.75/CWT):
Public enumeration fsresCNCData_PieceMarkCNCDataFormat
Public enumeration fsresCompanyDataFirmType
Public enumeration fsresFilterMatchType
Public enumeration fsresGetCutList_CutListItemStatus
Public enumeration fsresGetInspectionTestRecordsCondensed_IncludedFieldType
Public enumeration fsresGetInventorySummary_SummaryFieldName
Public enumeration fsresGetInventorySummarySummaryField
Public enumeration fsresGetTimeTrackingSubjects_SubjectFields_SubjectFieldFieldName
Public enumeration fsresInputDisplayUnitsLengthUOM
Public enumeration fsresInputDisplayUnitsPriceUOM
Public enumeration fsresInputDisplayUnitsSizeUOM
Public enumeration fsresInputDisplayUnitsWeightUOM
Public enumeration fsresInspectionTestFieldFieldType
Public enumeration fsresInspectionTestTestPurpose
Public enumeration fsresInspectionTestTypeTestPurpose
Public enumeration fsresInventoryRecordType
Public enumeration fsresProductionControlJobInformationTransactionTransactionType
Public enumeration fsresProjectSchedule_ProjectScheduleBaselinePlanBreakdownField1
Public enumeration fsresProjectSchedule_ProjectScheduleBaselinePlanBreakdownField2
Public enumeration fsresProjectSchedule_ProjectScheduleBaselinePlanBreakdownField3
Public enumeration fsresProjectSchedule_ProjectScheduleBaselinePlanBreakdownField4
Public enumeration fsresProjectSchedule_ProjectScheduleBaselinePlanBreakdownField5
Public enumeration fsresProjectSchedule_ProjectScheduleBreakdownElementBreakdownField
Public enumeration fsresProjectSchedule_ProjectScheduleBreakdownElementLinkPosition
Public enumeration fsresProjectSchedule_ProjectScheduleTaskLinkLinkPosition
Public enumeration fsresProjectSchedule_ProjectScheduleTaskStatusAggregate
Public enumeration fsresProjectSchedule_ProjectScheduleTaskStatusLink
Public enumeration fsresProjectSchedule_ProjectScheduleTaskTaskType
Public enumeration fsresPurchaseOrderInformationTransactionTransactionType
Public enumeration fsresReportableChangesReportableChange
Public enumeration fsresTFSCutRTSType
Public enumeration fsresTFSManualRTSType
Public enumeration fsUOM
Indicates the units of the value. IN - Inches MM - Millimeters LB - Pounds KG - Kilograms Example (40'-2 1/2):