Taxonomy

Create Taxonomy

Creates a new Taxonomy

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
taxonomy_Key
required
integer <int32>

Key value identifying a specific provider taxonomy Note: This field is marked as NOT NULL in the database and therefore required by the API.

classification
string or null <= 256 characters

Classification associated with the provider taxonomy

definition
string or null

Definition of the provider taxonomy

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

grouping
string or null <= 256 characters

Grouping associated with the provider taxonomy

notes
string or null

Additional notes about the provider taxonomy

specialization
string or null <= 256 characters

Specialization associated with the provider taxonomy

taxonomy_Code
required
string [ 1 .. 32 ] characters

Code value identifying a specific provider taxonomy

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/taxonomies
Request samples
{
  • "taxonomy_Key": 0,
  • "classification": "string",
  • "definition": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "grouping": "string",
  • "notes": "string",
  • "specialization": "string",
  • "taxonomy_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Taxonomy

Lists all Taxonomy given a specific

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/taxonomies
Request samples 
Response samples 
No sample
Get Taxonomy
Gets Taxonomy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
taxonomyKey
required
integer <int32> 
Taxonomy Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/taxonomies/{taxonomyKey}
Request samples 
Response samples 
No sample
Update Taxonomy
Updates a specific Taxonomy.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
taxonomyKey
required
integer <int32> 
Taxonomy Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
taxonomy_Key
required
integer <int32> 
Key value identifying a specific provider taxonomy Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
classification
string or null  <= 256 characters 
Classification associated with the provider taxonomy


 
definition
string or null
Definition of the provider taxonomy


 
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


 
grouping
string or null  <= 256 characters 
Grouping associated with the provider taxonomy


 
notes
string or null
Additional notes about the provider taxonomy


 
specialization
string or null  <= 256 characters 
Specialization associated with the provider taxonomy


 
taxonomy_Code
required
string  [ 1 .. 32 ] characters 
Code value identifying a specific provider taxonomy


 
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/taxonomies/{taxonomyKey}
Request samples 
{
  • "taxonomy_Key": 0,
  • "classification": "string",
  • "definition": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "grouping": "string",
  • "notes": "string",
  • "specialization": "string",
  • "taxonomy_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Taxonomy
Deletes an Taxonomy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
taxonomyKey
required
integer <int32> 
Taxonomy Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/taxonomies/{taxonomyKey}
Request samples 
Create or Update Batch Taxonomy
Create or Update multiple Taxonomy 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_Key
required
integer <int32> 
Key value identifying a specific provider taxonomy Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
classification
string or null  <= 256 characters 
Classification associated with the provider taxonomy


 
definition
string or null
Definition of the provider taxonomy


 
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


 
grouping
string or null  <= 256 characters 
Grouping associated with the provider taxonomy


 
notes
string or null
Additional notes about the provider taxonomy


 
specialization
string or null  <= 256 characters 
Specialization associated with the provider taxonomy


 
taxonomy_Code
required
string  [ 1 .. 32 ] characters 
Code value identifying a specific provider taxonomy


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