Claim Queue Schedules

Create ClaimQueueSchedule

Creates a new ClaimQueueSchedule

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimQueueSchedule_Key
required
integer <int32>
description
string or null <= 256 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
queue_Event_ID
integer or null <int32>
queue_SQL
string or null <= 4000 characters
queue_Type
string or null <= 32 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-queue-schedules
Request samples
{
  • "claimQueueSchedule_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Event_ID": 0,
  • "queue_SQL": "string",
  • "queue_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimQueueSchedule

Lists all ClaimQueueSchedule

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-queue-schedules
Request samples
Response samples
No sample

Get ClaimQueueSchedule

Gets ClaimQueueSchedule

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimQueueScheduleKey
required
integer <int32>

ClaimQueueSchedule Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-queue-schedules/{claimQueueScheduleKey}
Request samples
Response samples
No sample

Update ClaimQueueSchedule

Updates a specific ClaimQueueSchedule.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimQueueScheduleKey
required
integer <int32>

ClaimQueueSchedule Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimQueueSchedule_Key
required
integer <int32>
description
string or null <= 256 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
queue_Event_ID
integer or null <int32>
queue_SQL
string or null <= 4000 characters
queue_Type
string or null <= 32 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/claim-queue-schedules/{claimQueueScheduleKey}
Request samples
{
  • "claimQueueSchedule_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Event_ID": 0,
  • "queue_SQL": "string",
  • "queue_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ClaimQueueSchedule

Deletes an ClaimQueueSchedule

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimQueueScheduleKey
required
integer <int32>

ClaimQueueSchedule Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/claim-queue-schedules/{claimQueueScheduleKey}
Request samples

Create or Update Batch ClaimQueueSchedule

Create or Update multiple ClaimQueueSchedule 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
claimQueueSchedule_Key
required
integer <int32>
description
string or null <= 256 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
queue_Event_ID
integer or null <int32>
queue_SQL
string or null <= 4000 characters
queue_Type
string or null <= 32 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/claim-queue-schedules-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}