This API retrieves a Flat Configuration (FLC) header from Smart Materials. You can either retrieve a single FLC header by providing FlcId or all the FLC headers of a project.
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})
Specify values for the project, discipline, and language in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the Flat Configuration header Id (FlcId).
To retrieve all the FLC headers of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/FlatConfigurations
FLC headers are retrieved based on both discipline and Queryable disciplines.
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/FlatConfigurations(10000000034)
Success Response
Status: 200 OK
{
"@odata.context": "https://localhost:53965/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations/$entity",
"FlcId":10000000034,
"DpId":5020,
"FlcCode":"PLFLCTEST3",
"FlcComment":"SAMPLE FLC",
"FlcLengthUnitId":502262,
"FlcQtyUnitId":556694,
"FlcDelimiter":":",
"SkipLines":3,
"SumPosInd":"N",
"ClsId":null
}
|
Element |
Description |
Type |
|---|---|---|
|
FlcId |
Unique ID of the Flat Configuration header |
Integer |
|
DpId |
Unique ID of the Discipline from where the FLC header is retrieved. |
Integer |
|
FlcCode |
Unique code of the Flat Configuration |
String |
|
FlcComment |
Description of the Flat Configuration |
String |
|
FlcQtyUnitId |
Assigns a quantity unit to the BOM flat config import, if no unit is imported |
Integer |
|
FlclengthUnitId |
Assigns a length unit to the BOM flat config import, if no unit is imported |
Integer |
|
FlcDelimiter |
Column separator. Example: "/", ",", "%", and so on. |
String |
|
SkipLines |
Number of lines to skip in a FLC load |
Integer |
|
SumPosInd |
Indicates whether the equal positions of a node should be summarized or not. Available values are Y and N. Default value is N. |
String |
|
ClsId |
Class system ID |
Integer |