This API retrieves the attribute values of a project from Smart Materials. You can either retrieve a single attribute value by using attribute Id (AttrId) or all the attribute values 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’)/AttributeValues({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 attribute Id (AttrId).
To retrieve all the attribute values of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/AttributeValues
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/AttributeValues(5329)
Success Response
Status:200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/AttributeValues",
"value":[
{
"AttrId":5329,
"AttrSeq":1,
"AttrValue":"AS",
"ShortDesc":"{Alloy steel}{AS}{Alloy steel}{alloy%steel}{Alloy st.}"
}]
}
Element |
Description |
Type |
---|---|---|
AttrId |
Unique ID of the retrieved attribute |
Integer |
AttrSeq |
Sequence number of the attribute |
Integer |
AttrValue |
Value of the retrieved attribute |
String |
ShortDesc |
Short description of the attribute |
String |