This API retrieves the warehouse of a project from Smart Materials. You can either retrieve a single warehouse using warehouse Id or all the warehouses 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’)/Warehouses({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 warehouse Id (WhId).
To retrieve all the warehouses of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Warehouses
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Warehouses(5082)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/Warehouses",
"value":[
{
"WhId":5082,
"ProjId:"RS",
"WhCode":"WH-01",
"MultiWhInd":"Y",
"DeChIsWhInd":"N",
"ScrapWhInd":"N",
"NestedPlateInd":"N",
"CorporateWhInd":"N",
"FreeMaterialWhInd":"N",
"RentalInd":"N"
}]
}
Element |
Description |
Type |
---|---|---|
WhId |
Unique ID of the warehouse |
Integer |
ProjId |
Unique ID of the Project. Retrieved warehouse belongs to this Project. |
String |
WhCode |
Name of the warehouse |
String |
MultiWhInd |
Available values are Y and N.
|
String |
DeChlsWhInd |
Available values are Y and N.
|
String |
ScrapWhInd |
Available values are Y and N.
|
String |
NestedPlateInd |
Available values are Y and N.
|
String |
CorporateWhInd |
Available values are Y and N.
|
String |
FreeMaterialWhInd |
Available values are Y and N.
|
String |
RentalInd |
Available values are Y and N.
|
String |