Nls - Intergraph Smart Materials - Version 2017 (2.0) - Help - Hexagon PPM

Intergraph Smart Materials Web API Help 2017 (2.0)

PPMProduct
Intergraph Smart Materials
PPMCategory_custom
Help

Name and Description

Nls - All Nls in a discipline are returned

URL Format

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls

Specify values for ProjId and DisciplineCode parameter in the URL.

Use the following read-only APIs to get the available values for each parameter.

/Projects,

/projects(':project')/Disciplines

URL Parameter

:project, :discipline

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="DataLanguage">

<Key>

<PropertyRef Name="Description"/>

</Key>

<Property Name="NlsId" Type="Edm.String"/>

<Property Name="Description" Type="Edm.String" Nullable="false"/>

<NavigationProperty Name="ForecastHeaders" Type="Collection(Com.Ingr.Smat.Core.V1.Forecast)" ContainsTarget="true"/>

<NavigationProperty Name="ReceivingHeaders" Type="Collection(Com.Ingr.Smat.Core.V1.ReceivingHeader)" ContainsTarget="true"/>

<NavigationProperty Name="IssuingHeaders" Type="Collection(Com.Ingr.Smat.Core.V1.IssuingHeader)" ContainsTarget="true"/>

<NavigationProperty Name="TransferHeaders" Type="Collection(Com.Ingr.Smat.Core.V1.MaterialTransferHeader)" ContainsTarget="true"/>

<NavigationProperty Name="AttrValues" Type="Collection(Com.Ingr.Smat.Core.V1.AttributeValue)" ContainsTarget="true"/>

<NavigationProperty Name="Attrs" Type="Collection(Com.Ingr.Smat.Core.V1.Attribute)" ContainsTarget="true"/>

<NavigationProperty Name="BinLocWarehouses" Type="Collection(Com.Ingr.Smat.Core.V1.BinLocWarehouse)" ContainsTarget="true"/>

<NavigationProperty Name="BinLocations" Type="Collection(Com.Ingr.Smat.Core.V1.BinLocation)" ContainsTarget="true"/>

<NavigationProperty Name="CommodityCodes" Type="Collection(Com.Ingr.Smat.Core.V1.CommodityCodeDetail)" ContainsTarget="true"/>

<NavigationProperty Name="Companies" Type="Collection(Com.Ingr.Smat.Core.V1.Company)" ContainsTarget="true"/>

<NavigationProperty Name="DelvDesigs" Type="Collection(Com.Ingr.Smat.Core.V1.DelvDesignation)" ContainsTarget="true"/>

<NavigationProperty Name="DelvTypes" Type="Collection(Com.Ingr.Smat.Core.V1.DelvType)" ContainsTarget="true"/>

<NavigationProperty Name="FaHeaders" Type="Collection(Com.Ingr.Smat.Core.V1.FaHeader)" ContainsTarget="true"/>

<NavigationProperty Name="Heats" Type="Collection(Com.Ingr.Smat.Core.V1.Heat)" ContainsTarget="true"/>

<NavigationProperty Name="Idents" Type="Collection(Com.Ingr.Smat.Core.V1.IdentDetail)" ContainsTarget="true"/>

<NavigationProperty Name="InvReceipts" Type="Collection(Com.Ingr.Smat.Core.V1.InvReceipt)" ContainsTarget="true"/>

<NavigationProperty Name="InvIssues" Type="Collection(Com.Ingr.Smat.Core.V1.InvIssue)" ContainsTarget="true"/>

<NavigationProperty Name="InvItems" Type="Collection(Com.Ingr.Smat.Core.V1.InvItem)" ContainsTarget="true"/>

<NavigationProperty Name="InvPosReservations" Type="Collection(Com.Ingr.Smat.Core.V1.InvPosReservation)" ContainsTarget="true"/>

<NavigationProperty Name="InvTransfers" Type="Collection(Com.Ingr.Smat.Core.V1.InvTransfer)" ContainsTarget="true"/>

<NavigationProperty Name="ItemShipments" Type="Collection(Com.Ingr.Smat.Core.V1.ItemShipment)" ContainsTarget="true"/>

<NavigationProperty Name="ItemTypes" Type="Collection(Com.Ingr.Smat.Core.V1.ItemType)" ContainsTarget="true"/>

<NavigationProperty Name="Languages" Type="Collection(Com.Ingr.Smat.Core.V1.Language)" ContainsTarget="true"/>

<NavigationProperty Name="Listnodes" Type="Collection(Com.Ingr.Smat.Core.V1.ListNode)" ContainsTarget="true"/>

<NavigationProperty Name="ListPositions" Type="Collection(Com.Ingr.Smat.Core.V1.ListPosition)" ContainsTarget="true"/>

<NavigationProperty Name="Liststatus" Type="Collection(Com.Ingr.Smat.Core.V1.ListStatus)" ContainsTarget="true"/>

<NavigationProperty Name="Locations" Type="Collection(Com.Ingr.Smat.Core.V1.Location)" ContainsTarget="true"/>

<NavigationProperty Name="MaterialIssueRpts" Type="Collection(Com.Ingr.Smat.Core.V1.MatlIssueRpt)" ContainsTarget="true"/>

<NavigationProperty Name="MaterialRecvRpts" Type="Collection(Com.Ingr.Smat.Core.V1.MatlRecvRpt)" ContainsTarget="true"/>

<NavigationProperty Name="MaterialTransferRpts" Type="Collection(Com.Ingr.Smat.Core.V1.MatlTransferRpt)" ContainsTarget="true"/>

<NavigationProperty Name="OrderLineItems" Type="Collection(Com.Ingr.Smat.Core.V1.OrderLineItem)" ContainsTarget="true"/>

<NavigationProperty Name="Plates" Type="Collection(Com.Ingr.Smat.Core.V1.Plate)" ContainsTarget="true"/>

<NavigationProperty Name="PoHeaders" Type="Collection(Com.Ingr.Smat.Core.V1.PoHeader)" ContainsTarget="true"/>

<NavigationProperty Name="ShipmentGroups" Type="Collection(Com.Ingr.Smat.Core.V1.ShipmentGroup)" ContainsTarget="true"/>

<NavigationProperty Name="SiteAttrSets" Type="Collection(Com.Ingr.Smat.Core.V1.SiteAttrSet)" ContainsTarget="true"/>

<NavigationProperty Name="SiteMaterialStatus" Type="Collection(Com.Ingr.Smat.Core.V1.SiteMatlStatus)" ContainsTarget="true"/>

<NavigationProperty Name="Status" Type="Collection(Com.Ingr.Smat.Core.V1.MaterialStatus)" ContainsTarget="true"/>

<NavigationProperty Name="Units" Type="Collection(Com.Ingr.Smat.Core.V1.Unit)" ContainsTarget="true"/>

<NavigationProperty Name="Warehouses" Type="Collection(Com.Ingr.Smat.Core.V1.Warehouse)" ContainsTarget="true"/>

<NavigationProperty Name="Workpacks" Type="Collection(Com.Ingr.Smat.Core.V1.WorkPack)" ContainsTarget="true"/>

</EntityType>

HTTP status code sent back to client on the API execution success: 
Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('{project}')/Disciplines('{discipline}')/Nls",

"value": [

{

"NlsId": "1",

"Description": "English"

},

{

"NlsId": "2",

"Description": "German"

},

{

"NlsId": "5",

"Description": "Japanese"

}

]

}

Error Response

This API may fail with the following error messages: 
Error Code: 401 Unauthorized 
Content:

{

"error": {

"code": "",

"message": "Authorization has been denied for this request." }

}

Notes