Update a Flat Configuration header - 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 Flat Configuration (FLC) header in 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://local53965/SMAT/V1//Projects(':project')/Disciplines(':discipline')/Nls('language')/FlatConfigurations({key})

Specify values for 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).

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

Element

Description

Type

Required

Notes

FlcCode

Unique code or name of the Flat Configuration

String

Required

Maximum allowed length is 20.

FlcComment

Description of the Flat Configuration

String

Optional

Maximum allowed length is 80.

FlcDelimiter

Column separator. Example "/", "'", "%", and so on.

String

Optional

Maximum allowed length is 3.

DpId

Unique ID of the Discipline from where the FLC header is retrieved.

Integer

Optional

Maximum allowed length is 12.

SumPosInd

Indicates whether the equal positions of a node
should be summarized or not.
Allowed values are Y and N. Default value is N.

String

Optional

If value Y is passed, ClsId must be Null.

FlcLengthUnitId

Assigns a length unit to the BOM flat config import,
if no unit is imported.

Integer

Optional

Only those units that belong to
Quantity Unit group are
allowed.

FlcQtyUnitId

Assigns a quantity unit to the BOM flat config import, if no unit is imported.

Integer

Optional

Only those units
that belong to
Quantity Unit group are allowed.

SkipLines

Number of lines to skip in a FLC load

Integer

Optional

ClsId

Class system ID

Integer

Optional

If no parameter is passed, then PUT method overrides any existing data with a blank value.

Sample Code

PUT https://local53965/SMAT/V1//Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000007064)

{

"FlcCode":"KVFLCTESTQRY",

"FlcComment":"TEST FLC",

"FlcLengthUnitId":502262,

"FlcQtyUnitId":556694,

"FlcDelimiter":"]",

"SkipLines":1,

"SumPosInd":"N",

"ClsId":null

}

Sample Response

Status: 200 OK

{

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

"FlcId":10000007064,

"DpId":5020,

"FlcCode":"KVFLCTESTQRY",

"FlcComment":"TEST FLC",

"FlcLengthUnitId":502262,

"FlcQtyUnitId":556694,

"FlcDelimiter":"]",

"SkipLines":1,

"SumPosInd":"N",

"ClsId":null

}