Read Forecast - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R1 (2.1)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R1 (2.1)

This API retrieves the Forecast details from Smart Materials. You can either retrieve a single Forecast using Forecast Id or all the Forecasts of a project.

Required Privilege: API_READONLY

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Forecasts({key})

Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the Forecast Id (FahId).

To retrieve all the Forecasts of a project, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Forecasts

Sample Code

GET https://in-smatapi.ingrnet.com/API21/Smat/v1/Projects('M06_1108')/Disciplines('PIPE')/Nls('ENGLISH')/Forecasts(65698)

Success Response

Status: 200 OK

Content:

{

"@odata.context":"https://in-smatapi.ingrnet.com/API21/SMAT/V1/$metadata#Projects('M06_1108')/Disciplines('PIPE')/Nls('ENGLISH')/Forecasts/$entity",

"FahId":65698,

"ProjId":"M06_1108",

"FahCode":"FAHCODE381",

"RunNumber":2,

"LstId":5046,

"Shortage":"2-Pass Optimized(Any)",

"SplitType":"PA",

"AllPositionsInd":"Y",

"SubstInd":"Y",

"BestQuantityInd":"Y",

"UseOnlySiteStatusInd":"Y",

"WeightInd":"Y",

"CostInd":"Y",

"HourInd":"Y",

"SplitResult":null,

"StatId":5626,

"AttrId":5571,

"StartDate":null,

"EndDate":null,

"AllocateLevel":"Shipped Items",

"DtpId":5701,

"Priority":"ISSUED FIRST",

"WeightAttrId":5130,

"SortOrder":"HeaviestFirst",

"TagNoOption":"Not Ignore Tag Number",

"DdId":null,

"OnlyEndnodesInd":"Y",

"PositionsWithFullSiteQty":"Y",

"IgnoreNullDateInd":"Y",

"ExcludeMIRQtyInd":"Y",

"JobStatus":"NEW",

"JobStartDate":null,

"JobEndDate":null,

"ParentFahId":null,

"ListNodes":[

],

"AutoAssignWhInd":"Y",

}

Element

Description

Type

FahId

Unique ID of the 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

Shortage

Specifies acceptable short quantities used in Bill of Materials allocation.
Allowed 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. Allowed values are:

  • None (default)

  • Node Name

  • Node Attribute

  • Position Attribute.

String

AllPositionsInd

Allowed 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.

Allowed values are Y, N, and A.

  • Y: consider substitution/ transformation

  • N: do not consider substitution /transformation

  • A: consider substitution/ transformation automatically.

String

BestQuantityInd

Allowed 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

Allowed values are Y and N.

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

String

WeightInd

Allowed values are Y and N.

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

String

CostInd

Allowed values are Y and N.

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

String

HourInd

Allowed values are Y and N.

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

String

SplitResult

Value of the split type

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 the given end date are retrieved.

Date Time Offset

AllocateLevel

Defines the pre-receiving level of a material that a Forecast Run should check. Allowed 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.

  • Purchase Order: 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.

Allowed 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. Allowed 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 Nmber

  • Not Ignore Tag Number.

String

DdId

Unique ID of the delivery designation

Decimal

OnlyEndnodesInd

Allowed values are Y and N.

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

String

PositionsWithFullSiteQty

Allowed 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

Allowed 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 the
Forecast Run.

Allowed 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 the 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

AutoAssignWhInd

Auto assign warehouse to the Forecast header.

Allowed 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

Forecast has multiple collections which are as follows:

Element

Description

Type

ListNodes

Collection of list node names

String

AssignedWarehouses

Collection of Forecast warehouses

Collection

AssignedWorkpacks

Collection of Forecast work packages

Collection

  • AssignedWarehouses Entity Type

    Element

    Description

    Type

    OrderSeq

    Sequence of the warehouses considered while forecasting.

    Decimal

    WhCode

    Name or code of the warehouse

    String

    WhId

    Unique ID of the warehouse

    Decimal

    BnlCode

    Name or code of the bin location

    String

  • AssignedWorkpacks Entity Type

    Element

    Description

    Type

    OrderSeq

    Sequence of the work packages considered while forecasting.

    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.

    Allowed values are:

    ATTRIBUTE

    INSTALL_PAY_ITEM (CIP)

    ISSUED FIRST

    WEIGHT (CIP)

    WORK PACKAGE.

    String

    ApiAttributes

    List of attributes attached to the Forecast Run.

    This attribute list is used to create where condition for list positions.

    Collection

    ApiCommodityCodes

    List of attached commodity codes.

    These commodity codes and sizes are used to create where condition for ident.

    Collection

    WpId

    Unique ID of the workpackage

    Integer

    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

  • Api Attrributes Entity type

    Element

    Description

    Type

    AttrCode

    Name or code of the attribute

    String

    AttrValue

    Value of the attribute

    String

    WpId

    Unique ID of the workpackage

    Integer

  • ApiCommodityCodes Entity Type

    Element

    Description

    Type

    CommodityCode

    Name or code of the commodity

    String

    Size (1-5)

    Value of inputs of the geometric details

    SHARED Tip Five values are allowed

    String