This API creates an item in a specified Flat Configuration 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: POST https://host/smat/v1/Projects('project')/Disciplines('discipline')/Nls('language')/FlatConfigurations({key})/Items
Specify values for the 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).
Element |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
FlcId |
Unique ID of the Flat Configuration header |
Integer |
Required |
Maximum allowed length is 12. |
OrderSeq |
Unique sequence number for the column mapping in a CSV file |
Integer |
Required |
Maximum allowed length is 5. |
ItemCode |
Represents the item codes of the Flat Configuration. GET https://host/smat/v1/Projects(':project')/ |
String |
Required |
Based on the ClsId of the corresponding |
ConsiderDeltaInd |
Defines whether the item |
String |
Optional |
Default value is Y. |
ItemValue |
Value of the Flat Configuration item |
String |
Optional |
Maximum allowed length is 255. Item value is optional for |
ItemDefault |
Default value of the Flat Configuration item |
String |
Optional |
Maximum allowed length is 2000. |
DpId |
Unique ID of the Discipline where the FLC item is created |
Integer |
Optional |
Maximum allowed length 12. |
Comment |
Comment related to the Flat Configuration item |
String |
Optional |
Maximum allowed length is 80. |
Each ItemCode accepts only certain values of ItemValue and ItemDefault parameters. The application throws an error if you enter any values apart from the allowed values.
Sample Code
POST https://localhost:53965/SMAT/V1//Projects('AB')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000007535)/Items
{ "FlcId":10000007535,
"OrderSeq":22,
"ItemCode":"IGNORE",
"ItemValue":"Dummy Column 22",
"ItemDefault":null,
"Comment":"TEST FLC Item",
"ConsiderDeltaInd":"Y"
}
Success Response
Status: 201 Created
{
"@odata.context": "https://localhost:56158/SMAT/V1/$metadata#Projects('AB')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000007535)/Items/$entity",
"FlcItemId":10000007535,
"FlcId":10000007535,
"OrderSeq":22,
"ItemCode":"IGNORE",
"ItemValue":"Dummy Column 22",
"DpId":5020,
"ItemDefault":null,
"Comment":"TEST FLC Item",
"ConsiderDeltaInd":"Y"
}
Element |
Description |
Type |
Notes |
---|---|---|---|
FlcItemId |
Unique ID of the Flat Configuration item |
Integer |