Read a Flat Configuration item - Intergraph Smart Materials - Help - Hexagon

This API retrieves an item of a specified Flat Configuration header from the application.

Required Privilege: API_FLC

Headers

Body

URL Format:GET https://host/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/FlatConfigurations({key1})/Items({key2})

Specify values for project, discipline, language, and key parameters in the URL. The project, discipline, and language together, define the project environment. The two key parameters define: key1 is Flat Configuration header Id (FlcId) and key2 is Flat Configuration Item Id (FlcItemId).

To retrieve all the FLC items of a FLC header, use the following URL:

GET https://host/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/FlatConfigurations({key})/Items

FLC items are retrieved based on both discipline and Queryable discipline.

Sample Code

GET https://localhost:61538/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000005395)/Items(10000006193)

Success Response

Status: 200 OK

{

"@odata.context": "https://localhost:61538/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000005395)/items/$entity",

"FlcItemId":10000006193,

"FlcId"10000005395,

"OrderSeq":1,

"ItemCode":"NODE_LEV0N",

"ItemValue":"AREA",

"DpId":5020

"ItemDefault":null,

"Comment":null,

"ConsiderDeltaInd":"Y"

}