Requisitions line items - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)

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

This API retrieves the requisition line items of a project from Smart Materials. You can either retrieve a single requisition line item details using requisition line item Id or all the requisition line items of the 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’)/RequisitionLineItems({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 requisition line item Id (RliId).

To retrieve all the requisition line items of a project, use the following URL:

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

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/RequisitionLineItems(10000704195)

To view requisition header details, expand Requisition property using Odata Query.

Success Response

Status: 200 OK

   {

  "@odata.context": "http://localhost:59387/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/RequisitionLineItems/$entity",

  "RliId": 10000704195,

  "ProjId": "RS",

  "DpId": 5020,

  "RId": 10000109268,

  "Position": 1,

  "SubPosition": 1,

  "ProcSequence": null,

  "MarkingForDeleteInd": "N",

  "KeepManInd": "N",

  "NotesInd": "N",

  "Ident": 10000504671,

  "TagNumber": "---",

  "CommodityId": 10000243189,

  "CommodityGroup": "P",

  "ItyId": 500018,

  "NewListQty": 0,

  "QuantityUnit": "EA",

  "ReleasedQty": 100,

  "IncreasedQty": 100,

  "RecommendQty": 0,

  "AssemblyQty": 0,

  "LastListQty": 0,

  "LastReleasedQty": 0,

  "CorporateWarehouseQty": 0,

  "FIMQty": 0,

  "POQuantity": 60,

  "TotalPOQty": 60,

  "NotApprovedPOQty": 0,

  "ReceivedQtyPosted": 42,

  "DirectReceivedQty": 30,

  "ROSDate": "2019-12-26T00:00:00+05:30",

  "ActivityCode": null,

  "ProcureChannel": null,

  "InqId": 10000028319,

  "InquiryCode": "KV_INQ_IC1",

  "InquirySequence": 1,

  "InquiryQty": 10,

  "TechEvalRequiredInd": "N",

  "AllowRTPInd": "Y",

  "ForceRTPInd": "N",

  "MSLinkInd": "Y",

  "AccountCode": null,

  "UnitWeight": 0,

  "TotalWeight": 0,

  "WeightUnit": "EA",

  "Budget": 0,

  "Currency": "€",

  "CurrencyId": 500391,

  "DdId": 10000001312,

  "Comment": null,

  "GroupedBy": null,

  "NonIdentCollapseCrit": null,

  "CumulatedWeight": 0,

  "CumulatedWeightUnit": null,

  "ApproverName": null,

  "RentalStartDate": null,

  "RentalEndDate": null,

  "ValidPeriod": null,

  "Interval": "Days"

}

Element

Description

Type

RliId

Unique ID of the requisition line item

Integer

ProjId

Unique ID of the project to which the retrieved requisition line item belongs

String

RId

Unique ID of the requisition to which these items belong

Integer

Position

Position or line item number of the requisition line item

Integer

SubPosition

Sub-Position or sub line item number of the requisition line item

Integer

CommodityId

Commodity code of the material of this line item

String

NewListQty

Refers to the real quantity calculated by the MTO, i.e. the summary of the quantity of all related BOM positions.

Decimal

ReceivedQtyPosted

Refers to the sum of all received quantities for the given requisition line item.

Decimal

DirectReceivedQty

Refers to the sum of the posted direct received quantities for the ident.

Decimal

FIMQty

Quantity currently available for the material on this line item in the FIM warehouses that the current user can access.

Decimal

QuantityUnit

The quantity unit for this engineering requisition line item.

String

NotesInd

Indicates whether the notes are assigned to the engineering requisition or not. Available values are Y and N.

String

CommodityGroup

Group in which the commodity code is defined

String

CorporateWarehouseQty

Quantity currently available for the material on this line item in the corporate warehouses accessible for the current user.

Decimal

IncreasedQty

Increased quantity for the material on this line item. The increased quantity is calculated by the following formula:

Total Release Quantity - Last Release Quantity.

Decimal

ApproverName

Name of the user who has approved this engineering requisition line item

String

ActivityCode

Name of the activity as maintained in screen J.30.01

String

InquirySequence

Order sequence of the requisition line item on the related inquiry

Integer

MSLinkInd

Indicates whether a link to a planned tagged item exists or not. Available values are Y and N.

String

CumulatedWeight

The cumulated weight for all the idents that made up this line item (non ident MTO).

Decimal

CumulatedWeightUnit

Weight unit of the cumulated weight

String

TotalWeight

The weight of this requisition position. It is calculated by the formula:

(Ident Unit Weight) * (Total Release Quantity).

Decimal

NonIdentCollapseCrit

The group value on which the collapsing was based for this requisition line item (used for non ident MTO only).

String

DpId

Unique ID of the discipline to which the retrieved requisition line item belongs

Integer

Currency

Name of the currency as defined in A.10.12 Units of Measure

String

CurrencyId

Unique ID of the currency

Integer

Budget

Budget value of this line item

Decimal

ReleasedQty

Total quantity that a user wants to order by procurement

Decimal

LastReleasedQty

Refers to the total quantity that the technical engineer
sent to procurement with the previous supplement of the
same engineering requisition.

Decimal

LastListQty

Refers to the real quantity, calculated by the MTO for the previous supplement.

Decimal

RecommendQty

Quantity recommended based on the disposition rules

Decimal

AssemblyQty

Quantity derived from the assemblies.
The total list quantity is the summary of the quantities of each BOM position
stored in the trace records and the quantities of exploded assemblies.
The assembly quantity is the summary of all these later quantities.

Decimal

InquiryQty

Quantity that is inquired by the user. It is determined by CIP m_pck_req_custom.get_inquiry_qty.

Decimal

POQuantity

Refers to the quantity of the item that the procurement has placed in the corresponding agreement.

Decimal

TotalPOQty

Sum of the agreement quantities for the ident in the requisition cycle

Decimal

NotApprovedPOQty

Sum of not approved agreement quantities for the ident in the requisition cycle

Decimal

UnitWeight

The weight of this requisition line item and is calculated by
the MTO (together with the weight unit)
if the related checkbox is checked before the MTO is started.

Decimal

TechEvalRequiredInd

Indicates whether the position must be evaluated technically by an engineer or not. Available values are Y and N.

String

AllowRTPInd

Indicates whether this position can be released to procurement or not. Available values are Y and N.

String

ForceRTPInd

Available values are Y and N.

  • If value Y is passed, then the line item can be released to procurement regardless of the quantity.

String

TagNumber

Tag number of a specific ident

String

GroupedBy

The group criterion on which the collapsing was based for this requisition line item (used for non ident MTO only).

String

MarkingForDeleteInd

Indicates whether the line item is marked for deletion or not. Available values are Y and N.

String

Ident

Ident code for the ident placed on this line item

Integer

WeightUnit

Unique ID of the unit representing weight and quantity

Integer

ItyId

Unique ID of the item type

Integer

InqId

Unique ID of the inquiry on which the requisition line item is placed

Integer

DdId

Unique ID of th delivery designation

Integer

ROSDate

Estimated date when the item is required on site

Date Time Offset

ProcureChannel

Used only if the material on this position is not processed by the own (standard) procurement department. Mainly provided for documentation.

String

AccountCode

Name of the account code defined in screen A.10.30.

String

ProcSequence

Order sequence number used for tracking of related
order line items throughout several requisition supplements,
if the project default setting ZR_PROCSEQ is activated.

Integer

RentalStartDate

Holds the start date of the rental order line item

Date Time Offset

RentalEndDate

Holds the end date of the rental order line item

Date Time Offset

Interval

Used for calculating the valid period for the unit price

String

ValidPeriod

Valid period for the price per quantity

Integer

InquiryCode

Unique name of the inquiry

String

KeepManInd

Indicates whether the line item has been marked for keep as manual requisition line item or not.
Available values are Y and N.

String

Comment

Any user defined comment related to the line item

String