ClientConfigUserOverride

Create ClientConfigUserOverride

Creates a new ClientConfigUserOverride

SecurityapiKeyAuth
Request
header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID from VBASoftware

vbagateway-database
required
string

Target database

Request Body schema:
required
userId
required
string <uuid>

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

config_ID
required
string [ 1 .. 32 ] characters
config_DataType
string or null <= 16 characters
config_Datetime
string or null <date-time>
config_Decimal
number or null <double>
config_Int
integer or null <int32>
config_String
string or null
Responses
200

Success

401

Unauthorized

post/client-config-user-overrides
Request samples
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "config_ID": "string",
  • "config_DataType": "string",
  • "config_Datetime": "2019-08-24T14:15:22Z",
  • "config_Decimal": 0.1,
  • "config_Int": 0,
  • "config_String": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClientConfigUserOverride

Lists all ClientConfigUserOverride

SecurityapiKeyAuth
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
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/client-config-user-overrides
Request samples 
Response samples 
No sample
Get ClientConfigUserOverride
Gets ClientConfigUserOverride


SecurityapiKeyAuth 
Request 
path Parameters
Config_ID
required
string
Config ID


 
UserId
required
string
UserId


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/client-config-user-overrides/{Config_ID}/{UserId}
Request samples 
Response samples 
No sample
Update ClientConfigUserOverride
Updates a specific ClientConfigUserOverride.


SecurityapiKeyAuth 
Request 
path Parameters
Config_ID
required
string
Config ID


 
UserId
required
string
UserId


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
userId
required
string <uuid> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
config_ID
required
string  [ 1 .. 32 ] characters 
 
config_DataType
string or null  <= 16 characters 
 
config_Datetime
string or null <date-time> 
 
config_Decimal
number or null <double> 
 
config_Int
integer or null <int32> 
 
config_String
string or null
 
Responses 
200
Success


401
Unauthorized


put/client-config-user-overrides/{Config_ID}/{UserId}
Request samples 
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "config_ID": "string",
  • "config_DataType": "string",
  • "config_Datetime": "2019-08-24T14:15:22Z",
  • "config_Decimal": 0.1,
  • "config_Int": 0,
  • "config_String": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClientConfigUserOverride
Deletes an ClientConfigUserOverride


SecurityapiKeyAuth 
Request 
path Parameters
Config_ID
required
string
Config ID


 
UserId
required
string
UserId


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/client-config-user-overrides/{Config_ID}/{UserId}
Request samples 
Create or Update Batch ClientConfigUserOverride
Create or Update multiple ClientConfigUserOverride at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
userId
required
string <uuid> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
config_ID
required
string  [ 1 .. 32 ] characters 
 
config_DataType
string or null  <= 16 characters 
 
config_Datetime
string or null <date-time> 
 
config_Decimal
number or null <double> 
 
config_Int
integer or null <int32> 
 
config_String
string or null
 
Responses 
207
Success


401
Unauthorized


put/client-config-user-overrides-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}