Network Profiles

Create NetworkProfile

Creates a new NetworkProfile

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
profile_ID
required
string [ 1 .. 32 ] characters

Unique idenfitier assigned to the Network Profile record.

description
string or null <= 512 characters

Description of the Network Profile.

display
string or null <= 64 characters

Display name of the Network Profile.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 200 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/network-profiles
Request samples
{
  • "profile_ID": "string",
  • "description": "string",
  • "display": "string",
  • "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": {
    }
}

List NetworkProfile

Lists all NetworkProfile

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/network-profiles
Request samples 
Response samples 
No sample
Get NetworkProfile
Gets NetworkProfile


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Profile_ID
required
string
Profile ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/network-profiles/{Profile_ID}
Request samples 
Response samples 
No sample
Update NetworkProfile
Updates a specific NetworkProfile.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Profile_ID
required
string
Profile ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
profile_ID
required
string  [ 1 .. 32 ] characters 
Unique idenfitier assigned to the Network Profile record.


 
description
string or null  <= 512 characters 
Description of the Network Profile.


 
display
string or null  <= 64 characters 
Display name of the Network Profile.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 200 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/network-profiles/{Profile_ID}
Request samples 
{
  • "profile_ID": "string",
  • "description": "string",
  • "display": "string",
  • "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 NetworkProfile
Deletes an NetworkProfile


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Profile_ID
required
string
Profile ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/network-profiles/{Profile_ID}
Request samples 
Create or Update Batch NetworkProfile
Create or Update multiple NetworkProfile 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 
profile_ID
required
string  [ 1 .. 32 ] characters 
Unique idenfitier assigned to the Network Profile record.


 
description
string or null  <= 512 characters 
Description of the Network Profile.


 
display
string or null  <= 64 characters 
Display name of the Network Profile.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 200 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/network-profiles-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}