This API retrieves all the log records of the Import interface from the Smart Materials. You can retrieve all the log records by providing Open MTO Interface (OMI) Import job Id.
Required Privilege: API_BOM
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: GET https://host/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/OMIImportJobs ({key})/ImportProtocols
Specify values for the 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 OMI Import job Id (OMIJId).
Log records are retrieved based on the given discipline and Queryable discipline.
Sample Code
GET https://in-smatapi.ingrnet.com/current/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(17958)/ImportProtocols
Success Response
Status: 200 OK
{
"@odata.context": "https://in-smatapi.ingrnet.com/current/SMAT/V1/$metadata#Collection(Com.Ingr.Smat.Core.V1.ImportProtocol)",
"value": [
{
"LogId":9888281,
"OMIJId":17958,
"SeqId":19920939,
"ImpilDate":"2007-06-11T20:15:49-07:00",
"Kind":"POS_A",
"State":"E",
"Text":"ERROR: Attribute value not allowed.",
"ErrLnId":219268,
"ErrListPosition":"70",
"ErrLineNumber":426
}
}
|
Element |
Description |
Type |
|---|---|---|
|
LogId |
Unique ID of the log |
Integer |
|
OMIJId |
Unique ID of the OMI Import Job |
Integer |
|
SeqId |
Integer |
|
|
ImpilDate |
Date Time Offset |
|
|
Kind |
The context of the log entry |
String |
|
State (ST) |
Indicates whether a log entry is an informational message (I), a warning (W), or an error (E) |
String |
|
Text |
Detailed message or an error text for a log entry |
String |
|
ErrLnId |
Unique ID of the Error Line Number |
Integer |
|
ErrListPosition |
Indicates BOM position. If there is any BOM position context present when an error occurs, |
String |
|
ErrLineNumber |
If the log record is an error entry, ErrLine is the line number of the ASCII file,
|
Integer |