Delete a Flat Configuration item - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R2 (2.2)

This API deletes a Flat Configuration item from a specified Flat Configuration header in Smart Materials.

Required Privilege: API_FLC

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer<access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: DELETE https//localhost:61538/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/FlatConfigurations({key1})/Items({key2})

Specify the values for project, discipline, language, and keys in the URL. The project, discipline, and language together, define the project environment. The two key parameters define: key1 is Flat Configuration header Id (FlcId) and key2 is Flat Configuration Item Id (FlcItemId).

Element

Description

Type

Required

Notes

FlcId (key1)

Unique ID of the Flat Configuration header

Integer

Required

Maximum allowed length is 12.

FlcItemId (key2)

Unique ID of the Flat Configuration item

Integer

Required

Maximum allowed length is 12.

You cannot delete an item of a FLC Header that is used in any OMI Import job, whose status is STAGE.

Sample Code

DELETE https//localhost:61538/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/FlatConfigurations(10000005395)/Items(10000006193)

Success Response

Status: 204 No Content