Create an OpenInterface - 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 set of information (OpenInterface) in a destination system from any other source system.

Required Privilege: API_OPENINTERFACE

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')/OpenInterfaces

Specify the value for the project in the URL.

Element

Description

Type

Required

Notes

FileName

Name of the file

String

Required

Maximum allowed length is 500.

Type

File type

String

Required

Maximum allowed length is 1000.

Version

Version number

Integer 16

Required

Maximum allowed length is 3.

RecordId

Unique key generated by the source system as a record identifier

Integer

Required

Maximum allowed length is 12.

InterfaceData

Data used by the interface

String

Required

String with maximum allowed size of 4GB (CLOB).

ProgrammeId

Name of the program which processes the interface data

String

Required

Maximum allowed length is 60.

ProgrammeCommand

Commands to process program

String

Required

Maximum allowed length is 4000.

Description

Description

String

Optional

Maximum allowed length is 4000.

Status

Interface program status

String

Optional

Maximum allowed length is 4000.

Sample Code:

POST https://localhost:61538/smat/v1/Projects('RS')/OpenInterfaces

{

"FileName":"File16.txt",

"Type":"JSON",

"Version":1,

"RecordId":16,

"InterfaceData":"{\"UserName\":\"Jhonson\"}",

"ProgrammeId":"emp_proc",

"ProgrammeCommand":"parms",

"Description":"Creates a new emp record",

"Status":"Yes"

}

Success Response

Status: 201 Created

{

"@odata.context": "https://localhost:61538/SMAT/V1/$metadata#Projects('RS')/OpenInterfaces/$entity",

"AoiId":5063,

"FileName":"File16.txt",

"Type":"JSON",

"Version":1,

"RecordId":16,

"InterfaceData":"{\"UserName\":\"Jhonson\"}",

"ProgrammeId":"emp_proc",

"ProgrammeCommand":"parms",

"Description":"Creates a new emp record",

"Status":"Yes",

"ResponseData":null

}

Element

Description

Type

Notes

AoiID

Internal sequence generated ID for the primary key

Integer

Maximum allowed length is 12.

ResponseData

Log information

String

String with maximum allowed size of 4GB (CLOB)