Plan Lineages

Create PlanLineage

Creates a new PlanLineage

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

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

Unique identifier for each Plan Lineage configuration. This is used to group a set of ranked plans for Plan Lineage logic in VBASoftware and VBAGateway.

description
required
string [ 1 .. 256 ] characters

The description of this Plan Lineage configuration.

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.

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
Request samples
{
  • "plan_Lineage_ID": "string",
  • "description": "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 PlanLineage

Lists all PlanLineage

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/lineages
Request samples 
Response samples 
No sample
Create or Update Batch PlanLineage
Create or Update multiple PlanLineage 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_Lineage_ID
required
string  [ 1 .. 32 ] characters 
Unique identifier for each Plan Lineage configuration. This is used to group a set of ranked plans for Plan Lineage logic in VBASoftware and VBAGateway.


 
description
required
string  [ 1 .. 256 ] characters 
The description of this Plan Lineage configuration.


 
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.


 
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
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get PlanLineage
Gets PlanLineage


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}
Request samples 
Response samples 
No sample
Update PlanLineage
Updates a specific PlanLineage.


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
plan_Lineage_ID
required
string  [ 1 .. 32 ] characters 
Unique identifier for each Plan Lineage configuration. This is used to group a set of ranked plans for Plan Lineage logic in VBASoftware and VBAGateway.


 
description
required
string  [ 1 .. 256 ] characters 
The description of this Plan Lineage configuration.


 
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.


 
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}
Request samples 
{
  • "plan_Lineage_ID": "string",
  • "description": "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 PlanLineage
Deletes an PlanLineage


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 
204
Success


401
Unauthorized


delete/plans/{planID}/lineages/{planLineageID}
Request samples