FabSuiteRequestApi Namespace

A boolean element with an optional boolean attribute SharedOnly, such as IncludeCutList with attribute SharedOnly.

An element with a decimal value and a Currency attribute.

An element with a decimal value and a fsUOM attribute, such as a length, width, etc.

An element with a text value and a fsMetric attribute, such as for dimensions.

The TFSCut command has elements for a single piece of drop from the cut. This element represents additional drops from the same cut.

Closes the connection to the database. Cannot be called through a remote connection.

Closes a remote connection.

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.

Establishes a connection to the FabSuite database. Cannot be called through a remote connection

Establishes a remote connection.

Deletes Tekla PowerFab specified CostCode

Retrieves one or more cost codes for Purchasing.

Inserts or updates into Tekla PowerFab CostCode

Creates a location sweep for the given location.

A CutListItem for the SetCutListItemNestID command

Deletes the given inspection test record.

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.

If LastLogID is specified then the result will only include the records that have changed since that log position.

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.

Exports a Production Control job to a KISS file.

Exports a Production Control job including status information. Either ProductionControlID or JobNumber must be specified.

Exports a project schedule

Execute a Tekla EPM Extension

A file contents element with extension of file

A filter type and value.

The value that the field should be restricted to.

If specified then this becomes a range filter with FilterValue being the bottom value of the range and FilterValueMax being the upper value.

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.

Retrieves the list of assemblies in a job. Either ProductionControlID or JobNumber must be specified.

Retrieves the bill of materials. Either ProductionControlID or JobNumber must be specified.

Retrieves the list of categories in a job. Either ProductionControlID or JobNumber must be specified.

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

Retrieves the list of countries in a database. No parameters.

Retrieves the details of a cut list.

Retrieves a document from the document index.

Retrieves the list of drawings in a job. Either ProductionControlID or JobNumber must be specified.

Retrieves the selections from a selection filter

One Field in a filter.

One Field in a filter.

Retrieves the fields and types for a filter.

Retrieves the details of an inspection test record and it's test definition.

Retrieves the condensed details of a set of inspection test records.

Retrieves the summary of a set of inspection test records. Either ProductionControlID or JobNumber must be specified.

Retrieves a list of inspection tests and their definitions.

Retrieves the available subjects for the given inspection test.

Retrieves the available inspection test types and categories.

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.

Retrieves the list of locations in use in Inventory. No parameters.

Retrieves the details of the given location sweep serial number.

Retrieves summary information from inventory.

Retrieves the details of inventory transactions that have occured.

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

Retrieves the list of lots in a job. Either ProductionControlID or JobNumber must be specified.

Retrieves the list of model object IDs / IFC Guids in a job Either ProductionControlID or JobNumber must be specified.

Retrieves the data file for the given nest.

Retrieves the image for the given nest. Either ProductionControlCutListItemID or ProductionControlCutListBarcodeID must be specified.

Retrieves the inventory and requisition item status for this nest.

Retrieves pricing information for the whole system or one job.

Retrieves the full information of Production Control jobs.

Retrieves the changes that have been made to Production Control job information.

Retrieves a concise list of Production Control jobs.

Retrieves the production status for a job. Either ProductionControlID or JobNumber must be specified.

Retrieves the breakdown elements, tasks, and task links for a baseline plan - optionally at a snapshot.

Retrieves the baseline plans for a project. One of ProjectID, ProductionControlID, or JobNumber must be specified.

Retrieves the snapshots for a baseline plan.

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.

Retrieves the full information of Purchase Orders.

Retrieves the changes that have been made to Purchase Order information.

Retrieves the list of report types and reports for the given report group.

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

Retrieves the details of the given route. Either RouteID or Route must be specified.

Retrieves the list of sequences in a job. Either ProductionControlID or JobNumber must be specified.

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

Retrieves the list of sub-categories in a job. Either ProductionControlID or JobNumber must be specified.

Retrieves the details of the PDC material that has been taken from stock including tracibility information. Either ProductionControlID or JobNumber must be specified.

Retrieves the available time tracking selections for a job. Either ProductionControlID or JobNumber must be specified.

Retrieves the details of one or more transmittals. If neither TransmittalID nor TransmittalNumber are specified, the transmittals received will be limited by the filters

Specify the unit-of-measure values to use for input and display purposes.

Adds a document to the document index and associates it with the given inspection record.

The subject of an inspection test.

Retrieves the valid company codes for intermediate shipping that the specified job contains.

Adds a new inventory record based off the information from another.

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.

Retrieves the details of an audit serial #.

Gets the list of inventory location restrictions. If LastLogID is specified then the result will only include the records that have changed since that log position.

Completes the given location sweep.

Scans an inventory serial # as being in the given sweep location.

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, MillOfOrigin, 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.

A single external remnant to be saved by InventoryRemnant_Upsert command.

Inserts or updates an external remnant into Tekla EPM INventory

Deletees a Labor Rate from Tekla PowerFab.

retrieves a Labor Rate from Tekla PowerFab.

Inserts or updates a Labor Rate in Tekla PowerFab.

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.

Renders, exports, and retrieves the given report. Either ReportID or ReportGUID is required.

A piece of material to be reserved in inventory or ordered for this nest.

Retrieves the largest truck/load # for a job. Either ProductionControlID or JobNumber must be specified.

A single part that is nested on to material in this nest on SaveNest command

A single nest to be saved by SaveNest command.

The set of barcode serial numbers being applied to a part from a TFSCut command.

Retrieve the required stock for a cut list

Pings the connection.

Processes report data in preparation for a subsequent MakeReport call to render the report.

Exports DSTV Plus zip file for a cut list or cut list items

Swap an inventory item associated with a cut list for another inventory item.

Given a Production Control Cut List Item ID, return a list of inventory items that can be swapped with the one on the cut list.

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.

Receives material based on a serial number from an ASN file that has been loaded into FabSuite.

Retrieves the details of a checklist serial #.

A remnant created by this nest in the SaveNest command.

A report processing option

Returns or Un-Returns material from an intermediate shipping location (galvanizer, subcontractor, etc). Either ProductionControlID or JobNumber must be specified.

Saves a cnc file to the FabSuite database. CNCFormat and either CNCFileName or CNCData are required.

Saves an inspection test record.

An inspection test record document.

An inspection test record field value.

Saves the result of a nest performed in External Software to FabSuite.

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.

One of the fields identifying the subject of the time tracking record.

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.

At least one CutListItem must be defined

Sets the location of a part instance. Either ProductionControlID or JobNumber must be specified. Either InstanceNumbers or (SerialNumber and Quantity) must be specified.

Ships or Un-Ships a load. Either ProductionControlID or JobNumber must be specified.

Adds or Deletes the record of an assembly/part having completed a tracking station. Either ProductionControlID or JobNumber must be specified.

Processes a Take From Stock (Cut). Either CutListItemID or CutListSerialNumber must be specified. Either InventorySerialNumber or (PONumber AND HeatNumber) must be specified.

Processes a manual Take From Stock on a piece of inventory stock.

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.

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.

Retrieves the details of an inventory serial #.

Validates that the specified production job exists.

Validates that the specified tracking station exists.

Validates that a truck/load exists, optionally adds it if it does not exist. Either ProductionControlID or JobNumber must be specified.

Validates that a user exists.

Retrieves the version number of the API.

A string element with an optional integer ID.

Indicates the units of the value. IN - Inches MM - Millimeters LB - Pounds KG - Kilograms Example (40'-2 1/2):