This API retrieves the OpenInterfaces of a project. You can either retrieve a single OpenInterface by using OpenInterface Id or all the OpenInterfaces of a project.
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: GET https:///Project(':project')/OpenInterfaces({key})
Specify the value of the project and key parameter in the URL. The key parameter defines the OpenInterface Id (AoiId).
To retrieve all the OpenInterfaces of a project, use the following URL:
GET https://localhost:61538/smat/v1/Projects('RS)/OpenInterfaces
Sample Code
GET https://localhost:61538/smat/v1/Projects('RS')/OpenInterfaces(5000)
Success Response
Status: 200 OK
"@odata.context": "https://localhost:61538/SMAT/V1/$metadata#Projects('RS')/OpenInterfaces",
"value":[
{
"AoiId":5000,
"FileName":"File1.txt",
"Type":"JSON",
"Version":1,
"RecordId":1,
"InterfaceData":"Sample Interface Data",
"ProgrammeId":"emp_proc",
"ProgrammeCommand":"parms",
"Description":"Creates a new emp record",
"Status":"Yes",
"ResponseData":null
}
]
Element |
Description |
Type |
---|---|---|
AoiId |
Internal sequence generated ID for the primary key |
Integer |
FileName |
Name of the file |
String |
Type |
File type |
String |
Version |
Version number |
Integer 16 |
RecordId |
Unique key generated by the source system as a record identifier |
Integer |
InterfaceData |
Data used by the interface |
String |
ProgrammeId |
Name of the program which processes the interface data |
String |
ProgrammeCommand |
Commands to process program |
String |
Description |
Description |
String |
Status |
Interface program status |
String |
ResponseData |
Log information |
String |