This API creates the structure details of an account code structure defined in the given project of Smart Materials.
Required Privilege: API_ACCOUNT_CODE
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
POST https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/AccountCodeStructures({key})/Structure Details
Specify the values for the project, discipline, language, and the key in the URL. The project, discipline, and language together, define the project environment where the account code structure item details are created. The key refers to the account code structure ID (JsId)
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
JsId |
Unique ID of the account code structure. |
Integer |
Mandatory |
|
|
OrderSeq |
Sequence number of the structure details.
|
Integer |
Mandatory |
Max allowed length is 5. |
|
StructureType |
Type of the structure details. Allowed Values:
|
String |
Mandatory |
|
|
PropertyCode |
Name of the Attribute/Property if the selected StructureType is Property. |
String |
Mandatory |
Max allowed length is 30. |
|
NodeType |
Name of the NodeType if the selected StructureType is Node. |
String |
Mandatory |
Max allowed length is 10. |
|
SeparatorText |
Refers to the text defined as separator if the StructureType is Separator. |
String |
Mandatory |
Max allowed length is 70. |
|
RequiredInd |
Indicates whether the value of the structure element is mandatory or not. |
String |
Mandatory |
|
|
Length |
Length of the structure element.
|
Integer |
Mandatory |
Max allowed length is 2. |
This sequence number must be unique within the account code structure.
Sample Body
POST http://localhost:5237/SMAT/V1/Projects('RS')/Disciplines('PIPING')/Nls('English')/ AccountCodeStructures(10000001886)/StructureDetails
{
"OrderSeq": 1,
"StructureType": "Property",
"PropertyCode": "MAT_CODE",
"NodeType": null,
"SeparatorText": null,
"RequiredInd": "Y",
"Length": 6
}
Success Response
Status Code: 201 Created
{
"@odata.context": "https://localhost:5237/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/AccountCodeStructures/$entity",
{
"JsdId": 5001,
"JsId": 5021,
"ProjId": "RS",
"OrderSeq": 1,
"StructureType": "Property",
"PropertyId": 500301,
"PropertyCode": "MAT_CODE",
"HintText": "Mat_Code sd",
"LsId": null,
"NodeType": null,
"ShortDesc": null,
"SeparatorText": null,
"RequiredInd": "Y",
"Length": 6
}
|
Element |
Description |
Type |
|---|---|---|
|
JsdId |
Unique ID of the structure details. |
Integer |
|
PropertyId |
Unique ID of the Attribute/Property type structure. |
Integer |
|
HintText |
Hint text related to the selected PropertyCode and it fills in automatically. |
String |
|
LsId |
Unique ID of the NodeType if the selected StructureType is Node. |
Integer |
|
ShortDesc |
Short description of the selected NodeType. It gets filled automatically |
String |