List Status (ListStatus) - 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 list status of a project from Smart Materials. You can either retrieve a single list status using list status Id or all the list status 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’)/ListStatus({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 list status Id (LstId).

To retrieve all the list status of a project, use the following URL:

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

Sample Code

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

Success Response

Status: 200 OK

Content:

{

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

"value":[

{

"LstId":5021,

"LstCode":"DEF",

"ShortDesc":"Default",

"Description":"Default",

"ProjId":"PG"

}]

}

Element

Description

Type

LstId

Unique ID of the list status

Integer

LstCode

Name of the list status

String

ShortDesc

Short description of the list status

String

Description

Description of the list status

String

ProjId

Unique ID of the Project. Retrieved list status belongs to this Project.

String