Read a valid FlatConfigItem codes - 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 all the item codes of a Flat Configuration from Smart Materials.

Required Privilege: API_FLC

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')/FlatConfigurations({key})/ValidItemCodes()

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 Flat Configuration header Id (FlcId), whose item codes are retrieved.

Sample Code

GET https://localhost:61538/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000001374)/ValidItemCodes()

Success Response

Status: 200 OK

Content: { "@odata.context": "https://localhost:61538/SMAT/V1/$metadata#Collection(Com.Ingr.Smat.Core.V1.FlatConfigItemCodes)",

"value": [

{

"ItemCode":"POS_UNIT",

"Meaning":"Position Quantity Unit (NO LENGTH but pcs,EA etc.)",

"Value":"EA",

"Type":"O"

},

{

"ItemCode":"NODE_LEV7N",

"Meaning":"Horizontal Location of 7th Node Name in Hierarchy on Position Level",

"Value":null,

"Type":"C"

}

]

Element

Description

Type

ItemCode

Item type/code of the Flat Configuration

String

Meaning

Explanation associated with an item type

String

Value

Value of the FlatConfig item

String

Type

Type of the FlatConfig item

String