Refresh project users - Intergraph Smart Engineering Manager - Help - Intergraph

Intergraph Smart Engineering Manager Smart API Help (Version 2)

PPMProduct
Intergraph Smart Engineering Manager
PPMCategory_custom
Help
Version_WebSEM
2.0

This request allows you to update the roles for a project to reflect changes made to the Microsoft user groups upon which the group or role is based, or changes made to the access rights for a role.

Use the POST method to refresh a user list with the following input:

  • Service Root URI: https://<Server Name>/<IIS Application Name>/sem/v2

  • Resource path: /Sites('<Site Name>')/Plants('<Plant Name>')/Projects('<Project Name>')/Com.Ingr.Sem.v2.RefreshUsers/

  • Resource path strings are case-sensitive.

  • The backslash at the end of the resource path is mandatory.

Sample URI

POST

https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v2/Sites('WebAPISite_01')/Plants('WebAPIPlant_01')/Projects('P1')/Com.Ingr.Sem.v2.RefreshUsers/

Sample JSON request

The role's Id value can be obtained by running the View project roles request.

{

"Roles":

[

{

"Id": "0C85E220061D446A8A209F24C44DE1E4"

}

]

}

Sample JSON response

A typical response to the request is:

{

"@odata.context": "https://localhost/sem-webapi/sem/v2/$metadata#Com.Ingr.Sem.v2.RefreshUsersResult",

    "Roles":

[

        {

            "RoleId": "0C85E220061D446A8A209F24C44DE1E4",

            "RoleName": "MyDomain.com/US-ALL Employees",

            "IsRefreshed": true

        },

        {

            "RoleId": "0EC7C1552BB117047F441A114D4C89D6",

            "RoleName": "MyDomain.com/US-DG-Develop",

            "IsRefreshed": false

        }

    ]

}

In the above example, only the first role was refreshed, as shown by the status of the 'IsRefreshed' parameter for each role.