List Status (ListStatus) - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

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

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": "http://localhost:57464/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/ListStatus",

       "value": [

     {

      "LstId": 5021,

      "LstCode": "DEF",

      "ShortDesc": "Default",

      "Description": "Default Description",

      "ProjId": "PG",

      "DeleteInd": "Y",

      "OverWriteInd": "Y",

      "LockInd": "N"

       }

        }