Taxonomy Group Details

Create TaxonomyGroupDetail

Creates a new TaxonomyGroupDetail

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
taxonomyGroupID
required
string

Taxonomy Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
taxonomyGroupDetail_Key
required
integer <int32>

Key value identifying the range of taxonomies in the taxonomy group 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

from_Value
required
string [ 1 .. 10 ] characters

Taxonomy code value for the first taxonomy in the range

taxonomy_Group_ID
required
string [ 1 .. 16 ] characters

Identifier for the taxonomy group

thru_Value
string or null <= 10 characters

Taxonomy code value for the last taxonomy in the range

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/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details
Request samples
{
  • "taxonomyGroupDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Value": "string",
  • "taxonomy_Group_ID": "string",
  • "thru_Value": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List TaxonomyGroupDetail

Lists all TaxonomyGroupDetail given a specific taxonomyGroupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
taxonomyGroupID
required
string

Taxonomy Group ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details
Request samples 
Response samples 
No sample
Get TaxonomyGroupDetail
Gets TaxonomyGroupDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
taxonomyGroupID
required
string
Taxonomy Group ID


 
taxonomyGroupDetailKey
required
integer <int32> 
TaxonomyGroupDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details/{taxonomyGroupDetailKey}
Request samples 
Response samples 
No sample
Update TaxonomyGroupDetail
Updates a specific TaxonomyGroupDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
taxonomyGroupID
required
string
Taxonomy Group ID


 
taxonomyGroupDetailKey
required
integer <int32> 
TaxonomyGroupDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
taxonomyGroupDetail_Key
required
integer <int32> 
Key value identifying the range of taxonomies in the taxonomy group 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


 
from_Value
required
string  [ 1 .. 10 ] characters 
Taxonomy code value for the first taxonomy in the range


 
taxonomy_Group_ID
required
string  [ 1 .. 16 ] characters 
Identifier for the taxonomy group


 
thru_Value
string or null  <= 10 characters 
Taxonomy code value for the last taxonomy in the range


 
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/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details/{taxonomyGroupDetailKey}
Request samples 
{
  • "taxonomyGroupDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Value": "string",
  • "taxonomy_Group_ID": "string",
  • "thru_Value": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete TaxonomyGroupDetail
Deletes an TaxonomyGroupDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
taxonomyGroupID
required
string
Taxonomy Group ID


 
taxonomyGroupDetailKey
required
integer <int32> 
TaxonomyGroupDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details/{taxonomyGroupDetailKey}
Request samples 
Create or Update Batch TaxonomyGroupDetail
Create or Update multiple TaxonomyGroupDetail 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
taxonomyGroupID
required
string
Taxonomy Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
taxonomyGroupDetail_Key
required
integer <int32> 
Key value identifying the range of taxonomies in the taxonomy group 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


 
from_Value
required
string  [ 1 .. 10 ] characters 
Taxonomy code value for the first taxonomy in the range


 
taxonomy_Group_ID
required
string  [ 1 .. 16 ] characters 
Identifier for the taxonomy group


 
thru_Value
string or null  <= 10 characters 
Taxonomy code value for the last taxonomy in the range


 
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/taxonomy-groups/{taxonomyGroupID}/taxonomy-group-details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}