Update project - 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 your project's description, status,system user and password, and the project's scope.

Use the PATCH method to update a project 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>')

Resource path strings are case-sensitive.

Sample URI

PATCH

https://WebApiServer1/sem-webapi/sem/v2/Sites('WebAPISite01')/Plants('WebAPIPlant_01')/Projects('P1')

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

Sample JSON request

{

"Description": "Updated description of project",

"PlantGroups": ["7AD2A6F3C5EF48F18023B7276EB2192F", "3A7B706F5E1E4838B646C7AFD47B29E6"],

"Status": "Completed",

"SystemUser": "",

"SystemPassword": "",

}

  • If you wish to change the project scope, the plant group Id values needed can be obtained by running the View projects request and copying them from the response.

  • In this example, the plant groups consist of a single area (Area 1 with Id: "2AF526C34E524A318841D7B03A78F771") under which are two units (Unit 1 with Id: "7AD2A6F3C5EF48F18023B7276EB2192F" and Unit 2 with Id: "3A7B706F5E1E4838B646C7AFD47B29E6"). Only the IDs of the lowest level plant groups (the units) are defined for this scope. The Area's ID is returned automatically in the response (see below).

JSON request parameters

Parameter

Value

Description and Comments

Description

PlantGroups

IDs of the plant groups to be included in the scope

Select the IDs of the lowest level plant groups to be included in the scope, for example ["Unit 11 ID", "Unit 21 ID"].

Status

Active, Completed, Canceled, Merged

A project must have status 'Canceled' or 'Merged' before it can be deleted

Sample JSON response

Part of a typical response to this request is shown:

"Name": "P1",

"Description": "Updated description of project",

"PlantGroups": [

"2AF526C34E524A318841D7B03A78F771 - Area 1",

"7AD2A6F3C5EF48F18023B7276EB2192F - Unit 1",

"3A7B706F5E1E4838B646C7AFD47B29E6 - Unit 2"

],

"Applications": [

"Sppid"

],

"Status": "Completed", 

}

What do you want to do next?

Related topics

Create project

Delete project