This API retrieves the locations of a project from Smart Materials. You can either retrieve a single location using location Id or all the locations 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')/Locations({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 location Id (LocId).
To retrieve all the locations of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Locations
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Locations(5040)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https ://{ host} /Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls ('English')/Locations",
"value": [
{
"LocId":5040,
"LocCode":"RACK10",
"QuarantLocInd":"N"
}]
}
Element |
Description |
Type |
---|---|---|
LocId |
Unique ID of the location |
Integer |
LocCode |
Name of the location |
String |
QuarantLocInd |
Available values are Y and N.
|
String |