Taxonomy Groups

Create TaxonomyGroup

Creates a new TaxonomyGroup

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
taxonomy_Group_ID
required
string [ 1 .. 16 ] characters

Identifier for the taxonomy group

description
required
string [ 1 .. 128 ] characters

Description of the taxonomy group

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

taxonomy_Type
required
string [ 1 .. 10 ] characters

Type of taxonomy included in the taxonomy group

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
Request samples
{
  • "taxonomy_Group_ID": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "taxonomy_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List TaxonomyGroup

Lists all TaxonomyGroup given a specific

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/taxonomy-groups
Request samples 
Response samples 
No sample
Create or Update Batch TaxonomyGroup
Create or Update multiple TaxonomyGroup 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 
taxonomy_Group_ID
required
string  [ 1 .. 16 ] characters 
Identifier for the taxonomy group


 
description
required
string  [ 1 .. 128 ] characters 
Description of the taxonomy group


 
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


 
taxonomy_Type
required
string  [ 1 .. 10 ] characters 
Type of taxonomy included in the taxonomy group


 
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
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get TaxonomyGroup
Gets TaxonomyGroup


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}
Request samples 
Response samples 
No sample
Update TaxonomyGroup
Updates a specific TaxonomyGroup.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
taxonomy_Group_ID
required
string  [ 1 .. 16 ] characters 
Identifier for the taxonomy group


 
description
required
string  [ 1 .. 128 ] characters 
Description of the taxonomy group


 
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


 
taxonomy_Type
required
string  [ 1 .. 10 ] characters 
Type of taxonomy included in the taxonomy group


 
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}
Request samples 
{
  • "taxonomy_Group_ID": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "taxonomy_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete TaxonomyGroup
Deletes an TaxonomyGroup


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/taxonomy-groups/{taxonomyGroupID}
Request samples