This API retrieves the steel plates of a project from Smart Materials. You can either retrieve a single steel plate using plate Id or all the plates 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’)/SteelPlates({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 steel plate Id (SteelPlateId).
To retrieve all the steel plates of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/SteelPlates
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/SteelPlates(5001)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/SteelPlates",
"value": [
{
"SteelPlateId":5001,
"PlateNumber":"DST_PL01",
"Xdim":1,
"Ydim":1,
"PlateOrigin":"C1024",
"UnitId":500132,
"HeatId":5061,
"DpId":5020,
"ProjId":"RS"
}]
}
Element |
Description |
Type |
---|---|---|
SteelPlateId |
Unique ID of the steel plate |
Integer |
PlateNumber |
Name of the plate number |
String |
Xdim |
X-dimension of the plate number |
Decimal |
Ydim |
Y-dimension of the plate number |
Decimal |
PlateOrigin |
Specifies the functionality inserted in the steel plate data |
String |
UnitId |
Unique ID of the unit |
Integer |
HeatId |
Unique ID of the heat |
Integer |
DpId |
Unique ID of the Discipline. Retrieved plate belongs to this Discipline. |
Integer |
ProjId |
Unique ID of the Project. Retrieved plate belongs to this Project. |
String |