Plan Lineage Details

Create PlanLineageDetail

Creates a new PlanLineageDetail

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

planLineageID
required
string

Plan Lineage ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planLineageDetail_Key
required
integer <int32>

Unique identifier for each Plan Lineage detail record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

plan_ID
required
string [ 1 .. 20 ] characters

Referneces the Plans.Plan_ID table and is the Plan ranked inside this plan lineage.

plan_Lineage_ID
required
string [ 1 .. 32 ] characters

References the PlanLineage.Plan_Lineage_ID value in the parent table.

plan_Rank
required
integer <int32>

A required rank value that ranks each plan within this Plan_Lineage_ID. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date when 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/plans/{planID}/lineages/{planLineageID}/details
Request samples
{
  • "planLineageDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "plan_Lineage_ID": "string",
  • "plan_Rank": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanLineageDetail

Lists all PlanLineageDetail for the given planID and planLineageID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

planLineageID
required
string

Plan Lineage ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/lineages/{planLineageID}/details
Request samples 
Response samples 
No sample
Get PlanLineageDetail
Gets PlanLineageDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planLineageID
required
string
Plan Lineage ID


 
planLineageDetailKey
required
integer <int32> 
PlanLineageDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/lineages/{planLineageID}/details/{planLineageDetailKey}
Request samples 
Response samples 
No sample
Update PlanLineageDetail
Updates a specific PlanLineageDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planLineageID
required
string
Plan Lineage ID


 
planLineageDetailKey
required
integer <int32> 
PlanLineageDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planLineageDetail_Key
required
integer <int32> 
Unique identifier for each Plan Lineage detail record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Referneces the Plans.Plan_ID table and is the Plan ranked inside this plan lineage.


 
plan_Lineage_ID
required
string  [ 1 .. 32 ] characters 
References the PlanLineage.Plan_Lineage_ID value in the parent table.


 
plan_Rank
required
integer <int32> 
A required rank value that ranks each plan within this Plan_Lineage_ID. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date when 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/plans/{planID}/lineages/{planLineageID}/details/{planLineageDetailKey}
Request samples 
{
  • "planLineageDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "plan_Lineage_ID": "string",
  • "plan_Rank": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanLineageDetail
Deletes an PlanLineageDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planLineageID
required
string
Plan Lineage ID


 
planLineageDetailKey
required
integer <int32> 
PlanLineageDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/lineages/{planLineageID}/details/{planLineageDetailKey}
Request samples 
Create or Update Batch PlanLineageDetail
Create or Update multiple PlanLineageDetail 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
planID
required
string
Plan ID


 
planLineageID
required
string
Plan Lineage ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
planLineageDetail_Key
required
integer <int32> 
Unique identifier for each Plan Lineage detail record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Referneces the Plans.Plan_ID table and is the Plan ranked inside this plan lineage.


 
plan_Lineage_ID
required
string  [ 1 .. 32 ] characters 
References the PlanLineage.Plan_Lineage_ID value in the parent table.


 
plan_Rank
required
integer <int32> 
A required rank value that ranks each plan within this Plan_Lineage_ID. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date when 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/plans/{planID}/lineages/{planLineageID}/details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}