APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
Note: This field is marked as NOT NULL in the database and therefore required by the API.
Note: This field is marked as NOT NULL in the database and therefore required by the API.
What the file will be named when transfer completes
Specifies whether passive moede is used when establishing connection to the SFTP server Note: This field is marked as NOT NULL in the database and therefore required by the API.
Password associated with the SFTP_User account. Used for authentication.
Remote directory path where files are read from or written to during file transfer
Network port used to establish connection to the SFTP server, default is 22
Indicates protocol used for file transfer to the SFTP server
Username credential used to authenticate the connection to the external SFTP server
Note: This field is marked as NOT NULL in the database and therefore required by the API.
Note: This field is marked as NOT NULL in the database and therefore required by the API.
Note: This field is marked as NOT NULL in the database and therefore required by the API.
What the file will be named when transfer completes
Specifies whether passive moede is used when establishing connection to the SFTP server Note: This field is marked as NOT NULL in the database and therefore required by the API.
Password associated with the SFTP_User account. Used for authentication.
Remote directory path where files are read from or written to during file transfer
Network port used to establish connection to the SFTP server, default is 22
Indicates protocol used for file transfer to the SFTP server
Username credential used to authenticate the connection to the external SFTP server
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/vba-interface/{VBAInterface_Key}/profile/{Profile_Key}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/vba-interface/{VBAInterface_Key}/profile/{Profile_Key}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"vbaInterface_Key": 0,
"profile_Key": 0,
"acknowledgment_Requested": "s",
"application_Receivers_Code": "string",
"application_Senders_Code": "string",
"authorization_Information": "string",
"authorization_Information_Qualifier": "st",
"client_SFTP_File_Name": "string",
"client_SFTP_Host": "string",
"client_SFTP_Passive": true,
"client_SFTP_Password": "string",
"client_SFTP_Path": "string",
"client_SFTP_Port": 0,
"client_SFTP_Protocol": 0,
"client_SFTP_User": "string",
"component_Element_Separator": "s",
"create_Date": "string",
"create_Time": "string",
"description": "string",
"eMail_Body": "string",
"eMail_From": "string",
"eMail_Notification": true,
"eMail_Server": "string",
"eMail_Subject": "string",
"eMail_To": "string",
"event_ID": 0,
"functional_Identifier_Code": "st",
"group_Control_Number": "string",
"interchange_Control_Number": "string",
"interchange_Control_Version_Number": "strin",
"interchange_Date": "string",
"interchange_ID_Qualifier_Receiver": "st",
"interchange_ID_Qualifier_Sender": "st",
"interchange_Receiver_ID": "string",
"interchange_Sender_ID": "string",
"interchange_Time": "stri",
"repetition_Separator": "s",
"responsible_Agency_Code": "st",
"run_On_Demand": true,
"security_Information": "string",
"security_Information_Qualifier": "st",
"test_File": true,
"usage_Indicator": "s",
"vendor_SFTP_File_Name": "string",
"vendor_SFTP_Host": "string",
"vendor_SFTP_Passive": true,
"vendor_SFTP_Password": "string",
"vendor_SFTP_Path": "string",
"vendor_SFTP_Port": 0,
"vendor_SFTP_Protocol": 0,
"vendor_SFTP_User": "string",
"version_Release_Industry_Identifier": "string"
}'- text/plain
- application/json
- text/json
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/vba-interface/{VBAInterface_Key}/profile/{Profile_Key}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/vba-interface/{VBAInterface_Key}/profile/{Profile_Key}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Request
Create or Update multiple VBAInterfaceProfile at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
- application/json
- text/json
- application/*+json
Note: This field is marked as NOT NULL in the database and therefore required by the API.
Note: This field is marked as NOT NULL in the database and therefore required by the API.
What the file will be named when transfer completes
Specifies whether passive moede is used when establishing connection to the SFTP server Note: This field is marked as NOT NULL in the database and therefore required by the API.
Password associated with the SFTP_User account. Used for authentication.
Remote directory path where files are read from or written to during file transfer
Network port used to establish connection to the SFTP server, default is 22
Indicates protocol used for file transfer to the SFTP server
Username credential used to authenticate the connection to the external SFTP server
Note: This field is marked as NOT NULL in the database and therefore required by the API.
Note: This field is marked as NOT NULL in the database and therefore required by the API.
Note: This field is marked as NOT NULL in the database and therefore required by the API.
What the file will be named when transfer completes
Specifies whether passive moede is used when establishing connection to the SFTP server Note: This field is marked as NOT NULL in the database and therefore required by the API.
Password associated with the SFTP_User account. Used for authentication.
Remote directory path where files are read from or written to during file transfer
Network port used to establish connection to the SFTP server, default is 22
Indicates protocol used for file transfer to the SFTP server
Username credential used to authenticate the connection to the external SFTP server
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/vba-interface-profile-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/vba-interface-profile-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"vbaInterface_Key": 0,
"profile_Key": 0,
"acknowledgment_Requested": "s",
"application_Receivers_Code": "string",
"application_Senders_Code": "string",
"authorization_Information": "string",
"authorization_Information_Qualifier": "st",
"client_SFTP_File_Name": "string",
"client_SFTP_Host": "string",
"client_SFTP_Passive": true,
"client_SFTP_Password": "string",
"client_SFTP_Path": "string",
"client_SFTP_Port": 0,
"client_SFTP_Protocol": 0,
"client_SFTP_User": "string",
"component_Element_Separator": "s",
"create_Date": "string",
"create_Time": "string",
"description": "string",
"eMail_Body": "string",
"eMail_From": "string",
"eMail_Notification": true,
"eMail_Server": "string",
"eMail_Subject": "string",
"eMail_To": "string",
"event_ID": 0,
"functional_Identifier_Code": "st",
"group_Control_Number": "string",
"interchange_Control_Number": "string",
"interchange_Control_Version_Number": "strin",
"interchange_Date": "string",
"interchange_ID_Qualifier_Receiver": "st",
"interchange_ID_Qualifier_Sender": "st",
"interchange_Receiver_ID": "string",
"interchange_Sender_ID": "string",
"interchange_Time": "stri",
"repetition_Separator": "s",
"responsible_Agency_Code": "st",
"run_On_Demand": true,
"security_Information": "string",
"security_Information_Qualifier": "st",
"test_File": true,
"usage_Indicator": "s",
"vendor_SFTP_File_Name": "string",
"vendor_SFTP_Host": "string",
"vendor_SFTP_Passive": true,
"vendor_SFTP_Password": "string",
"vendor_SFTP_Path": "string",
"vendor_SFTP_Port": 0,
"vendor_SFTP_Protocol": 0,
"vendor_SFTP_User": "string",
"version_Release_Industry_Identifier": "string"
}
]'- text/plain
- application/json
- text/json
No response example