VBAInterfaces

List VBA Interface Directions

List VBA Interface Directions

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/vba-interface-directions
Request samples 
Response samples 
No sample
Create VBAInterface
Creates a new VBAInterface


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
vbaInterface_Key
required
integer <int32> 
ID of the VBA interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
edM_Client_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
edM_Interface_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
edM_Vendor_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
vbaInterface_Automate_Job_Name
string or null  <= 256 characters 
Name for the automation job.


 
vbaInterface_Description
string or null
Description of the VBA interface.


 
vbaInterface_Direction
string or null  <= 32 characters 
Indicates whether the interface is outbound, inbound, or a web service.


 
vbaInterface_Execute_Details
string or null  <= 2048 characters 
Free text area where the interface execution details may be described.


 
vbaInterface_File_Naming_Convention
string or null  <= 2048 characters 
Free text area where any naming conventions may be described.


 
vbaInterface_Name
string or null  <= 256 characters 
Name for the VBA interface.


 
vbaInterface_Owner
string or null  <= 128 characters 
Indicates the owner who is associated with the interface.


 
vbaInterface_Schedule
string or null  <= 2048 characters 
Free text area where the interface schedule may be described.


 
vbaInterface_Status
string or null  <= 32 characters 
Indicates the current status of the interface.


 
vbaInterface_Type
string or null  <= 32 characters 
Indicates the type of interface being configured.


 
vbaInterface_Vendor
string or null  <= 32 characters 
Indicates the vendor who is associated with the interface.


 
Responses 
200
Success


401
Unauthorized


post/vba-interfaces
Request samples 
{
  • "vbaInterface_Key": 0,
  • "edM_Client_ID": "string",
  • "edM_Interface_ID": "string",
  • "edM_Vendor_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaInterface_Automate_Job_Name": "string",
  • "vbaInterface_Description": "string",
  • "vbaInterface_Direction": "string",
  • "vbaInterface_Execute_Details": "string",
  • "vbaInterface_File_Naming_Convention": "string",
  • "vbaInterface_Name": "string",
  • "vbaInterface_Owner": "string",
  • "vbaInterface_Schedule": "string",
  • "vbaInterface_Status": "string",
  • "vbaInterface_Type": "string",
  • "vbaInterface_Vendor": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List VBAInterface
Lists all VBAInterface


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
page
integer <int32> 
 Default:  1
Page


 
pageSize
integer <int32> 
 Default:  100
Page Size


 
sortBy
string
Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/vba-interfaces
Request samples 
Response samples 
No sample
Get VBAInterface
Gets VBAInterface


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/vba-interfaces/{vBAInterfaceKey}
Request samples 
Response samples 
No sample
Update VBAInterface
Updates a specific VBAInterface.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
vbaInterface_Key
required
integer <int32> 
ID of the VBA interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
edM_Client_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
edM_Interface_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
edM_Vendor_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
vbaInterface_Automate_Job_Name
string or null  <= 256 characters 
Name for the automation job.


 
vbaInterface_Description
string or null
Description of the VBA interface.


 
vbaInterface_Direction
string or null  <= 32 characters 
Indicates whether the interface is outbound, inbound, or a web service.


 
vbaInterface_Execute_Details
string or null  <= 2048 characters 
Free text area where the interface execution details may be described.


 
vbaInterface_File_Naming_Convention
string or null  <= 2048 characters 
Free text area where any naming conventions may be described.


 
vbaInterface_Name
string or null  <= 256 characters 
Name for the VBA interface.


 
vbaInterface_Owner
string or null  <= 128 characters 
Indicates the owner who is associated with the interface.


 
vbaInterface_Schedule
string or null  <= 2048 characters 
Free text area where the interface schedule may be described.


 
vbaInterface_Status
string or null  <= 32 characters 
Indicates the current status of the interface.


 
vbaInterface_Type
string or null  <= 32 characters 
Indicates the type of interface being configured.


 
vbaInterface_Vendor
string or null  <= 32 characters 
Indicates the vendor who is associated with the interface.


 
Responses 
200
Success


401
Unauthorized


put/vba-interfaces/{vBAInterfaceKey}
Request samples 
{
  • "vbaInterface_Key": 0,
  • "edM_Client_ID": "string",
  • "edM_Interface_ID": "string",
  • "edM_Vendor_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaInterface_Automate_Job_Name": "string",
  • "vbaInterface_Description": "string",
  • "vbaInterface_Direction": "string",
  • "vbaInterface_Execute_Details": "string",
  • "vbaInterface_File_Naming_Convention": "string",
  • "vbaInterface_Name": "string",
  • "vbaInterface_Owner": "string",
  • "vbaInterface_Schedule": "string",
  • "vbaInterface_Status": "string",
  • "vbaInterface_Type": "string",
  • "vbaInterface_Vendor": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAInterface
Deletes an VBAInterface


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/vba-interfaces/{vBAInterfaceKey}
Request samples 
Create or Update Batch VBAInterface
Create or Update multiple VBAInterface at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
vbaInterface_Key
required
integer <int32> 
ID of the VBA interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
edM_Client_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
edM_Interface_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
edM_Vendor_ID
string or null  <= 32 characters 
References the EDM (VBADataManagement) Interface value to create a hook into VBASoftware.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
vbaInterface_Automate_Job_Name
string or null  <= 256 characters 
Name for the automation job.


 
vbaInterface_Description
string or null
Description of the VBA interface.


 
vbaInterface_Direction
string or null  <= 32 characters 
Indicates whether the interface is outbound, inbound, or a web service.


 
vbaInterface_Execute_Details
string or null  <= 2048 characters 
Free text area where the interface execution details may be described.


 
vbaInterface_File_Naming_Convention
string or null  <= 2048 characters 
Free text area where any naming conventions may be described.


 
vbaInterface_Name
string or null  <= 256 characters 
Name for the VBA interface.


 
vbaInterface_Owner
string or null  <= 128 characters 
Indicates the owner who is associated with the interface.


 
vbaInterface_Schedule
string or null  <= 2048 characters 
Free text area where the interface schedule may be described.


 
vbaInterface_Status
string or null  <= 32 characters 
Indicates the current status of the interface.


 
vbaInterface_Type
string or null  <= 32 characters 
Indicates the type of interface being configured.


 
vbaInterface_Vendor
string or null  <= 32 characters 
Indicates the vendor who is associated with the interface.


 
Responses 
207
Success


401
Unauthorized


put/vba-interfaces-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}