API Reference

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

FabSuiteRequestApi Namespace

Classes for receiving an API response from Tekla EPM.
Classes
  Class Description
Public class fsBoolWithBool
A boolean element with an optional boolean attribute SharedOnly, such as IncludeCutList with attribute SharedOnly.
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 fsreqAdditionalDrop
The TFSCut command has elements for a single piece of drop from the cut. This element represents additional drops from the same cut.
Public class fsreqClose
Closes the connection to the database. Cannot be called through a remote connection.
Public class fsreqCloseRemote
Closes a remote connection.
Public class fsreqCNCData
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 fsreqCommand
Public class fsreqConnect
Establishes a connection to the FabSuite database. Cannot be called through a remote connection
Public class fsreqConnectRemote
Establishes a remote connection.
Public class fsreqCreateInventoryLocationSweep
Creates a location sweep for the given location.
Public class fsreqCutListItem
A CutListItem for the SetCutListItemNestID command
Public class fsreqDeleteInspectionTestRecord
Deletes the given inspection test record.
Public class fsreqDrawingDelete
Public class fsreqDrawingFileGet
Public class fsreqDrawingGet
ProjectID, ProductionControlID, or DrawingID must be specified. If LastLogID is specified then the result will only include the records that have changed since that log position.
Public class fsreqDrawingGetOptions
Public class fsreqDrawingInputOptionsGet
Public class fsreqDrawingInsert
Public class fsreqDrawingLog
Public class fsreqDrawingLogDelete
Public class fsreqDrawingLogGet
If LastLogID is specified then the result will only include the records that have changed since that log position.
Public class fsreqDrawingLogInsert
Public class fsreqDrawingLogUpdate
Public class fsreqDrawingRevisionDelete
Public class fsreqDrawingRevisionGet
ProjectID, ProductionControlID, DrawingID, or DrawingRevisionID must be specified. If LastLogID is specified then the result will only include the records that have changed since that log position.
Public class fsreqDrawingRevisionInsert
Public class fsreqDrawingRevisionUpdate
Public class fsreqDrawingUpdate
Public class fsreqExportJob
Exports a Production Control job to a KISS file.
Public class fsreqExportJobStatus
Exports a Production Control job including status information. Either ProductionControlID or JobNumber must be specified.
Public class fsreqExportProjectSchedule
Exports a project schedule
Public class fsreqFabSuiteXMLRequest
Public class fsreqFilter
A filter type and value.
Public class fsreqFilterFilterValue
The value that the field should be restricted to.
Public class fsreqFilterFilterValueMax
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 fsreqFilters
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 fsreqFilterSelectionsPRJGet
Public class fsreqFilterSetDetailsGet
Public class fsreqFilterSetSelections_Filter
Public class fsreqFilterSetSelections_FilterItem
Public class fsreqGetAssemblies
Retrieves the list of assemblies in a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetBillOfMaterials
Retrieves the bill of materials. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetCategories
Retrieves the list of categories in a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetChangeOrderDetails
Retrieves the details of one or more Change Order. If neither ChangeOrderID nor ChangeOrderNumber are specified, the change orders received will be limited by the filters
Public class fsreqGetCountries
Retrieves the list of countries in a database. No parameters.
Public class fsreqGetCutList
Retrieves the details of a cut list.
Public class fsreqGetDocument
Retrieves a document from the document index.
Public class fsreqGetDrawings
Retrieves the list of drawings in a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetFilterSelections
Retrieves the selections from a selection filter
Public class fsreqGetFilterSelections_Filter
One Field in a filter.
Public class fsreqGetFilterSelections_FilterItemsFilterItem
One Field in a filter.
Public class fsreqGetFilterSetDetails
Retrieves the fields and types for a filter.
Public class fsreqGetInspectionTestRecords
Retrieves the details of an inspection test record and it's test definition.
Public class fsreqGetInspectionTestRecordsCondensed
Retrieves the condensed details of a set of inspection test records.
Public class fsreqGetInspectionTestRecordSummary
Retrieves the summary of a set of inspection test records. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetInspectionTests
Retrieves a list of inspection tests and their definitions.
Public class fsreqGetInspectionTestSubjects
Retrieves the available subjects for the given inspection test.
Public class fsreqGetInspectionTestTypes
Retrieves the available inspection test types and categories.
Public class fsreqGetInventory
Retrieves all of the records from the current inventory and/or inventory history. Use IncludeInventory and IncludeHistory to specify that inventory and/or inventory history records should be retrieved. If neither the IncludeInventory or IncludeHistory elements are included then the command will retrieve inventory records only.
Public class fsreqGetInventoryLocations
Retrieves the list of locations in use in Inventory. No parameters.
Public class fsreqGetInventoryLocationSweeps
Retrieves the details of the given location sweep serial number.
Public class fsreqGetInventorySummary
Retrieves summary information from inventory.
Public class fsreqGetInventoryTransactions
Retrieves the details of inventory transactions that have occured.
Public class fsreqGetLoads
Retrieves the completed/remaining status and details by destination and load #. Either ProductionControlID or JobNumber must be specified. This command can be used a few different ways: 1. Retrieve the list of destinations. IncludeLoads = false, IncludeUnshippedLoads = false, IncludeCompletedMaterial = false, IncludeRemainingMaterial = false 2. Retrieve the list of loads. Include[Unshipped]Loads = true, IncludeCompletedMaterial = false, IncludeRemainingMaterial = false 3. Retrieve the details of the material on each load. Include[Unshipped]Loads = true, IncludeCompletedMaterial = true, IncludeRemainingMaterial = false 4. Retrieve the details of the material remaining to be loaded. IncludeLoads = false, IncludeUnshippedLoads = false, IncludeCompletedMaterial = false, IncludeRemainingMaterial = true
Public class fsreqGetLots
Retrieves the list of lots in a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetNestData
Retrieves the data file for the given nest.
Public class fsreqGetNestImage
Retrieves the image for the given nest. Either ProductionControlCutListItemID or ProductionControlCutListBarcodeID must be specified.
Public class fsreqGetNestStatus
Retrieves the inventory and requisition item status for this nest.
Public class fsreqGetPricingInformation
Retrieves pricing information for the whole system or one job.
Public class fsreqGetProductionControlJobInformation
Retrieves the full information of Production Control jobs.
Public class fsreqGetProductionControlJobInformationTransactions
Retrieves the changes that have been made to Production Control job information.
Public class fsreqGetProductionControlJobs
Retrieves a concise list of Production Control jobs.
Public class fsreqGetProductionShippingStatus
Retrieves the production status for a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetProjectSchedule
Retrieves the breakdown elements, tasks, and task links for a baseline plan - optionally at a snapshot.
Public class fsreqGetProjectScheduleBaselinePlans
Retrieves the baseline plans for a project. One of ProjectID, ProductionControlID, or JobNumber must be specified.
Public class fsreqGetProjectScheduleSnapshots
Retrieves the snapshots for a baseline plan.
Public class fsreqGetProjectStatus
Retrieves summary information about the job including: Assemblies Drawings Sequences Lots Categories Sub-Categories RFIs Change Orders Transmittals Cut Lists Material Status Production Status Shipping Status Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetPurchaseOrderInformation
Retrieves the full information of Purchase Orders.
Public class fsreqGetPurchaseOrderInformationTransactions
Retrieves the changes that have been made to Purchase Order information.
Public class fsreqGetReportTypes
Retrieves the list of report types and reports for the given report group.
Public class fsreqGetRFIDetails
Retrieves the details of one or more requests for information. If neither RequestForInformationID nor RFINumber are specified, the RFIs received will be limited by the filters
Public class fsreqGetRouteDetails
Retrieves the details of the given route.
Public class fsreqGetSequences
Retrieves the list of sequences in a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetStations
Retrieves the completed/remaining status and details by station. Either ProductionControlID or JobNumber must be specified. This command can be used a few different ways: 1. Retrieve the list of stations. IncludeCompleted = false, IncludeRemaining = false 3. Retrieve the details of the completed material for each station. IncludeCompleted = true, IncludeRemaining = false 4. Retrieve the details of the remaining material for each station. IncludeCompleted = false, IncludeRemaining = true
Public class fsreqGetSubCategories
Retrieves the list of sub-categories in a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetTFSDetails
Retrieves the details of the PDC material that has been taken from stock including tracibility information. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetTimeTrackingSubjects
Retrieves the available time tracking selections for a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqGetTransmittalDetails
Retrieves the details of one or more transmittals. If neither TransmittalID nor TransmittalNumber are specified, the transmittals received will be limited by the filters
Public class fsreqInputDisplayUnits
Specify the unit-of-measure values to use for input and display purposes.
Public class fsreqInspectionDocumentAdd
Adds a document to the document index and associates it with the given inspection record.
Public class fsreqInspectionTestSubject
The subject of an inspection test.
Public class fsreqIntermediateCompanyCodes
Retrieves the valid company codes for intermediate shipping that the specified job contains.
Public class fsreqInventoryAdd
Adds a new inventory record based off the information from another.
Public class fsreqInventoryAuditSave
Associates a barcode serial # with an audit serial # and saves the barcode SN in FabSuite's inventory. If the SerialNumber does not yet exist in FabSuite's inventory then it will be associated with an inventory record that has information matching the AuditSerialNumber. If the SerialNumber is already in FabSuite's inventory then it will be moved to the location and secondary location defined by the AuditSerialNumber as long as it matches the rest of the details.
Public class fsreqInventoryAuditScan
Retrieves the details of an audit serial #.
Public class fsreqInventoryLocationSweepComplete
Completes the given location sweep.
Public class fsreqInventoryLocationSweepScan
Scans an inventory serial # as being in the given sweep location.
Public class fsreqInventoryMove
Changes the location of a piece of inventory material. Either SerialNumber or (Quantity AND Shape) are required. If SerialNumber is specified then Quantity, Shape, Grade, Dimensions, Length, Job, Supplier, CountryOfOrigin, PONumber, BillOfLadingNumber, HeatNumber, HeatSerialNumber, Location, SecondaryLocation, Remarks, ReferenceNumber, and PartNumber, are ignored. If SerialNumber is not specified then the material to move is identified by the combination of those fields that are specified.
Public class fsreqLoad
Loads or Un-Loads a production assembly/part from a truck. Either ProductionControlID or JobNumber must be specified. When loading either MainMark or Description must be specified. When un-loading either MainMark or ProductionControlTrucksAdditionalID must be specified.
Public class fsreqMakeReport
Renders, exports, and retrieves the given report. Either ReportID or ReportGUID is required.
Public class fsreqMaterialUsed
A piece of material to be reserved in inventory or ordered for this nest.
Public class fsreqMaxTruck
Retrieves the largest truck/load # for a job. Either ProductionControlID or JobNumber must be specified.
Public class fsreqNestPart
A single part that is nested on to material in this nest on SaveNest command
Public class fsreqNestResult
A single nest to be saved by SaveNest command.
Public class fsreqPartSerialNumber
The set of barcode serial numbers being applied to a part from a TFSCut command.
Public class fsreqPing
Pings the connection.
Public class fsreqPrepareReportData
Processes report data in preparation for a subsequent MakeReport call to render the report.
Public class fsreqProjectGet
Public class fsreqReceive
Receives material based on the Barcode Checklist receiving report in FabSuite. Either ChecklistSerialNumber or Shape is required. If ChecklistSerialNumber is specified then SerialNumber is required and PONumber, Shape, Grade, Dimensions, Length, Job, Supplier, Remarks, ReferenceNumber, and Part # are ignored. If SerialNumber is not specified then the material to receive is identified by the combination of those fields that are specified.
Public class fsreqReceiveASN
Receives material based on a serial number from an ASN file that has been loaded into FabSuite.
Public class fsreqReceiveChecklistScan
Retrieves the details of a checklist serial #.
Public class fsreqRemnant
A remnant created by this nest in the SaveNest command.
Public class fsreqReportOption
A report processing option
Public class fsreqReturn
Returns or Un-Returns material from an intermediate shipping location (galvanizer, subcontractor, etc). Either ProductionControlID or JobNumber must be specified.
Public class fsreqSaveCNCFile
Saves a cnc file to the FabSuite database. CNCFormat and either CNCFileName or CNCData are required.
Public class fsreqSaveInspectionTestRecord
Saves an inspection test record.
Public class fsreqSaveInspectionTestRecord_TestRecordDocument
An inspection test record document.
Public class fsreqSaveInspectionTestRecord_TestRecordField
An inspection test record field value.
Public class fsreqSaveNest
Saves the result of a nest performed in External Software to FabSuite.
Public class fsreqSaveTimeTrackingRecord
Adds a time tracking record. Either ProductionControlID or JobNumber must be specified. Either StartDate or StartDateTime must be specified. If StartDateTime is specified then EndDateTime must also be included.
Public class fsreqSaveTimeTrackingRecord_SubjectFields_SubjectField
One of the fields identifying the subject of the time tracking record.
Public class fsreqSetAssemblyAssociation
Sets the association between one or more instances of an accessory part with an instance of the assembly. Either ProductionControlID or JobNumber must be specified. Either AssemblyInstanceNumber or AssemblySerialNumber must be specified. Either AccessoryInstanceNumbers or (AccessorySerialNumber and AccessoryQuantity) must be specified.
Public class fsreqSetCutListItemNestID
At least one CutListItem must be defined
Public class fsreqSetInstanceLocation
Sets the location of a part instance. Either ProductionControlID or JobNumber must be specified. Either InstanceNumbers or (SerialNumber and Quantity) must be specified.
Public class fsreqShip
Ships or Un-Ships a load. Either ProductionControlID or JobNumber must be specified.
Public class fsreqShopFloorSave
Adds or Deletes the record of an assembly/part having completed a tracking station. Either ProductionControlID or JobNumber must be specified.
Public class fsreqTFSCut
Processes a Take From Stock (Cut). Either CutListItemID or CutListSerialNumber must be specified. Either InventorySerialNumber or (PONumber AND HeatNumber) must be specified.
Public class fsreqTFSManual
Processes a manual Take From Stock on a piece of inventory stock.
Public class fsreqTransmittalGet
ProjectID, ProductionControlID, or TransmittalID must be specified. If LastLogID is specified then the result will only include the records that have changed since that log position.
Public class fsreqTransmittalGetOptions
Public class fsreqValCutListItem
Validates that a cutting detail and inventory stock is valid. Either CutListItemID or CutListSerialNumber must be specified. Either InventorySerialNumber or (PONumber AND HeatNumber) must be specified.
Public class fsreqValInventory
Retrieves the details of an inventory serial #.
Public class fsreqValJob
Validates that the specified production job exists.
Public class fsreqValStation
Validates that the specified tracking station exists.
Public class fsreqValTruck
Validates that a truck/load exists, optionally adds it if it does not exist. Either ProductionControlID or JobNumber must be specified.
Public class fsreqValUser
Validates that a user exists.
Public class fsreqVersion
Retrieves the version number of the API.
Enumerations