Create Material Issue Report header - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R1 (2.1)

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

This API creates a Material Issue Report (MIR) header in Smart Materials.

Required Privilege: API_CREATE_MIRHEADER

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://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/IssuingHeaders

Specify values for the project, discipline, and language parameter in the URL. The project, discipline, and language together, define the project environment in which the MIR header is created.

Element

Description

Type

Required

Notes

MirNumber

Name or code of the MIR

String

Required

RevisionId

Unique revision ID of the MIR

Decimal

Optional

Default value is 0.

FahId

Unique ID of the Forecast header.
Required only for MIR by Reservation.

Decimal

Optional

To view existing
Forecast headers, use:

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

Consider only those FaHeaders
whose status is Reserved.

MirCReateDate

Date and time of the MIR creation

Date Time Offset

Optional

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

IssueDate

Date and time of the material issue

Date Time Offset

Optional

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

IssueBy

Name of the user who has issued the MIR

String

Optional

CompanyId

Unique ID of the company

Decimal

Optional

To view existing companies, use:

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

WhId

Unique ID of the warehouse

Decimal

Optional

To view existing warehouses, use:

GET

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

LocId

Unique ID of the location

Decimal

Optional

To view existing locations, use:

GET

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

BnlId

Unique ID of the bin location

Decimal

Optional

To view existing bin locations, use:

GET

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

MirType

Type of the MIR. Available options are:

  • MIR by Reservation

  • MIR by Plates

  • MIR by BOM Commodity (B)

  • MIR by Direct Issue (D).

String

Optional

Based on the MIR type,
related parameters
vary.

LnId

Unique ID of the list node

Decimal

Optional

To view existing list nodes, use:

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

PopllsByProc

Allowed values are Y and N.

  • If value Y is passed,
    item shipments from the procurement
    populates automatically.

String

Optional

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://{host}/Smat/V1/Projects Projects('AB')/Disciplines('PIPING')/Nls('English')/IssuingHeaders

{

"MirNumber":"RW000004",

"RevisionId":0,

"FahId":5702,

"MirCreateDate":"2007-09-11T00:00:00+05:30",

"IssueDate":"2007-09-11T00:00:00+05:30",

"IssueBy":"#DoneRW",

"CompanyId":5265,

"WhId":null,

"LocId":null,

"BnlId":null,

"MirType":"D",

"LnId":null,

"PoplIssByProc":" ",

"SiteStatInd":null

}

Success Response
Status: 200 OK

{

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

"value": 10000010198

}

Where value is the unique ID of the Issuing Header (MirId).

SHARED Tip After creating MIR header, NLS description can be added using NlsDescription.