APIs for VBASoftware
/
Process Correspondence Tr...
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Body
- application/json
- text/json
- application/*+json
ID of the report series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
User ID of the person either initiating or running the report series
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/report-series-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/report-series-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 '[
{
"reportSeries_Key": 0,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"series_Date": "2019-08-24T14:15:22Z",
"series_Description": "string",
"series_Status": "string",
"series_Type": "string",
"series_User": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}
]'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/process-correspondence-track-by-step
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/process-correspondence-track-by-step \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"reportSeriesStep_Key": 0,
"report_File": "string"
}'Response
No response exampleBody
- application/json
- text/json
- application/*+json
ID of the report series step. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates at what time the event will cease to occur on the defined date(s).
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
ID of the report series to which the step belongs. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies which report library the User wishes to choose from.
Indicates which report will be used with the automation step.
Indicates which method will be used to print the selected report.
Retry of the Retry. Note: The database will apply a default value of 0 for this field if a value is not provided.
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates how often the event will occur. The interval will determine which options are available for the event schedule.
Indicates the date when the event will begin occurring by the defined recurrence options.
Indicates at what time the event will occur on the defined date(s).
Identifies the number of the selected time period that the step will be delayed by.
Identifies the time period that the step will be delayed by.
Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order). Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Number of occurrences that will take place before the event ends.
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies which category the document belongs to.
Identifies the type associated with the document.
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/process-automation-process-series-by-step
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/process-automation-process-series-by-step \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"reportSeriesStep_Key": 0,
"eMail_Body": "string",
"eMail_From": "string",
"eMail_Server": "string",
"eMail_Subject": "string",
"eMail_To": "string",
"end_Date": "2019-08-24T14:15:22Z",
"end_Option": 0,
"end_Time": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"event_Priority": "string",
"event_Processor": "string",
"event_Subject": "string",
"event_UserGroup_Key": 0,
"event_User_ID": "string",
"frequency": 0,
"frequency_Factor": 0,
"friday": true,
"interval_Option": 0,
"monday": true,
"note_Category": "string",
"note_Data": "string",
"note_Subject": "string",
"relative_Frequency": 0,
"reportDefinition_Key": 0,
"reportSeries_Key": 0,
"report_Criteria_Object": "string",
"report_Library": "string",
"report_Object": "string",
"report_Printer": "string",
"report_Save_Location": "string",
"retry": 0,
"saturday": true,
"schedule_Interval": 0,
"start_Date": "2019-08-24T14:15:22Z",
"start_Time": "2019-08-24T14:15:22Z",
"step_Date": "2019-08-24T14:15:22Z",
"step_Delay": 0,
"step_Delay_Type": "string",
"step_Description": "string",
"step_Key": 0,
"step_MetaData": "string",
"step_Seq": 0,
"step_Type": "string",
"sunday": true,
"thursday": true,
"total_Occurrences": 0,
"tuesday": true,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"vbaGateway_Document_Category": "string",
"vbaGateway_Document_Field1": "string",
"vbaGateway_Document_Field2": "string",
"vbaGateway_Document_Field3": "string",
"vbaGateway_Document_Field4": "string",
"vbaGateway_Document_Field5": "string",
"vbaGateway_Document_File": "string",
"vbaGateway_Document_Folder": "string",
"vbaGateway_Document_ID": "string",
"vbaGateway_Document_Label": "string",
"vbaGateway_Document_Type": "string",
"vbaGateway_Document_Value1": "string",
"vbaGateway_Document_Value2": "string",
"vbaGateway_Document_Value3": "string",
"vbaGateway_Document_Value4": "string",
"vbaGateway_Document_Value5": "string",
"vbaGateway_UserID": "a8b19680-4553-4dc1-8618-a0ace7266c20",
"wednesday": true,
"fax_Number": "string",
"text_Number": "string",
"text_Message": "string",
"sftP_User": "string",
"sftP_Password": "string",
"sftP_Host": "string",
"sftP_Port": 0,
"sftP_Protocol": 0,
"sftP_Passive": true,
"sftP_Path": "string",
"sftP_File_Name": "string",
"activity_ID": "string",
"step_Error_Message": "string"
}'