Clone Forecast - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

FahId

Unique ID of the newly created Forecast

Integer

ProjId

Unique ID of the Project

String

FahCode

Name of the Forecast and specifies what the Forecast does and is attached to a run number.

String

RunNumber

Unique number attached to a FahCode

Decimal

LstId

Unique ID of the list status

Decimal

FahType

Type of the Forecast header

String

Shortage

Specifies acceptable short quantities used in Bill of Materials allocation. Available values are:

• 2-Pass Optimized (Any)

• 2-Pass Optimized (1)

• 2-Pass Optimized (2)

• 2-Pass CIP

• 1-Pass Single (Any)

• Only Entire Drawings.

String

SplitType

Defines Forecast Run split type. Availablevalues are:

• None (default)

• Node Name

• Node Attribute

• Position Attribute.

String

AllPositionsInd

Available values are Y and N.

• If value Y is passed, positions which were not forecasted, are also traced.

String

SubstInd

Indicates when the substitution/ transformation must be done automatically by the Forecast Run.

Available values are Y, N, and A.

• Y: consider substitution/ transformation

• N: do not consider substitution /transformation

• A: consider substitution/ transformation automatically.

String

BestQuantityInd

Available values are Y and N.

• If value Y is passed, the best quantity of the list position is calculated using the best quantity logic.

String

UseOnlySiteStatusInd

Available values are Y and N.

• If value Y is passed, only those statuses which are marked as Use on Site are considered.

String

WeightInd

Available values are Y and N.

• If value Y is passed, weight information is calculated and appears in the Forecast Run result.

String

CostInd

Available values are Y and N.

• If value Y is passed, cost information is calculated and appears in the Forecast Run result.

String

HourInd

Available values are Y and N.

• If value Y is passed, hour information is calculated and appears in the Forecast Run result.

String

StatId

Unique ID of the issue status

Decimal

AttrId

Unique ID of the used attribute, when the split type is NA or PA

Decimal

StartDate

Item shipments whose Promised on Site date is greater than this given start date are retrieved.

Date Time Offset

EndDate

Item shipments whose Promised on Site date is smaller than this given end date are retrieved.

Date Time Offset

AllocateLevel

Defines the pre-receiving level of a material that a Forecast Run should check.
Available values are:

• Only Inventory: Material should be present in the inventory of the warehouse
  that is assigned to a Forecast Run.

• Shipped Items: Already shipped material i.e., field 'Actual Ship' must be filled in expediting.

• Approved Purchase Orders: Specifies approved purchase orders. In case of notices of commitment,
  approved change order is considered till then no
  approved purchase order is created.

• Approved Requisitions: Material of the latest approved PO requisition supplements are also considered.
  An unapproved supplement must not exist.
  The difference of Total Release Qty and Last Total Release Qty is used as quantity.

• All Requisitions: This works in the same way as Approved Requisitions (ER)
  except that the latest supplement is considered
  regardless of whether it has been approved or not.

String

DtpId

Unique ID of the delivery type

Decimal

Priority

Type of the priority specified for the assigned nodes in the work packages of the Forecast Run.

Available values are:

• INSTALL_PAY_ITEM (CIP)

• ISSUED FIRST

• NODE ATTRIBUTE

• WEIGHT (CIP)

• NULL.

String

WeightAttrId

Unique ID of the weight attribute. Weight attribute
determines the node attribute.
The calculated weight is assigned to the
node attribute.

Decimal

SortOrder

Allows you to calculate the weight of nodes assigned to a work package. Available values are:

• HeaviestFirst: Weight calculation is mandatory, and the attribute set order
  of the assigned work packages is descending.

• HeaviestLast: Weight calculation is mandatory, and the attribute set order
  of the assigned work packages is ascending.

• None: No weight calculation is required.

String

TagNoOption

Tag number option. Available values are:

• Ignore Tag Number

• Not Ignore Tag Number.

String

DdId

Unique ID of the delivery designation

Decimal

OnlyEndnodesInd

Available values are Y and N.

• If value Y is passed, only terminal BOM nodes are processed.

String

PositionsWithFullSiteQty

Available values are Y and N.

• If value Y is passed, the BOM positions which
  are completely reserved or issued are
  no longer considered by the Forecast Run.

String

IgnoreNullDateInd

Available values are Y and N.

• If value Y is passed and prediction on site is NULL, then the item shipment is ignored.

String

ExcludeMIRQtyInd

Indicates whether the issued quantities on unposted MIRs
by BOM are to be considered for the list positions
in Forecast Run or not.

Available values are Y and N.

• If value Y is passed, it will consider MIR by BOM issue quantities
  for the list positions over an unposted MIR by BOM
  in Forecast and Reservation Run.

String

JobStatus

Status of the job and job here is to run the Forecast header

String

JobStartDate

Start date of the Forecast job

Date Time Offset

JobEndDate

End date of the Forecast job

Date Time Offset

ParentFahId

Unique ID of the parent Forecast header

Integer

WhId

Unique ID of the warehouse

Decimal

WhCode

Name or code of the warehouse

String

BnlCode

Name or code of the bin location

String

OrderSeq

Sequence of the warehouses considered while forecasting

Decimal

WpId

Unique ID of the work package

Decimal

AttrSort

If the priority for a work package is attribute, AttrSort controls the sort order

String

PriorityType

Priority type specified for work package in the current Forecast Run.

Available values are:

• ATTRIBUTE

• INSTALL_PAY_ITEM (CIP)

• ISSUED FIRST

• WEIGHT (CIP)

• WORK PACKAGE.

String

AttrCode

Name or code of the attribute

String

ROSDate

Date and time when the work package is Required on Site

Date Time Offset

BOMPath

BOM path of the list node

String

CommodityCode

Name or code of the commodity

String

Size (1-5)

Value of input (1-5) of the geometric details

String

AttrValue

Value of the attribute

String

AutoAssignWhInd

Auto assign warehouse to the header. Available values are Y and N.

• If value Y is passed, then all the warehouses that
  are assigned to the login user get assigned to the
  given Forecast.

String

List Nodes

Collection of the list node names

Collection