Site Attribute Sets (SiteAttrSets) - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R1 (2.1)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R1 (2.1)

This API retrieves the site attribute set of a project from Smart Materials. You can retrieve a single site attribute set using site attribute Id or all the site attribute sets 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’)/SiteAttrSets({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 attributes set Id (SasId).

To retrieve all the site attribute sets of a project, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/SiteAttrSets

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/SiteAttrSets(5000)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/SiteAttrSets",

"value": [

{

"SasId":5000,

"ProjId":"RS",

"DpId":5020

}]

}

Element

Description

Type

SasId

Unique ID of the site attribute sets

Integer

ProjId

Unique ID of the Project. Retrieved site attribute sets belong to this Project.

String

DpId

Unique ID of the Discipline. Retrieved site attribute sets belong to this Discipline.

Integer