Check Edit Details

Create CheckEditSetDetail

Creates a new CheckEditSetDetail

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

CheckEditSetHeader Key

checkEditKey
required
integer <int32>

CheckEdit Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
checkEditSetHeader_Key
required
integer <int32>

Identifies which set the check edit belongs to. Note: This field is marked as NOT NULL in the database and therefore required by the API.

checkEdit_Key
required
integer <int32>

Description of the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.

checkEdit_Sequence
required
integer <int32>

Indicates a sequence number for the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.

enabled
required
boolean

Indicates that the check edit is currently enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

Responses
200

Success

401

Unauthorized

post/check-edit-details/{checkEditSetHeaderKey}/{checkEditKey}
Request samples
{
  • "checkEditSetHeader_Key": 0,
  • "checkEdit_Key": 0,
  • "checkEdit_Sequence": 0,
  • "enabled": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get CheckEditSetDetail

Gets CheckEditSetDetail

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

CheckEditSetHeader Key

checkEditKey
required
integer <int32>

CheckEdit Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/check-edit-details/{checkEditSetHeaderKey}/{checkEditKey}
Request samples 
Response samples 
No sample
Update CheckEditSetDetail
Updates a specific CheckEditSetDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkEditSetHeaderKey
required
integer <int32> 
CheckEditSetHeader Key


 
checkEditKey
required
integer <int32> 
CheckEdit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
checkEditSetHeader_Key
required
integer <int32> 
Identifies which set the check edit belongs to. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
checkEdit_Key
required
integer <int32> 
Description of the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
checkEdit_Sequence
required
integer <int32> 
Indicates a sequence number for the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
enabled
required
boolean
Indicates that the check edit is currently enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
Responses 
200
Success


401
Unauthorized


put/check-edit-details/{checkEditSetHeaderKey}/{checkEditKey}
Request samples 
{
  • "checkEditSetHeader_Key": 0,
  • "checkEdit_Key": 0,
  • "checkEdit_Sequence": 0,
  • "enabled": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CheckEditSetDetail
Deletes an CheckEditSetDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkEditSetHeaderKey
required
integer <int32> 
CheckEditSetHeader Key


 
checkEditKey
required
integer <int32> 
CheckEdit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/check-edit-details/{checkEditSetHeaderKey}/{checkEditKey}
Request samples 
List CheckEditSetDetail
Lists all CheckEditSetDetail


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/check-edit-details
Request samples 
Response samples 
No sample
Create or Update Batch CheckEditSetDetail
Create or Update multiple CheckEditSetDetail 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 
checkEditSetHeader_Key
required
integer <int32> 
Identifies which set the check edit belongs to. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
checkEdit_Key
required
integer <int32> 
Description of the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
checkEdit_Sequence
required
integer <int32> 
Indicates a sequence number for the check edit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
enabled
required
boolean
Indicates that the check edit is currently enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
Responses 
207
Success


401
Unauthorized


put/check-edit-details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}