Report Tracking

Create ReportTrack

Creates a new ReportTrack

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportTrack_Key
required
integer <int32>

ID of the report tracking. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

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

priority
string or null <= 32 characters

Identifies the priority of the report.

received_Date
string or null <date-time>

Date when the report was received.

received_Status
string or null <= 32 characters

Identifies the 'Receieved Status' of the report.

received_User
string or null <= 20 characters

ID of the User who received the report.

reportQueueDetail_Key
required
integer <int32>

ID of the report queue detail. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

sent_Date
string or null <date-time>

Identifies the date when the report was sent.

sent_Status
string or null <= 32 characters

Identifies the sent status of the report.

sent_To
string or null <= 32 characters

Identifies the 'Sent To' subject of the report.

sent_User
string or null <= 20 characters

ID of the User who sent the report.

tracking_Status
string or null <= 32 characters

Identifies the tracking status of the report.

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

Responses
200

Success

401

Unauthorized

post/report-tracks
Request samples
{
  • "reportTrack_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "priority": "string",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "received_Status": "string",
  • "received_User": "string",
  • "reportQueueDetail_Key": 0,
  • "sent_Date": "2019-08-24T14:15:22Z",
  • "sent_Status": "string",
  • "sent_To": "string",
  • "sent_User": "string",
  • "tracking_Status": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportTrack

Lists all ReportTrack

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/report-tracks
Request samples 
Response samples 
No sample
Get ReportTrack
Gets ReportTrack


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportTrackKey
required
integer <int32> 
ReportTrack Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-tracks/{reportTrackKey}
Request samples 
Response samples 
No sample
Update ReportTrack
Updates a specific ReportTrack.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportTrackKey
required
integer <int32> 
ReportTrack Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportTrack_Key
required
integer <int32> 
ID of the report tracking.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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


 
priority
string or null  <= 32 characters 
Identifies the priority of the report.


 
received_Date
string or null <date-time> 
Date when the report was received.


 
received_Status
string or null  <= 32 characters 
Identifies the 'Receieved Status' of the report.


 
received_User
string or null  <= 20 characters 
ID of the User who received the report.


 
reportQueueDetail_Key
required
integer <int32> 
ID of the report queue detail.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
sent_Date
string or null <date-time> 
Identifies the date when the report was sent.


 
sent_Status
string or null  <= 32 characters 
Identifies the sent status of the report.


 
sent_To
string or null  <= 32 characters 
Identifies the 'Sent To' subject of the report.


 
sent_User
string or null  <= 20 characters 
ID of the User who sent the report.


 
tracking_Status
string or null  <= 32 characters 
Identifies the tracking status of the report.


 
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


 
Responses 
200
Success


401
Unauthorized


put/report-tracks/{reportTrackKey}
Request samples 
{
  • "reportTrack_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "priority": "string",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "received_Status": "string",
  • "received_User": "string",
  • "reportQueueDetail_Key": 0,
  • "sent_Date": "2019-08-24T14:15:22Z",
  • "sent_Status": "string",
  • "sent_To": "string",
  • "sent_User": "string",
  • "tracking_Status": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportTrack
Deletes an ReportTrack


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportTrackKey
required
integer <int32> 
ReportTrack Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-tracks/{reportTrackKey}
Request samples 
Create or Update Batch ReportTrack
Create or Update multiple ReportTrack 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 
reportTrack_Key
required
integer <int32> 
ID of the report tracking.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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


 
priority
string or null  <= 32 characters 
Identifies the priority of the report.


 
received_Date
string or null <date-time> 
Date when the report was received.


 
received_Status
string or null  <= 32 characters 
Identifies the 'Receieved Status' of the report.


 
received_User
string or null  <= 20 characters 
ID of the User who received the report.


 
reportQueueDetail_Key
required
integer <int32> 
ID of the report queue detail.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
sent_Date
string or null <date-time> 
Identifies the date when the report was sent.


 
sent_Status
string or null  <= 32 characters 
Identifies the sent status of the report.


 
sent_To
string or null  <= 32 characters 
Identifies the 'Sent To' subject of the report.


 
sent_User
string or null  <= 20 characters 
ID of the User who sent the report.


 
tracking_Status
string or null  <= 32 characters 
Identifies the tracking status of the report.


 
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


 
Responses 
207
Success


401
Unauthorized


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