This API retrieves the site material status of a project from Smart Materials. You can either retrieve a single site material status using site material status Id or all the site material statuses 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')/SiteMaterialStatus({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 site material status Id (SmstId).
To retrieve all the site material status of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/SiteMaterialStatus
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/SiteMaterialStatus(5121)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/SiteMaterialStatus",
"value":[
{
"SmstId":5121,
"ProjId":"RS",
"SmstCode":"OK",
"OrderSeq":1,
"DpId":5020
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
SmstId |
Unique ID of the site material status |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved site material status belongs to this Project. |
String |
|
SmstCode |
Name of the site material status |
String |
|
OrderSeq |
Order sequence of the receiving status |
Integer |
|
DpId |
Unique ID of the Discipline. Retrieved status belongs to this Discipline. |
Integer |