This API retrieves an item of a specified Flat Configuration header 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({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).
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
FlcId (Key1) |
Unique ID of the Flat Configuration header |
Integer |
Required |
Maximum allowed length is 12. |
|
FlcItemId (Key2) |
Unique ID of the Flat Configuration item |
Integer |
Optional |
Maximum allowed length is 12. |
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"
}
|
Element |
Description |
Type |
|---|---|---|
|
FlcItemId |
Unique ID of the Flat Configuration item |
Integer |
|
FlcId |
Unique ID of the Flat Configuration |
Integer |
|
OrderSeq |
Unique sequence number for column mapping in a CSV file |
Integer |
|
ItemCode |
Represents the item codes of the Flat Configuration. GET http://host/smat/v1/Projects(':project')/ |
String |
|
ItemValue |
Value of the Flat Configuration item |
String |
|
ItemDefault |
Default value of the Flat Configuration item |
String |
|
DpId |
Unique ID of the Discipline from where the FLC item is retrieved. |
Integer |
|
Comment |
Comment related to the Flat Configuration item |
String |
|
ConsiderDeltaInd |
Defines whether the item must be considered |
String |