This API retrieves the bin location warehouses of a project from Smart Materials. You can either retrieve a single bin location warehouse using bin location Id or all the bin location 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’)/BinLocWarehouses({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 bin location Id (BnlId).
To retrieve all the bin location warehouses of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/BinLocWarehouses
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/BinLocWareHouses(5080)
Success Response
Status: 200 OK
Content
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/BinLocWarehouses",
"value": [
{
"BnlId":5080,
"WhId":5981,
"ProjId":"RS"
}]
}
Element |
Description |
Type |
---|---|---|
BnlId |
Unique ID of the bin Location |
Integer |
WhId |
Unique ID of the warehouse |
Integer |
ProjId |
Unique ID of the Project. Retrieved bin location warehouse belongs to this Project. |
String |