This API retrieves the attributes of a project from Smart Materials. You can either retrieve a single attribute using attribute Id or all the attributes 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’)/Attributes({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 atribute Id (AttrId).
To retrieve all the attributes of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Attributes
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Attributes(5329)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/Attributes",
"value":[
{
"AttrId":5329,
"ProjId":"PG",
"AttrCode":"I_VALVE_MATERIAL"
}]
}
Element |
Description |
Type |
---|---|---|
AttrId |
Unique ID of the retrieved attribute |
Integer |
ProjId |
Unique ID of the Project/Product group. Retrieved attribute belongs to this Project. |
String |
AttrCode |
Name of the attribute |
String |