Care Case Actions

Create CareCaseAction

Creates a new CareCaseAction

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseAction_Key
required
integer <int32>
action_Definition
string or null <= 512 characters
action_Status
string or null <= 32 characters
action_Type
string or null <= 32 characters
caseDetail_Key
integer or null <int32>
case_Key
required
integer <int32>
eMail_Body
string or null <= 4000 characters
eMail_Recipient
string or null <= 512 characters
eMail_Subject
string or null <= 256 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
event_ID
integer or null <int32>
reportQueue_Key
integer or null <int32>
reportSeries_Key
integer or null <int32>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/cases/{caseKey}/actions
Request samples
{
  • "careCaseAction_Key": 0,
  • "action_Definition": "string",
  • "action_Status": "string",
  • "action_Type": "string",
  • "caseDetail_Key": 0,
  • "case_Key": 0,
  • "eMail_Body": "string",
  • "eMail_Recipient": "string",
  • "eMail_Subject": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "reportQueue_Key": 0,
  • "reportSeries_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseAction

Lists all CareCaseAction for the given caseKey

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

Case Key

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/cases/{caseKey}/actions
Request samples 
Response samples 
No sample
Get CareCaseAction
Gets CareCaseAction


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseActionKey
required
integer <int32> 
CareCaseAction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/actions/{careCaseActionKey}
Request samples 
Response samples 
No sample
Update CareCaseAction
Updates a specific CareCaseAction.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseActionKey
required
integer <int32> 
CareCaseAction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseAction_Key
required
integer <int32> 
 
action_Definition
string or null  <= 512 characters 
 
action_Status
string or null  <= 32 characters 
 
action_Type
string or null  <= 32 characters 
 
caseDetail_Key
integer or null <int32> 
 
case_Key
required
integer <int32> 
 
eMail_Body
string or null  <= 4000 characters 
 
eMail_Recipient
string or null  <= 512 characters 
 
eMail_Subject
string or null  <= 256 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
event_ID
integer or null <int32> 
 
reportQueue_Key
integer or null <int32> 
 
reportSeries_Key
integer or null <int32> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/cases/{caseKey}/actions/{careCaseActionKey}
Request samples 
{
  • "careCaseAction_Key": 0,
  • "action_Definition": "string",
  • "action_Status": "string",
  • "action_Type": "string",
  • "caseDetail_Key": 0,
  • "case_Key": 0,
  • "eMail_Body": "string",
  • "eMail_Recipient": "string",
  • "eMail_Subject": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "reportQueue_Key": 0,
  • "reportSeries_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseAction
Deletes an CareCaseAction


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseActionKey
required
integer <int32> 
CareCaseAction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/actions/{careCaseActionKey}
Request samples 
Create or Update Batch CareCaseAction
Create or Update multiple CareCaseAction at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
careCaseAction_Key
required
integer <int32> 
 
action_Definition
string or null  <= 512 characters 
 
action_Status
string or null  <= 32 characters 
 
action_Type
string or null  <= 32 characters 
 
caseDetail_Key
integer or null <int32> 
 
case_Key
required
integer <int32> 
 
eMail_Body
string or null  <= 4000 characters 
 
eMail_Recipient
string or null  <= 512 characters 
 
eMail_Subject
string or null  <= 256 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
event_ID
integer or null <int32> 
 
reportQueue_Key
integer or null <int32> 
 
reportSeries_Key
integer or null <int32> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/cases/{caseKey}/actions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}