PATCH Requests to update item properties - Intergraph Smart P&ID - 2.0 - Customization & Programming - Hexagon

Intergraph Smart P&ID Web API Help

Language
English
Product
Intergraph Smart P&ID
Subproduct
Web API
Search by Category
Customization & Programming
Smart P&ID Web API Version
2.0
Smart Electrical Web Version
2.0.1

This request provides an example for updating a property of a vessel. You can follow this procedure and modify the request to update any suitable property of any item type.

  1. Select the request 07.01 Update Vessel Properties.

    https://apiservername.domain.com/WebApi/SPID/V2/Sites('WEBAPISITE001')/Plants('PLANT001')/
    Vessels('B6D99B6451A547499082C5520C90BC20')

    The Header field of the update script must contain the key 'If-Match' with value * or some other suitable value.

  2. Ensure that the Body field of the update script contains the parameter for the property you want to update (the example shows the script for updating a vessel's 'Tag Prefix' property):

    {

    "TagPrefix": "CCC"

    }

  3. Modify the value of the item's property as required.

  4. Click Send.

SHARED Tip To view the results of the update, run the following GET request:

https://apiservername.domain.com/WebApi/SPID/V2/Sites('WEBAPISITE001')/Plants('PLANT001')/
Vessels('B6D99B6451A547499082C5520C90BC20')/Com.Ingr.SPID.V2.WEBAPISITE001.PLANT001.Vessel
?$select=Id,ItemTag,TagSuffix,TagPrefix,Description