This API retrieves the list nodes of a project from Smart Materials. You can either retrieve a single list node by using list node Id or all the list nodes of a project.
Required Privilege: API_READONLY
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’)/Listnodes({key})
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 list node Id (LnId).
To retrieve all the list nodes of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Listnodes
Sample Code
GET https://{host}/Smat/V1/Projects(‘M12_EP3_Q’)/Disciplines(‘PROS’)/Nls(‘English’)/Listnodes(14396055)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('M12_EP3_Q')/Disciplines('PROS')/Nls('English')/Listnodes",
"value":[
{
"LnId":14396055,
"LsId":7802,
"ProjId":"M12_EP3_Q",
"DpId": 5060,
"LnCode":"MTO_EQUI",
"ParentLnId":null,
"GeneratedName":"DISC: MTO_EQUI",
"LoadInd":"Y",
"LockInd":"N",
"SiteStatId":null,
"EstShortNodeInd":"N",
"BOMPath":"MTO_EQUI"
}]
}
Element |
Description |
Type |
---|---|---|
LnId |
Unique ID of the retrieved list nodes |
Integer |
LsId |
Unique ID of the list structure |
Integer |
ProjId |
Unique ID of the Project. Retrieved list nodes belong to this Project. |
String |
DpId |
Unique ID of the Discipline. Retrieved list nodes belong to this Discipline. |
Integer |
LnCode |
Name of the list node |
String |
ParentLnId |
Unique ID of the parent list node |
Integer |
GeneratedName |
Name of the retrieved list node generated from the user defined algorithm. |
String |
LoadInd |
String |
|
LockInd |
Allowed values are Y and N.
|
String |
SiteStatId |
Allowed values are Y and N.
|
Integer |
EstShortNodeInd |
String |
|
BOMPath |
BOM path of the list node |
String |