Update a Flat Configuration item - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help

Update a Flat Configuration item - 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 updates an existing item in a specified Flat Configuration (FLC) header of 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: PUT 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).

You cannot update an item of a FLC Header that is used in any OMI Import job whose status is STAGE.

Element	Description	Type	Required	Notes
FlcId	Unique ID of the Flat Configuration header. Retrieved Items belong to this FLC Header.	Integer	Required	Maximum allowed length is 12.
FlcItemId	Unique ID of the Flat Configuration Item	Integer	Required
OrderSeq	Unique sequence number for column mapping in CSV file.	Integer	Required	Maximum allowed length is 5.
ItemCode	Represents the item codes of the Flat Configuration. To know the allowed item codes, use: GET https://host/smat/v1/Projects(':project')/ Disciplines(':discipline')/Nls(':language') /FlatConfigurations({key}) /ValidItemCodes()	String	Required	Based on the ClsId of the corresponding Flat Configuration header, the allowed values for FlcItemCode can vary.
ItemValue	Value of the Flat Configuration item	String	Optional	Maximum allowed length is 255.
ItemDefault	Default value of the Flat Configuration item	String	Optional	Maximum allowed length is 2000.
DpId	Unique ID of the Discipline from where the FLC item is retrieved.	Integer	Optional	Maximum allowed length is 12.
Comment	Comment related to the Flat Configuration item	String	Optional	Maximum allowed length is 80.
ConsiderDeltaInd	Defines whether the item must be considered for a delta check with the previous BOM import, via flat loading config or not.	String	Optional	Default value is Y.

Each ItemCode accepts only certain values of ItemValue and ItemDefault parameters. The application throws an error if you enter any value apart from the allowed values.
If no parameter is passed, then PUT method overrides any existing data with a blank value.

Sample Code

PUT https://localhost:61538/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000006056)/Items(10000007534)

{

"OrderSeq":19,

"ItemCode":"POS_CC",

"ItemValue":null,

"ItemDefault":null,

"Comment":"TEST FLC Item",

"ConsiderDeltaInd":"Y"

}

Success Response

Status: 200 OK

{

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

"FlcItemId":10000007534,

"FlcId":10000006056,