Report Tracking Received Statuses

Create ReportTrackReceivedStatus

Creates a new ReportTrackReceivedStatus

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
reportDefinitionKey
required
integer <int32>

ReportDefinition Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportDefinition_Key
required
integer <int32>

ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.

received_Status
required
string [ 1 .. 32 ] characters

Name for the 'Received Status'.

description
string or null <= 128 characters

Description of the 'Received Status'.

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

status_Default
required
boolean

Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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-definitions/{reportDefinitionKey}/received-statuses
Request samples
{
  • "reportDefinition_Key": 0,
  • "received_Status": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "status_Default": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportTrackReceivedStatus

Lists all ReportTrackReceivedStatus for the given ReportDefinition_Key

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
reportDefinitionKey
required
integer <int32>

ReportDefinition Key

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-definitions/{reportDefinitionKey}/received-statuses
Request samples 
Response samples 
No sample
Get ReportTrackReceivedStatus
Gets ReportTrackReceivedStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
receivedStatus
required
string
Received Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-definitions/{reportDefinitionKey}/received-statuses/{receivedStatus}
Request samples 
Response samples 
No sample
Update ReportTrackReceivedStatus
Updates a specific ReportTrackReceivedStatus.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
receivedStatus
required
string
Received Status


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
received_Status
required
string  [ 1 .. 32 ] characters 
Name for the 'Received Status'.


 
description
string or null  <= 128 characters 
Description of the 'Received Status'.


 
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


 
status_Default
required
boolean
Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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-definitions/{reportDefinitionKey}/received-statuses/{receivedStatus}
Request samples 
{
  • "reportDefinition_Key": 0,
  • "received_Status": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "status_Default": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportTrackReceivedStatus
Deletes an ReportTrackReceivedStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
receivedStatus
required
string
Received Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-definitions/{reportDefinitionKey}/received-statuses/{receivedStatus}
Request samples 
Create or Update Batch ReportTrackReceivedStatus
Create or Update multiple ReportTrackReceivedStatus at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
received_Status
required
string  [ 1 .. 32 ] characters 
Name for the 'Received Status'.


 
description
string or null  <= 128 characters 
Description of the 'Received Status'.


 
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


 
status_Default
required
boolean
Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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-definitions/{reportDefinitionKey}/received-statuses-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}