Add details to MIR by Direct Issue (D) - 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 adds inventory items to the specified Material Issue Report (MIR) of Smart Materials.

Required Privilege: API_CREATE_INV_ISSUES

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: POST https://(loacalhost)/smat/Project/Projects(':project')/Disciplines(':discipline')/Nls(':language')/IssueReports ({key})/Com.Ingr.Smat.V1.MIRInventory/

Specify values for 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 Issuing header Id.

Element

Description

Type

Required

Notes

IviId

Unique ID of the Inventory item

Decimal

Optional

To view available inventory items, use:

GET https://{host}/Smat/V1/Projects
(‘:project’)
/Disciplines(‘:discipline’)/
Nls(‘:language’)
/InvItems

IssueQty

Issued Quantity

Decimal

Optional

Allowed range is (0 - 9999999.999).

IssueDate

Date and time of the material issue

Date Time Offset

Optional

In the absence of IssueDate,
application takes
the current date
in format YYYY-MM-DD.

Ident

Name of the ident

Decimal

Optional

To view available
idents, use:

GET https://{host}/Smat/V1/Projects
(‘:project’)
/Disciplines(‘:discipline’)/
Nls(‘:language’)
/Idents

WhId

Unique ID of the warehouse

Decimal

Optional

To view available warehouses,
use:

GET

https://{host}/Smat/V1/Projects(‘:project’)
/Disciplines(‘:discipline’)/Nls(‘:language’)
/Warehouses

LocId

Unique ID of the location

Decimal

Optional

To view available locations, use:

GET

https://{host}/Smat/V1/Projects(':project')
/Disciplines(':discipline')/
Nls(':language')
/Locations

SmstId

Unique ID of the site material status

Decimal

Optional

To view available
site material status,
use:

GET

https://{host}/Smat/V1/Projects(':project')
/Disciplines(':discipline')/
Nls(':language')
/SiteMaterialStatus

UnitId

Unique ID of the unit

Decimal

Optional

To view available
units, use:

GET

https://{host}/Smat/V1/Projects
(':project')
/Disciplines(':discipline')/
Nls(':language')
/Units

TagNumber

Tag number

String

Optional

Maximum allowed length is 60.

HeatId

Unique ID of the heat

Decimal

Optional

To view available
heats, use:

GET

https://{host}/Smat/V1/Projects(
':project')
/Disciplines(':discipline')/
Nls(':language')
/Heats

IdentDeviation

Ident deviation for the selected item

String

Optional

Maximum allowed length is 255.

SasId

Unique ID of the site attribute sets

Decimal

Optional

To view available
site attribute sets,
use:

GET

https://{host}/Smat/V1/Projects(‘:project’)
/Disciplines(‘:discipline’)/
Nls(‘:language’)
/SiteAttrSets

SiteStatInd

Allowed values are Y and N.

  • If value Y is passed, only those statuses that
    are marked as
    Use on Site on B.10.08
    are considered.

String

Optional

Sample Code

POST https://(loacalhost)/smat/Projects('AB')/Disciplines('PIPING')/Nls('English')/IssueReports (7895)/Com.Ingr.Smat.V1.MIRInventory/

{

"invIssue":{

"Ident":73354280,

"WhId":5921,

"LocId":6783,

"SmstId":5681,

"UnitId":502543,

"IssueQty":1,

"TagNumber":"TAG001",

"HeatId":5805

}

}

Success Response
Status: 200 OK

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Edm.Int64",

"value": 10000011208

}