GET api/modeler/model?id={id}
Gets a single model based off of the ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ModelerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Description | string |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedBy | globally unique identifier |
None. |
|
| ModifiedDate | date |
None. |
|
| ModifiedBy | globally unique identifier |
None. |
|
| ModifiedByName | string |
None. |
|
| ModifiedByPictureID | string |
None. |
|
| Filter | string |
None. |
|
| ScenarioCount | integer |
None. |
|
| CostFields | Collection of string |
None. |
|
| BenefitsFields | Collection of string |
None. |
|
| SortField | string |
None. |
|
| SortDirection | SortByDirection |
None. |
|
| CostTypes | Collection of globally unique identifier |
None. |
|
| UserList | Collection of User |
None. |
|
| InheritedUserList | Collection of User |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| Views | Collection of ModelView |
None. |
|
| LastCostPlannerTargets | Collection of ScenarioCostTarget |
None. |
|
| CascadingLookupSelections | Collection of globally unique identifier |
None. |
|
| CascadingLookupField | globally unique identifier |
None. |
|
| CloneOperation | boolean |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Description": "sample string 2",
"CreatedDate": "2025-11-06T05:18:48.3172883+00:00",
"CreatedBy": "f8c8a404-2c51-4cfe-b3c9-46912c07515a",
"ModifiedDate": "2025-11-06T05:18:48.3172883+00:00",
"ModifiedBy": "8c24f8c3-b83b-487c-a06f-b7d1e97f641c",
"ModifiedByName": "sample string 7",
"ModifiedByPictureID": "sample string 8",
"Filter": "sample string 9",
"ScenarioCount": 10,
"CostFields": [
"sample string 1",
"sample string 2"
],
"BenefitsFields": [
"sample string 1",
"sample string 2"
],
"SortField": "sample string 11",
"SortDirection": 0,
"CostTypes": [
"2487e343-a5f3-461c-9428-07e34e17a1e0",
"e79052aa-f296-4294-8e33-94b77e1954eb"
],
"UserList": [
{
"UserId": "334688d6-bfb0-4ddb-9693-752542e8d0bf",
"Permission": 0,
"Inherited": true
},
{
"UserId": "334688d6-bfb0-4ddb-9693-752542e8d0bf",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "334688d6-bfb0-4ddb-9693-752542e8d0bf",
"Permission": 0,
"Inherited": true
},
{
"UserId": "334688d6-bfb0-4ddb-9693-752542e8d0bf",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "b3639e4a-b9bf-4517-be27-a66ba9307a35",
"Views": [
{
"Name": "sample string 1",
"Id": "707aefb3-3546-462b-b7a0-d2af77cc47dc",
"Filters": {},
"UserId": "2a022b3c-93c8-4e30-a3a6-76928f138875",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "6ec0ee3e-683d-48dd-8b25-1e4fb0cf88a8",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-11-06T05:18:48.3172883+00:00",
"EndDateRange": "2025-11-06T05:18:48.3172883+00:00",
"ZoomLevel": 3,
"Filters": "sample string 4",
"GroupBy": "sample string 5",
"FTEMode": 6,
"CostType": "sample string 7",
"DataSelection_Resources": "sample string 8",
"DataSelection_Plans": "sample string 9",
"DataSelection_Lines": "sample string 10",
"VisibleGridColumns": [
"sample string 1",
"sample string 2"
]
},
"costPlanSettings": {
"StartDateRange": "2025-11-06T05:18:48.3172883+00:00",
"EndDateRange": "2025-11-06T05:18:48.3172883+00:00",
"CostType": "sample string 3",
"AdditionalCostTypes": [
"sample string 1",
"sample string 2"
],
"ZoomLevel": 4,
"ExchangeCurrencyValue": "sample string 5"
},
"ChartView": true,
"chartType": 0,
"bubbleChartSettings": {
"xField": "5da020df-ee43-432c-814f-403485464672",
"yField": "7568abb4-9291-41c9-b765-6c090db9b6ae",
"sizeField": "635bc6f7-d2ad-41bf-8283-9a970d747b29"
}
},
{
"Name": "sample string 1",
"Id": "707aefb3-3546-462b-b7a0-d2af77cc47dc",
"Filters": {},
"UserId": "2a022b3c-93c8-4e30-a3a6-76928f138875",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "6ec0ee3e-683d-48dd-8b25-1e4fb0cf88a8",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-11-06T05:18:48.3172883+00:00",
"EndDateRange": "2025-11-06T05:18:48.3172883+00:00",
"ZoomLevel": 3,
"Filters": "sample string 4",
"GroupBy": "sample string 5",
"FTEMode": 6,
"CostType": "sample string 7",
"DataSelection_Resources": "sample string 8",
"DataSelection_Plans": "sample string 9",
"DataSelection_Lines": "sample string 10",
"VisibleGridColumns": [
"sample string 1",
"sample string 2"
]
},
"costPlanSettings": {
"StartDateRange": "2025-11-06T05:18:48.3172883+00:00",
"EndDateRange": "2025-11-06T05:18:48.3172883+00:00",
"CostType": "sample string 3",
"AdditionalCostTypes": [
"sample string 1",
"sample string 2"
],
"ZoomLevel": 4,
"ExchangeCurrencyValue": "sample string 5"
},
"ChartView": true,
"chartType": 0,
"bubbleChartSettings": {
"xField": "5da020df-ee43-432c-814f-403485464672",
"yField": "7568abb4-9291-41c9-b765-6c090db9b6ae",
"sizeField": "635bc6f7-d2ad-41bf-8283-9a970d747b29"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "9fec93fe-164b-442d-8fa4-a5b0d764ecf2",
"TargetData": {
"2025-11-06T05:18:48.3172883+00:00": 2.0
}
},
{
"CostTypeId": "9fec93fe-164b-442d-8fa4-a5b0d764ecf2",
"TargetData": {
"2025-11-06T05:18:48.3172883+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"06f1ab4a-b719-44bd-bb1f-914ad7035e71",
"c2d22f39-8f30-45c8-a897-4f7d246e79ba"
],
"CascadingLookupField": "1db091b1-40f3-40ff-b649-c7f779182e0b",
"CloneOperation": true,
"id": "38e670ac-ac36-435f-8ab5-0e42951daa04",
"ConfigId": "8e0e3967-d5ff-4599-b1ed-1e3f0943c543"
}