To get model details for Eclipse models, you would use the below endpoint:
GET https://baseurl/v1/modeling/models/<modelid>
| property | description | required | datatype |
| <modelid> | Model ID | Yes | Integer |
Below is an example for a model targeting two security sets.
Sample Request:
https://baseurl/v1/modeling/models/<modelid>Sample Request:
{
"id": 703,
"updateStatus": null,
"needsUpdate": false,
"name": "Test Create Model",
"description": null,
"nameSpace": "Default Team",
"statusId": 1,
"status": "Approved",
"currentStatusId": null,
"currentStatus": null,
"currentTags": null,
"currentName": null,
"currentNameSpace": null,
"currentDescription": null,
"tags": null,
"ownerUserId": 5426,
"ownerUser": "test.user",
"managementStyleId": null,
"managementStyle": null,
"isCommunityModel": 0,
"communityModelId": null,
"isSubstitutedForSleeve": 0,
"lastSyncDate": "2021-07-10T19:11:51.000Z",
"approvedByUserId": 5426,
"approvedByUser": "test.user",
"isDynamic": 0,
"isDeleted": 0,
"createdOn": "2021-07-10T19:11:51.000Z",
"editedOn": "2021-07-10T19:13:21.000Z",
"createdBy": "test.user",
"editedBy": "test.user",
"hasEditAccess": 1,
"macStatus": 1,
"havePendingModel": false,
"astroEnabled": 0,
"astroTemplateId": null,
"astroUsage": 3,
"syncToAstro": false,
"isSMA": 0,
"sleeveSuffix": null,
"currentSleeveSuffix": null,
"optionLevel": null,
"primeBrokerage": null,
"marginAgreement": null,
"orionConnectProductClass": null,
"currentOrionConnectProductClass": null,
"orionConnectRiskCategory": null,
"currentOrionConnectRiskCategory": null,
"currentManagementStyleId": null,
"modelDetail": {
"modelDetailId": 18367,
"id": 12931,
"name": "Test Create Model",
"nameSpace": "test.user",
"children": [
{
"id": 624,
"name": "*Model Edits Test 3A",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 33,
"meId": 624,
"color": null
},
"hasSubstitute": false,
"leftValue": 2,
"rightValue": 3,
"modelDetailId": 18366,
"targetPercent": 50,
"lowerModelTolerancePercent": 0,
"upperModelTolerancePercent": 0,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 0,
"isSubstituted": null,
"substitutedOf": null,
"children": []
},
{
"id": 397,
"name": "1 - Large Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 193,
"meId": 397,
"color": null
},
"hasSubstitute": false,
"leftValue": 4,
"rightValue": 5,
"modelDetailId": 18371,
"targetPercent": 50,
"lowerModelTolerancePercent": 0,
"upperModelTolerancePercent": 0,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 0,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"level": "0",
"leftValue": 1,
"rightValue": 6,
"childSubstituted": null
},
"portfolioCount": 1,
"sleeveCount": 0,
"modelAUM": 38283.85,
"canPortfolioAssignToModel": true
}Below is an example for a multi-level model, consisting of a Category, Class and Security Set levels.
Sample Request:
https://baseurl/v1/modeling/models/<modelid>Sample Response:
{
"id": 167,
"updateStatus": null,
"needsUpdate": false,
"name": "Banana Pudding",
"description": "Small Cap",
"nameSpace": "Default Team",
"statusId": 1,
"status": "Approved",
"currentStatusId": null,
"currentStatus": null,
"currentTags": null,
"currentName": null,
"currentNameSpace": null,
"currentDescription": null,
"tags": "Matt",
"ownerUserId": 126620,
"ownerUser": "Clayton.Sharp",
"managementStyleId": 5,
"managementStyle": "Growth",
"isCommunityModel": 0,
"communityModelId": null,
"isSubstitutedForSleeve": 0,
"lastSyncDate": "2019-05-02T20:09:25.000Z",
"approvedByUserId": 126620,
"approvedByUser": "Clayton.Sharp",
"isDynamic": 0,
"isDeleted": 0,
"createdOn": "2019-05-02T20:09:25.000Z",
"editedOn": "2021-05-07T20:55:35.000Z",
"createdBy": "Kevin.Stillman",
"editedBy": "Clayton.Sharp",
"hasEditAccess": 1,
"macStatus": 1,
"havePendingModel": false,
"astroEnabled": 0,
"astroTemplateId": null,
"astroUsage": 3,
"syncToAstro": false,
"isSMA": 0,
"sleeveSuffix": null,
"currentSleeveSuffix": null,
"optionLevel": null,
"primeBrokerage": null,
"marginAgreement": null,
"orionConnectProductClass": null,
"currentOrionConnectProductClass": null,
"orionConnectRiskCategory": null,
"currentOrionConnectRiskCategory": null,
"currentManagementStyleId": null,
"modelDetail": {
"modelDetailId": 17859,
"id": 398,
"name": "Banana Pudding",
"nameSpace": null,
"children": [
{
"id": 355,
"name": "1 - Equity ETF",
"modelType": "Category",
"modelTypeId": 1,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 2,
"rightValue": 19,
"modelDetailId": 10194,
"targetPercent": 25,
"lowerModelTolerancePercent": 2.5,
"upperModelTolerancePercent": 2.5,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 356,
"name": "1 - Large Cap ETF",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 3,
"rightValue": 6,
"modelDetailId": 10201,
"targetPercent": 25,
"lowerModelTolerancePercent": 2.5,
"upperModelTolerancePercent": 2.5,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 397,
"name": "1 - Large Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 193,
"meId": 397,
"color": null
},
"hasSubstitute": false,
"leftValue": 4,
"rightValue": 5,
"modelDetailId": 10279,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
},
{
"id": 357,
"name": "1 - Mid Cap ETF",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 7,
"rightValue": 10,
"modelDetailId": 10209,
"targetPercent": 25,
"lowerModelTolerancePercent": 2.5,
"upperModelTolerancePercent": 2.5,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 363,
"name": "1 - Mid Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 194,
"meId": 363,
"color": null
},
"hasSubstitute": false,
"leftValue": 8,
"rightValue": 9,
"modelDetailId": 10237,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
},
{
"id": 358,
"name": "1 - Small Cap ETF",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 11,
"rightValue": 14,
"modelDetailId": 10216,
"targetPercent": 25,
"lowerModelTolerancePercent": 2.5,
"upperModelTolerancePercent": 2.5,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 386,
"name": "1 - Small Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 195,
"meId": 386,
"color": null
},
"hasSubstitute": false,
"leftValue": 12,
"rightValue": 13,
"modelDetailId": 10268,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
},
{
"id": 360,
"name": "2 - Mid Cap ETF",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 15,
"rightValue": 18,
"modelDetailId": 10226,
"targetPercent": 25,
"lowerModelTolerancePercent": 2.5,
"upperModelTolerancePercent": 2.5,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 368,
"name": "2 - Mid Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 197,
"meId": 368,
"color": null
},
"hasSubstitute": false,
"leftValue": 16,
"rightValue": 17,
"modelDetailId": 10246,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
}
],
"childSubstituted": null
},
{
"id": 366,
"name": "2 - Equity ETF",
"modelType": "Category",
"modelTypeId": 1,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 20,
"rightValue": 41,
"modelDetailId": 10244,
"targetPercent": 75,
"lowerModelTolerancePercent": 7.5,
"upperModelTolerancePercent": 7.5,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 359,
"name": "2 - Large Cap ETF_2",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 21,
"rightValue": 28,
"modelDetailId": 13509,
"targetPercent": 60,
"lowerModelTolerancePercent": 6,
"upperModelTolerancePercent": 6,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 624,
"name": "*Model Edits Test 3A",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 33,
"meId": 624,
"color": null
},
"hasSubstitute": false,
"leftValue": 22,
"rightValue": 23,
"modelDetailId": 13510,
"targetPercent": 60,
"lowerModelTolerancePercent": 6,
"upperModelTolerancePercent": 6,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
},
{
"id": 676,
"name": "Large Cap 1234",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 344,
"meId": 676,
"color": null
},
"hasSubstitute": false,
"leftValue": 24,
"rightValue": 25,
"modelDetailId": 13511,
"targetPercent": 20,
"lowerModelTolerancePercent": 2,
"upperModelTolerancePercent": 2,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
},
{
"id": 1652,
"name": "Rohirrim",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 335,
"meId": 1652,
"color": null
},
"hasSubstitute": false,
"leftValue": 26,
"rightValue": 27,
"modelDetailId": 13512,
"targetPercent": 20,
"lowerModelTolerancePercent": 2,
"upperModelTolerancePercent": 2,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
},
{
"id": 360,
"name": "2 - Mid Cap ETF",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 29,
"rightValue": 32,
"modelDetailId": 13513,
"targetPercent": 20,
"lowerModelTolerancePercent": 2,
"upperModelTolerancePercent": 2,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 368,
"name": "2 - Mid Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 197,
"meId": 368,
"color": null
},
"hasSubstitute": false,
"leftValue": 30,
"rightValue": 31,
"modelDetailId": 13514,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
},
{
"id": 361,
"name": "2 - Small Cap ETF",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 33,
"rightValue": 36,
"modelDetailId": 10235,
"targetPercent": 10,
"lowerModelTolerancePercent": 1,
"upperModelTolerancePercent": 1,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 369,
"name": "2 - Small Cap ETF",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 198,
"meId": 369,
"color": null
},
"hasSubstitute": false,
"leftValue": 34,
"rightValue": 35,
"modelDetailId": 10255,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
},
{
"id": 390,
"name": "Risky",
"modelType": "Class",
"modelTypeId": 2,
"nameSpace": "Default Team",
"securityAsset": null,
"hasSubstitute": false,
"leftValue": 37,
"rightValue": 40,
"modelDetailId": 13515,
"targetPercent": 10,
"lowerModelTolerancePercent": 1,
"upperModelTolerancePercent": 1,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": [
{
"id": 393,
"name": "Blue Chip",
"modelType": "Security Set",
"modelTypeId": 4,
"nameSpace": null,
"securityAsset": {
"id": 204,
"meId": 393,
"color": null
},
"hasSubstitute": false,
"leftValue": 38,
"rightValue": 39,
"modelDetailId": 13516,
"targetPercent": 100,
"lowerModelTolerancePercent": 10,
"upperModelTolerancePercent": 10,
"lowerModelToleranceAmount": null,
"upperModelToleranceAmount": null,
"rank": 0,
"toleranceType": null,
"toleranceTypeValue": 10,
"isSubstituted": null,
"substitutedOf": null,
"children": []
}
],
"childSubstituted": null
}
],
"childSubstituted": null
}
],
"level": "0",
"leftValue": 1,
"rightValue": 42,
"childSubstituted": null
},
"portfolioCount": 6,
"sleeveCount": 2,
"modelAUM": 844050.62,
"canPortfolioAssignToModel": true
}